get-annotation

dci get-annotation <id>

Returns an annotation by the specified Id.

• id — Annotation ID as shown by dci list-annotations (select the id column with -C id,content).

Examples

# Show one annotation.
dci get-annotation <annotation-id>

# The full record as JSON, including label ids and report ids.
dci get-annotation <annotation-id> --output json

# Only the fields you need.
dci get-annotation <annotation-id> --fields content,timestamp,reports --output json

Output

OK - Annotation returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
id	string	The unique identifier of the annotation.
content	string	The content of the annotation.
timestamp	string (date-time)	The date associated with the annotation.
reports	array of string	List of report IDs associated with the annotation.
labels	array of object	List of labels associated with the annotation.
labels[].id	string	The unique identifier of the label.
labels[].name	string	The name of the label.
createTime	string (date-time)	The creation time of the annotation.
updateTime	string (date-time)	The time when the annotation was last updated.

Raw JSON schema

{
  "required": [
    "id",
    "content",
    "timestamp"
  ],
  "type": "object",
  "description": "Summary information about an annotation.",
  "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."
    },
    "labels": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "name"
        ],
        "type": "object",
        "description": "Metadata for a label.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the label."
          },
          "name": {
            "type": "string",
            "description": "The name of the label."
          }
        }
      },
      "description": "List of labels associated with the annotation."
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The creation time of the annotation."
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the annotation was last updated."
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping

HTTP status	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.

Related

• list-annotations — List annotations
• create-annotation — Create an annotation
• update-annotation — Update an annotation
• delete-annotation — Delete an annotation
• API reference: GET /analytics/v1/annotations/{id}

Aliases: getannotation