Tags

A tag can be used to categorize translation-tasks for better searchability. For visualisation purposes a tag can be annotated with a specific color. Tags are created on demand by tagging a translation-task. This endpoint is only used to get tag information or to patch the color of a tag.

Endpoints

Method URI
GET /rest/api/tags/
GET /rest/api/tags/{tag_id}
PATCH /rest/api/tags/{tag_id}

Default Schema

{
  "id": "my-unique-tag-name",
  "color": "#333"
}

Properties

Property Writeable Value
id readonly The id or unique name respectively of the tag.
color The color of the tag as hex code.

Description of Endpoints

GET  /rest/api/tags/

Returns all tags of the users organization.

Example Request:

GET /rest/api/tags/ HTTP/1.1

Example Response:

[
  {
    "id": "my-tag",
    "color": "#111"
  },
  {
    "id": "i-am-blue",
    "color": "#00c"
  }
]

GET  /rest/api/tags/{tag_id}

Gets a tag by it's id aka name.

Example Request:

GET /rest/api/tags/my-tag HTTP/1.1

Example Response:

{
  "id": "my-tag",
  "color": "#111"
}

PATCH  /rest/api/tags/{tag_id}

Updates one tag.

Example request:

PATCH /rest/api/tags/my-tag HTTP/1.1

Accept: application/json, text/javascript
Content-Type: application/json

{
  "color": "#222"
}

Example response:

{
  "id": "my-tag",
  "color": "#222"
}