Changes a term. Send only what changes.
HTTP
PATCH /glossary/{termId}Access: Session token only. API keys get 403 with insufficient_scope.
Path parameters #
| Parameter | Description |
|---|---|
termId | The id of the term. |
Request body #
JSON.
| Field | Type | Required | Description |
|---|---|---|---|
pos | string | no | At most 40 characters. |
definition | string | no | At most 2000 characters. |
example | string | no | At most 1000 characters. |
forbidden | list of string | no | Replaces the list. |
related | list of string | no | Replaces the list. |
status | string | no | approved, review or notranslate. Curators only. |
projectIds | list of string | no | Replaces the projects the term applies to. |
JSON
{ "status": "approved" }Response 200 #
The term after the change.
JSON
{
"id": "0197a3cc-a3b9-7aaa-9d00-5b9ebc6a832a",
"name": "checkout",
"pos": "Noun",
"status": "approved",
"definition": "The step where a customer pays.",
"example": "Go to checkout.",
"forbidden": ["cash register"],
"related": ["cart"],
"translations": [
{ "code": "de-de", "value": "Kasse", "state": "approved", "annotation": null, "conflict": null }
],
"projectIds": ["0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64"],
"addedBy": "Ada Lovelace",
"addedMinutes": 4320,
"editedBy": "Ada Lovelace",
"editedMinutes": 60
}Response fields #
| Field | Type | Description |
|---|---|---|
id | string | The id of the term. |
name | string | The term. |
pos | string | Part of speech, free text. Default Noun. |
status | string | approved, review (default for a new term) or notranslate. |
definition | string | The definition. |
example | string | An example. |
forbidden | list of string | Words that must not be used. |
related | list of string | Related terms. |
translations | list of object | One per language: code, value, state (approved, pending, missing, conflict or unchanged), annotation and conflict. |
projectIds | list of string | Projects the term applies to. |
addedBy | string or null | Who added it. |
addedMinutes | integer or null | Minutes since it was added. |
editedBy | string or null | Who last changed it. |
editedMinutes | integer or null | Minutes since it changed. |
Errors #
| Status | error | When |
|---|---|---|
| 401 | unauthenticated | The token is missing or not valid. |
| 404 | not_found | The term does not exist in your organisation, or termId is not a UUID. |
| 403 | forbidden | status is sent and you are not a curator. Curators: organisation owners and admins, and anyone who is a reviewer or manager of a project. |
| 422 | invalid_request | A text is too long, or status is not allowed. |
| 429 | rate_limited | Too many requests, see Rate limiting. |
See Errors for the error format.