GetAnnotation
Retrieves an annotation
GET
/
api/v1/annotations/{annotationId}Path Parameters
annotationIdRequiredstring
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",
"pending": true,
"assignedToUser": {
"userId": "string",
"userName": "string",
"organizations": [
{
"organizationId": "string",
"organizationName": "string"
}
]
},
"deletedDate": "2019-08-24T14:15:22Z",
"linkedChannels": [
{
"channel": {
"channelId": "string"
},
"bitFieldElement": {
"channelId": "string",
"bitFieldName": "string"
}
}
],
"assetIds": [
"string"
],
"metadata": [
{
"key": {
"name": "string",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2019-08-24T14:15:22Z"
},
"stringValue": "string",
"numberValue": 0.1,
"booleanValue": true,
"archivedDate": "2019-08-24T14:15:22Z"
}
]
}
}