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:

Default Schema

{
  "id": "my-unique-tag-name"
  "color": "#333"
}
id [readonly]:The id or unique name respectively of the tag.
color:The color of the tag as hex code.

Endpoints

GET /rest/api/tags/

Returns all tags of the users organization.

Example Request:

GET /rest/api/tags/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example Response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

[
  {
    "id": "my-tag",
    "color": "#111"
  },
  {
    "id": "i-am-blue",
    "color": "#00c"
  }
]
GET /rest/api/tags/(id)

Gets a tag by it’s id aka name.

Example Request:

GET /rest/api/tags/my-tag HTTP/1.1
Host: example.com

Example Response:

HTTP/1.1 200 GET
Vary: Accept
Content-Type: text/javascript

{
  "id": "my-tag",
  "color": "#111"
}
PATCH /rest/api/tags/(id)

Updates one tag.

Example request:

PATCH /rest/api/tags/my-tag HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Content-Type: application/json

{
   "color": "#222",
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

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