Annotations | Heeler User Guide

Get Resource Annotations By Id

get

Authorizations

Path parameters

resource_idstringRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/annotations/{resource_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "heeler_id": "text",
      "key": "text",
      "value": "text",
      "source": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Create Resource Annotations

post

Authorizations

Path parameters

resource_idstringRequired

Body

keystringRequired

valuestringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/annotations/{resource_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

[
  {
    "key": "text",
    "value": "text"
  }
]

{
  "ok": true,
  "message": "text"
}

Delete Resource Annotation

delete

Authorizations

Path parameters

resource_idstringRequired

Query parameters

keystringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

DELETE /api/annotations/{resource_id}?key=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}