Filter annotations

Lists the annotations the caller has access to, based on a filter.

The caller must have read-access on the annotated resources listed in the filter, otherwise the call will fail.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

A request specifying the annotation listing behavior

cursor
string or null [ 1 .. 255 ] characters

A cursor pointing to another page of results

limit
integer [ 1 .. 1000 ]
Default: 25
required
object (AnnotationsV2FilterSchema)

A filter to apply on annotations

Responses
200

Successful retrieval

400

The response for a failed request.

post/annotations/list
Request samples
application/json
{
  • "cursor": "MzE1NjAwMDcxNzQ0ODI5",
  • "limit": 25,
  • "filter": {
    • "annotatedResourceType": "file",
    • "annotatedResourceIds": [
      ],
    • "status": "approved",
    • "data": {
      }
    }
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": null
}
➔ Next to Get an annotation