get_annotations_by_owner
Get all annotations (comments) for an entity by its owner ID.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ownerId | string | Yes | The entity ID to get annotations for (e.g. an item ID). |
Returns
A list ofAnnotationDto objects ordered by creation date ascending, each containing:
annotationId— unique annotation identifierownerId— the entity being annotatedannotatorId— the user who created the annotationcontentType— annotation content type (e.g. Text)content— the annotation bodycreated— creation timestamp
get_annotation
Get a single annotation by its ID.| Property | |
|---|---|
| Read-only | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | The annotation ID. |
Returns
AnAnnotationDto with annotation details.
create_annotation
Create a new annotation (comment) on an entity.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ownerId | string | Yes | The entity being annotated (e.g. item ID). |
annotatorId | string | Yes | The user making the annotation. Use get_user_list. |
content | string | Yes | The annotation body text. |
contentType | string | No | Content type. Defaults to the first supported type (Text). |
Returns
The createdAnnotationDto.
update_annotation
Update an annotation’s content.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | The annotation ID. Use get_annotations_by_owner. |
content | string | No | New annotation body text. |
Returns
A confirmation message.delete_annotation
Delete an annotation by its ID.| Property | |
|---|---|
| Read-only | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | The annotation ID. Use get_annotations_by_owner. |