ListAnnotations

List all available annotations with their usage counts across entities.

GET /api/entities/annotations/v1

ListAnnotations

cURL

curl --request GET \
  --url https://developer.synq.io/api/entities/annotations/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "annotationCounts": [
    {
      "name": "<string>",
      "value": "<string>",
      "count": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

ListAnnotationsRequest is the request message for the ListAnnotations method.

Response

200 - application/json

Success

ListAnnotationsResponse is the response message for the ListAnnotations method.

annotationCounts · AnnotationCount · object[]

The annotation counts grouped by name and value.

Show child attributes