Skip to main content
POST
/
api
/
v1
/
annotations
/
{annotationId}
/
logs
CreateAnnotationLog
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/annotations/{annotationId}/logs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "ANNOTATION_LOG_KIND_UNSPECIFIED",
  "assigned": {
    "assignedToUserId": "<string>",
    "assignedToUserEmail": "<string>"
  },
  "stateUpdate": {
    "state": "ANNOTATION_LOG_STATE_UNSPECIFIED"
  },
  "comment": {
    "body": [
      {
        "type": "ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_UNSPECIFIED",
        "text": "<string>",
        "userMention": {
          "userId": "<string>",
          "userEmail": "<string>"
        }
      }
    ]
  }
}
'
{
  "annotationLog": {
    "annotationLogId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "annotationId": "<string>",
    "kind": "ANNOTATION_LOG_KIND_UNSPECIFIED",
    "createdByUserId": "<string>",
    "createdByUserName": "<string>",
    "assigned": {
      "assignedToUserId": "<string>",
      "assignedToUserEmail": "<string>"
    },
    "stateUpdate": {
      "state": "ANNOTATION_LOG_STATE_UNSPECIFIED"
    },
    "comment": {
      "body": [
        {
          "type": "ANNOTATION_COMMENT_BODY_ELEMENT_TYPE_UNSPECIFIED",
          "text": "<string>",
          "userMention": {
            "userId": "<string>",
            "userEmail": "<string>"
          }
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
annotationId
string
required

The ID of the parent annotation associated to associate with the new annotation log.

Body

application/json

The request for a call to AnnotationLogService_CreateAnnotationLog to create an annotation log.

​
kind
enum<string>
default:ANNOTATION_LOG_KIND_UNSPECIFIED
required
Available options:
ANNOTATION_LOG_KIND_UNSPECIFIED,
ANNOTATION_LOG_KIND_COMMENT,
ANNOTATION_LOG_KIND_STATE_UPDATE,
ANNOTATION_LOG_KIND_ASSIGNED
​
assigned
object
​
stateUpdate
object
​
comment
object

Response

A successful response.

The response of a call to AnnotationLogService_CreateAnnotationLog.

​
annotationLog
object