API DocsRESTAnnotation service

GetAnnotation

Retrieves an annotation

GET
/api/v1/annotations/{annotationId}

Path Parameters

annotationId
Required
string

curl -X GET "<API_URL>/api/v1/annotations/string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "annotation": {
    "annotationId": "string",
    "name": "string",
    "description": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "runId": "string",
    "state": "ANNOTATION_STATE_UNSPECIFIED",
    "organizationId": "string",
    "assignedToUserId": "string",
    "annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
    "tags": [
      "string"
    ],
    "legendConfig": "string",
    "createdByConditionId": "string",
    "createdByRuleConditionVersionId": "string",
    "reportRuleVersionId": "string"
  }
}

Previous

DeleteAnnotation DELETE

Next

ListAnnotation GET