Tags API (1.1.0)

getTagCollection

Retrieve a list of tag items.

query Parameters
query
string
Default: "cql.allRecords=1"

A query expressed as a CQL string

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 1000

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "totalRecords": 2
}

postTag

Create a new tag.

Request Body schema: application/json

Tag object

id
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
label
required
string

The short label of this tag

description
string

The description of this tag

object (Metadata)

Metadata about creation and changes to records

Responses

Request samples

Content type
application/json
{
  • "label": "urgent",
  • "description": "This is urgent stuff"
}

Response samples

Content type
application/json
{
  • "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
  • "label": "important",
  • "description": "This is important stuff."
}

getTagById

Retrieve tag with given ID

path Parameters
id
required
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3

The UUID of a tag

Responses

Response samples

Content type
application/json
{
  • "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
  • "label": "important",
  • "description": "This is important stuff."
}

putTagById

Update tag with given ID

path Parameters
id
required
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3

The UUID of a tag

Request Body schema: application/json

Tag object

id
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
label
required
string

The short label of this tag

description
string

The description of this tag

object (Metadata)

Metadata about creation and changes to records

Responses

Request samples

Content type
application/json
{
  • "label": "urgent",
  • "description": "This is urgent stuff"
}

Response samples

Content type
text/plain
unable to perform action -- unauthorized

deleteTagById

Delete tag with given ID

path Parameters
id
required
string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3

The UUID of a tag

Responses

Response samples

Content type
text/plain
unable to perform action -- unauthorized