Skip to main content
POST
/
api
/
v1
/
annotations
CreateAnnotation
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/annotations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "assets": [
    "<string>"
  ],
  "linkedChannels": [
    {
      "channel": {
        "channelId": "<string>"
      },
      "bitFieldElement": {
        "channelId": "<string>",
        "bitFieldName": "<string>"
      }
    }
  ],
  "tags": [
    "<string>"
  ],
  "runId": "<string>",
  "assignToUserId": "<string>",
  "organizationId": "<string>",
  "state": "ANNOTATION_STATE_UNSPECIFIED",
  "annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
  "createdByConditionId": "<string>",
  "legendConfig": "<string>",
  "createdByRuleConditionVersionId": "<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"
    }
  ]
}'
{
  "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"
      }
    ]
  }
}

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_CreateAnnotation to create a new annotation. At least 1 asset, tag, or channel must be specified.

​
name
string
required

The name assigned to the new annotation.

​
startTime
string<date-time>
required

When the annotation starts.

​
endTime
string<date-time>
required

When the annotation ends.

​
description
string

A short description about the new annotation.

​
assets
string[]

The names of the assets to associate with this annotation.

​
linkedChannels
object[]

The channels to associate with this annotation.

​
tags
string[]

The names of the tags to associate with this annotation.

​
runId
string

The ID of the run that this annotation is associated with.

​
assignToUserId
string

The ID of the user that this annotation is assigned to.

​
organizationId
string

The organization associated with this annotation. An organization ID is only required if the user belongs to multiple organizations.

​
state
enum<string>
default:ANNOTATION_STATE_UNSPECIFIED
Available options:
ANNOTATION_STATE_UNSPECIFIED,
ANNOTATION_STATE_OPEN,
ANNOTATION_STATE_FLAGGED,
ANNOTATION_STATE_RESOLVED
​
annotationType
enum<string>
default:ANNOTATION_TYPE_UNSPECIFIED
Available options:
ANNOTATION_TYPE_UNSPECIFIED,
ANNOTATION_TYPE_DATA_REVIEW,
ANNOTATION_TYPE_PHASE
​
createdByConditionId
string

The ID of the rule condition that created this annotation.

​
legendConfig
string

A JSON string containing the axes configuration of the annotation's linked channels.

​
createdByRuleConditionVersionId
string

The ID of the rule condition version that created this annotation.

​
metadata
object[]

The metadata associated with this annotation.

Response

A successful response.

The result of a call to AnnotationService_CreateAnnotation.

​
annotation
object
required