Skip to main content
PATCH
/
api
/
v1
/
annotations
UpdateAnnotation
curl --request PATCH \
  --url https://your-sift-api-url.com/api/v1/annotations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
    "organizationId": "<string>",
    "annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
    "tags": [
      "<string>"
    ],
    "runId": "<string>",
    "state": "ANNOTATION_STATE_UNSPECIFIED",
    "assignedToUserId": "<string>",
    "legendConfig": "<string>",
    "createdByConditionId": "<string>",
    "createdByRuleConditionVersionId": "<string>",
    "reportRuleVersionId": "<string>",
    "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"
      }
    ]
  },
  "updateMask": "<string>"
}
'
{
  "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",
    "organizationId": "<string>",
    "annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
    "tags": [
      "<string>"
    ],
    "runId": "<string>",
    "state": "ANNOTATION_STATE_UNSPECIFIED",
    "assignedToUserId": "<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"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The request for a call to AnnotationService_UpdateAnnotation to update an annotation.

The request for a call to AnnotationService_UpdateAnnotation to update an annotation.

​
annotation
object
required
​
updateMask
string
required

The list of fields to be updated. The fields available to be updated are name, description, start_time, end_time, assigned_to_user_id, state, tags, legend_config, linked_channels, and metadata. Important Note: if tags is specified in the update mask and annotation.tags is an empty list then all associated tags on the annotation will be removed.

Response

A successful response.

The response of a call to AnnotationService_UpdateAnnotation.

​
annotation
object