Skip to main content
PUT
/
api
/
annotation
/
{id}
Updates an existing annotation by its identifier.
curl --request PUT \
  --url https://{install}/api/annotation/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "owner": 123,
  "ownerId": "<string>",
  "annotator": 123,
  "annotatorId": "<string>",
  "restrictedTo": [
    "<string>"
  ],
  "contentType": "<string>",
  "content": "<string>",
  "meta": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

​
id
string
required

The unique identifier of the annotation to update.

Body

The updated annotation data; Id and TenantId must match the existing record.

​
entity
null | string
​
owner
integer
​
ownerId
string
​
annotator
integer
​
annotatorId
string
​
restrictedTo
string[]
​
contentType
string
​
content
string
​
meta
object[]
​
tenantId
string
​
id
string
​
created
string<date-time>
​
createdBy
string
​
updated
string<date-time>
​
updatedBy
string
​
deleted
boolean

Response

The annotation was updated successfully.