> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.

# annotation_logs

> sift/annotation_logs/v1/annotation_logs.proto

<a name="sift_annotation_logs_v1_annotation_logs-proto" />

<a name="sift_annotation_logs_v1_annotation_logs-proto-services" />

## Services

*RPC methods exposed by this API.*

### AnnotationLogService

| Method              | Request                                                   | Response                                                    | Description                                         |
| :------------------ | :-------------------------------------------------------- | :---------------------------------------------------------- | :-------------------------------------------------- |
| CreateAnnotationLog | [CreateAnnotationLogRequest](#createannotationlogrequest) | [CreateAnnotationLogResponse](#createannotationlogresponse) | Creates an annotation log on an annotation.         |
| ListAnnotationLogs  | [ListAnnotationLogsRequest](#listannotationlogsrequest)   | [ListAnnotationLogsResponse](#listannotationlogsresponse)   | Retrieves annotation logs using an optional filter. |
| DeleteAnnotationLog | [DeleteAnnotationLogRequest](#deleteannotationlogrequest) | [DeleteAnnotationLogResponse](#deleteannotationlogresponse) | Deletes an annotation log.                          |

<a name="sift_annotation_logs_v1_annotation_logs-proto-messages" />

## Messages

*Data models used across requests/responses.*

### AnnotationCommentBodyElement

| Field         | Type                                                                  | Label | Description |
| :------------ | :-------------------------------------------------------------------- | :---- | :---------- |
| type          | [AnnotationCommentBodyElementType](#annotationcommentbodyelementtype) |       |             |
| text          | string                                                                |       |             |
| user\_mention | [AnnotationCommentUserMention](#annotationcommentusermention)         |       |             |

### AnnotationCommentUserMention

| Field       | Type   | Label | Description |
| :---------- | :----- | :---- | :---------- |
| user\_id    | string |       |             |
| user\_email | string |       |             |

### AnnotationLogAssignedProperties

| Field                     | Type   | Label | Description |
| :------------------------ | :----- | :---- | :---------- |
| assigned\_to\_user\_id    | string |       |             |
| assigned\_to\_user\_email | string |       |             |

### AnnotationLogCommentProperties

| Field | Type                                                          | Label    | Description |
| :---- | :------------------------------------------------------------ | :------- | :---------- |
| body  | [AnnotationCommentBodyElement](#annotationcommentbodyelement) | repeated |             |

### AnnotationLogSearchResult

| Field                           | Type                                                                      | Label | Description |
| :------------------------------ | :------------------------------------------------------------------------ | :---- | :---------- |
| annotation\_log\_id             | string                                                                    |       |             |
| created\_date                   | google.protobuf.Timestamp                                                 |       |             |
| modified\_date                  | google.protobuf.Timestamp                                                 |       |             |
| annotation\_id                  | string                                                                    |       |             |
| kind                            | [AnnotationLogKind](#annotationlogkind)                                   |       |             |
| created\_by\_user\_id           | string                                                                    |       |             |
| created\_by\_user\_name         | string                                                                    |       |             |
| oneof properties. assigned      | [AnnotationLogAssignedProperties](#annotationlogassignedproperties)       |       |             |
| oneof properties. state\_update | [AnnotationLogStateUpdateProperties](#annotationlogstateupdateproperties) |       |             |
| oneof properties. comment       | [AnnotationLogCommentProperties](#annotationlogcommentproperties)         |       |             |

### AnnotationLogStateUpdateProperties

| Field | Type                                      | Label | Description |
| :---- | :---------------------------------------- | :---- | :---------- |
| state | [AnnotationLogState](#annotationlogstate) |       |             |

### CreateAnnotationLogRequest

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

| Field                           | Type                                                                      | Label | Description                                                                          |
| :------------------------------ | :------------------------------------------------------------------------ | :---- | :----------------------------------------------------------------------------------- |
| annotation\_id                  | string                                                                    |       | The ID of the parent annotation associated to associate with the new annotation log. |
| kind                            | [AnnotationLogKind](#annotationlogkind)                                   |       | The kind of annotation log to create.                                                |
| oneof properties. assigned      | [AnnotationLogAssignedProperties](#annotationlogassignedproperties)       |       |                                                                                      |
| oneof properties. state\_update | [AnnotationLogStateUpdateProperties](#annotationlogstateupdateproperties) |       |                                                                                      |
| oneof properties. comment       | [AnnotationLogCommentProperties](#annotationlogcommentproperties)         |       |                                                                                      |

### CreateAnnotationLogResponse

The response of a call to `AnnotationLogService_CreateAnnotationLog`.

| Field           | Type                                                    | Label | Description |
| :-------------- | :------------------------------------------------------ | :---- | :---------- |
| annotation\_log | [AnnotationLogSearchResult](#annotationlogsearchresult) |       |             |

### DeleteAnnotationLogRequest

The request for a call to `AnnotationLogService_DeleteAnnotationLog` to delete an annotation log.

| Field               | Type   | Label | Description                                                                       |
| :------------------ | :----- | :---- | :-------------------------------------------------------------------------------- |
| annotation\_id      | string |       | The ID of the parent annotation associated with the annotation log to be deleted. |
| annotation\_log\_id | string |       | ID of the annotation log to be deleted.                                           |

### DeleteAnnotationLogResponse

The Response of a call to `AnnotationLogService_DeleteAnnotationLog`.

*This message has no fields.*

### ListAnnotationLogsRequest

The request for a call to `AnnotationLogService_ListAnnotationLogs` to retrieve annotation logs.

| Field          | Type   | Label | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| :------------- | :----- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| annotation\_id | string |       | The ID of the parent annotation associated with the annotation logs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| page\_size     | uint32 |       | 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.                                                                                                                                                                                                                                                                                                                                                                 |
| page\_token    | string |       | 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.                                                                                                                                                                                                                                                                                                                                                          |
| filter         | string |       | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `annotation_log_id`, `annotation_id`, `created_by_user_id`, `annotation_id`, `created_date`, `modified_date`, and `kind`. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/api/grpc/protocol-buffers/annotation_logs#annotationlogsearchresult). Optional. |

### ListAnnotationLogsResponse

The response of a call to `AnnotationLogService_ListAnnotationLogs`.

| Field             | Type                                                    | Label    | Description |
| :---------------- | :------------------------------------------------------ | :------- | :---------- |
| annotation\_logs  | [AnnotationLogSearchResult](#annotationlogsearchresult) | repeated |             |
| next\_page\_token | string                                                  |          |             |

<a name="sift_annotation_logs_v1_annotation_logs-proto-enums" />

## Enums

*Allowed constant values used in message fields.*

### AnnotationCommentBodyElementType

| Name                                                    | Number | Description |
| :------------------------------------------------------ | :----- | :---------- |
| ANNOTATION\_COMMENT\_BODY\_ELEMENT\_TYPE\_UNSPECIFIED   | 0      |             |
| ANNOTATION\_COMMENT\_BODY\_ELEMENT\_TYPE\_TEXT          | 1      |             |
| ANNOTATION\_COMMENT\_BODY\_ELEMENT\_TYPE\_USER\_MENTION | 2      |             |

### AnnotationLogKind

| Name                                 | Number | Description |
| :----------------------------------- | :----- | :---------- |
| ANNOTATION\_LOG\_KIND\_UNSPECIFIED   | 0      |             |
| ANNOTATION\_LOG\_KIND\_COMMENT       | 1      |             |
| ANNOTATION\_LOG\_KIND\_STATE\_UPDATE | 2      |             |
| ANNOTATION\_LOG\_KIND\_ASSIGNED      | 3      |             |

### AnnotationLogState

| Name                                | Number | Description |
| :---------------------------------- | :----- | :---------- |
| ANNOTATION\_LOG\_STATE\_UNSPECIFIED | 0      |             |
| ANNOTATION\_LOG\_STATE\_CREATED     | 1      |             |
| ANNOTATION\_LOG\_STATE\_OPEN        | 2      |             |
| ANNOTATION\_LOG\_STATE\_FLAGGED     | 3      |             |
| ANNOTATION\_LOG\_STATE\_RESOLVED    | 4      |             |