API DocsRESTAnnotation log service

ListAnnotationLogs

Retrieves annotation logs using an optional filter.

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

Path Parameters

annotationId
Required
string

The ID of the parent annotation associated with the annotation logs.

Query Parameters

pageSizeinteger

The maximum number of annotation logs to return. The service may return fewer than this value. If unspecified, at most 50 annotation logs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListAnnotationLogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAnnotationLogs must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are annotation_log_id, annotation_id, created_by_user_id, created_date, modified_date, and kind. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

curl -X GET "<API_URL>/api/v1/annotations/string/logs?pageSize=0&pageToken=string&filter=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "annotationLogs": [
    {
      "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"
            }
          }
        ]
      }
    }
  ],
  "nextPageToken": "string"
}

Previous

DeleteAnnotationLog DELETE

Next

BatchDeleteAnnotation POST