Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
A successful response.
The response of a call to AnnotationService_GetAnnotation.
curl --request GET \
--url https://your-sift-api-url.com/api/v1/annotations/{annotationId} \
--header 'Authorization: Bearer <token>'{
"annotation": {
"annotationId": "<string>",
"name": "<string>",
"description": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"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": "2023-11-07T05:31:56Z",
"linkedChannels": [
{
"channel": {
"channelId": "<string>"
},
"bitFieldElement": {
"channelId": "<string>",
"bitFieldName": "<string>"
}
}
],
"assetIds": [
"<string>"
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Retrieves an annotation
curl --request GET \
--url https://your-sift-api-url.com/api/v1/annotations/{annotationId} \
--header 'Authorization: Bearer <token>'{
"annotation": {
"annotationId": "<string>",
"name": "<string>",
"description": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"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": "2023-11-07T05:31:56Z",
"linkedChannels": [
{
"channel": {
"channelId": "<string>"
},
"bitFieldElement": {
"channelId": "<string>",
"bitFieldName": "<string>"
}
}
],
"assetIds": [
"<string>"
],
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
A successful response.
The response of a call to AnnotationService_GetAnnotation.
Show child attributes
Was this page helpful?