API DocsRESTAnnotation log service

CreateAnnotationLog

Creates an annotation log on an annotation.

POST
/api/v1/annotations/{annotationId}/logs

Request Body

application/jsonRequired

kind
Required
string

Default: "ANNOTATION_LOG_KIND_UNSPECIFIED"Value in: "ANNOTATION_LOG_KIND_UNSPECIFIED" | "ANNOTATION_LOG_KIND_COMMENT" | "ANNOTATION_LOG_KIND_STATE_UPDATE" | "ANNOTATION_LOG_KIND_ASSIGNED"

assignedobject

stateUpdateobject

commentobject

Path Parameters

annotationId
Required
string

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

curl -X POST "<API_URL>/api/v1/annotations/string/logs" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
          }
        }
      ]
    }
  }'

A successful response.

{
  "annotationLog": {
    "annotationLogId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "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"
          }
        }
      ]
    }
  }
}

Previous

Sift REST API

Next

DeleteAnnotationLog DELETE