Add a term form

Adds a form to the term, e.g. the translation into another language or an alternative in a language. A language has at most one preferred form: adding a second one answers 409. A language that inherits another language's form cannot have forms of its own. Returns the created form with a Location header. Requires workspace-level glossary management permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^te_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Unique identifier of the term.

Body Params

Request body to add a form to a term.

string | null

Language of the form. Required for a translatable term; must be omitted for an untranslatable one, whose forms have no language.

string
required
length between 1 and 4096

The form's text.

enum

How a term form should be used:

  • PREFERRED: the recommended form. A language of a term has at most one preferred form.
  • ADMITTED: an accepted alternative form.
  • NOT_RECOMMENDED: a discouraged or deprecated form.
inherited_by
array of strings | null

Languages without a form of their own that use this form, e.g. de-AT and de-CH for a de form. Only for the preferred form of a translatable term.

inherited_by
enum

Lexical type of a term form.

enum

Part of speech of the term form.

enum

Grammatical number of the term form.

enum

Grammatical gender of the term form.

enum

Strategy used to match the term against translatable text.

string | null

The regular expression a CUSTOM matching uses.

enum

How a term form is matched with regard to case:

  • SENSITIVE: only text of the same case matches.
  • PERMISSIVE: text of any case matches, and a case difference is flagged as a hint.
  • INSENSITIVE: text of any case matches.
Headers
string
length between 1 and 255

Optional unique key for best-effort POST retry protection. Redis reserves the key, the request runs with ordinary service transactions, then the successful response is cached separately for 24 hours by default. There is no request-wide transaction or atomic commit between the operation and its replay result. A matching cached response is replayed verbatim with Idempotent-Replayed: true. Redis loss/eviction or retention expiry can remove protection and allow re-execution. Uploads and chunked bodies are covered; multipart boundaries and JSON property order may differ. Retries still pass validation and current authorization; a later 403/404 does not undo the original operation. A changed payload returns 422 idempotency_key_mismatch. A recent active reservation returns 409 idempotency_key_in_use with Retry-After. A retry with an unresolved key, including an unfinished reservation older than 5 minutes, returns 409 idempotency_outcome_unknown without Retry-After. This timeout does not release the reservation or permit re-execution while it is retained. Inspect the affected resource before starting a new operation; do not blindly reuse an unresolved key after expiry. A 4xx rejection releases the reservation, allowing the same key to be retried after correcting the cause. A 5xx or interruption after execution starts leaves it unresolved. An unavailable reservation store returns 503 before execution; an oversized request returns 413. Cache-save failure or a response over the cache limit preserves the original success status, headers and body; only future retries become unresolved. When idempotency is explicitly disabled by server configuration, the header is ignored and requests execute normally without retry protection. Use a new unique key for each intended operation.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json