Skip to main content

list-annotations 

restish dci list-annotations [flags]

Returns a list of annotations that your account has access to. Annotations are listed in reverse chronological order by default.

Flags​

--max-results: (string default:"500")

--page-token: (string)

--filter: (string)

--sort-by: (string enum:"id","content","timestamp","timeCreated","timeModified")

--sort-order: (string enum:"asc","desc")

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "type": "object",
  "properties": {
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results"
    },
    "rowCount": {
      "type": "integer",
      "description": "Total number of annotations in the result set"
    },
    "annotations": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "content",
          "timestamp"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the annotation"
          },
          "content": {
            "type": "string",
            "description": "The content of the annotation"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "The date associated with the annotation"
          },
          "reports": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of report IDs associated with the annotation"
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time when the annotation was created"
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time when the annotation was last updated"
          }
        }
      }
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-annotations, listannotations