TAGS

Tags are a type of metadata available in the system, and are set on a per-Event basis.

A single Event can have many Tags.


Tag Object

{
    "id": "94492f8e-8c5a-41e2-bb55-d352c7a5c943",
    "name": "Example Tag"
}

Supported Actions

POST /tag/

Add a new Tag.

Request Body:

{
  "name": "Example Tag"
}

Response: 201 Created


PUT /tag/

Update a Tag by Id.

Request Body:

{
  "id": "94492f8e-8c5a-41e2-bb55-d352c7a5c943",
  "name": "Renamed Tag"
}

Response: 201 Created


PUT /tag/event/{id}

Update the Tags for an Event. This replaces any existing Tag data on the Event with the given Tags.

Request Body:

[
  {
    "id": "6574e49d-dece-4ca6-9ec9-9b9b3a43375a",
    "name": "New Tag"
  }
]

Note: any existing tags with the given name(s) will be set on the Event, not newly created. Therefore, id is optional.

Response: 200 OK


GET /tag/

Get all Tags.

Response: 200 OK and a JSON array containing multiple Tag objects.


GET /tag/{id}

Get a Tag by Id.

Response:

200 OK and JSON containing the Tag object.

or

204 No Content if no Tag is found.


GET /tag/exists/{text}

Check if a Tag exists with a given Name.

Response: 200 OK and JSON content: { "exists": false}


GET /tag/event/{id}

Get the Tags for a given Event Id.

Query Parameters:

Name Type Required Description
noCache bool No Whether or not to bypass cache. Defaults to False.

Response: 200 OK and a JSON array containing multiple Tag objects.


GET /tag/{id}/events/

Get Events which have the given Tag Id set.

Query Parameters:

Name Type Required Description
pageSize int No Number of results to fetch per Page.
pageNumber int No Number of the page to fetch.
order QueryOrder No The order to sort by, either ASC or DESC. Defaults to ASC.
noCache bool No Whether or not to bypass cache. Defaults to False.

Response: 200 OK and JSON containing an Event collection.


DEL /tag/{id}

Delete a Tag by Id.

Response: 410 Gone