Terms

GET/terms

List and search terms

Query-Parameter

searchstring

Text the term's value contains or is similar to. Case-insensitive.

locale_codestring

Only terms in this language. Repeat as locale_code[] for several. Includes the terms of the language's fallback language (see hide_fallback_locale) and terms marked as not to be translated (dnt).

hide_fallback_localeboolean

With locale_code, leave out the terms of the fallback language.

statestring

Only terms with this usage state. Repeat as state[] for several.

term_typestring | null

Only terms of this type.Erlaubte Werte: fullForm, abbreviation, acronym, short, variant, colloquial, combination

tagstring

Only terms whose term entry carries this tag. Repeat as tag[] for several; an entry must carry all of them.

topicstring · uuid

Only terms whose term entry belongs to this topic (identifier). Subtopics are not included.

term_entry_identifierstring

Only terms of the term entry with this ID of your own (term_entry.term_entry_identifier), not its identifier.

initial_characterstring

Only terms whose value begins with this text.

missing_locale_codestring

Only terms whose term entry has no term in this language yet — what still needs translating.

missing_term_entry_fieldsstring

Only terms whose term entry lacks these, comma-separated: topic, images, definition. A missing definition is looked for in missing_field_locale_code.

missing_field_locale_codestring

The language of the definition missing_term_entry_fields=definition looks for.

last_updated_afterstring · date

Only terms changed on or after this day, a change of the term entry included.

term_entry_statestring

With include_drafts, only terms of term entries in this state.Erlaubte Werte: published, draft, suggested, rejected

include_draftsboolean

Also return terms that are not published yet (term requests, imports, extractions, tasks).

term_entry_field_{identifier}string

Only terms whose term entry has this value in the custom field {identifier}, e.g. term_entry_field_f1e2d3c4=Fenster. Works for picklist, number and boolean fields. For date fields use term_entry_field_{identifier}_start and _end.

term_field_{identifier}string

Like term_entry_field_{identifier}, for the custom fields of terms.

sortingstring

Sort by last change (last_updated) or last comment (last_commented) instead of value.

fieldsstring

Adds to each term, comma-separated or as fields[]: locale_code, locale, preferred_term, term_entry, term_entry_identifier, publishing_info.

pageintegerStandard: 1

Page to return, from 1.

per_pageintegerStandard: 500

Terms per page, at most 500.

Antworten

• 200 OKOne page of terms.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.

Header der Antwort

x-pageinteger

The page returned.

x-per-pageinteger

Terms per page.

x-totalinteger

Terms on all pages.

x-total-pagesinteger

Number of pages.

POST/terms

Create a term

Benötigter Scope:edit_terms

Body-Parameter · JSON

valuestringPflicht

The term.

term_entry_idstring · uuid

The identifier of the term entry to add the term to. Without it, a new term entry is created.

subjectstring

Subject area of the new term entry.

tagsstring[]

Tags of the new term entry.

topicsstring[] · uuid

Identifiers of the topics of the new term entry.

term_entry_fieldsobject

Values of custom fields, keyed by their identifier (see GET /termbases/{identifier}).

locale_codestringPflicht

Language of the term.

statestring

preferred, admitted, deprecated, not_recommended or the identifier of a custom state of the termbase.

term_typestring | null

fullForm full form, abbreviation abbreviation, acronym acronym, short short form, variant variant, colloquial colloquial term, combination term combination.

part_of_speechstring | null

Erlaubte Werte: noun, proper_noun, verb, adj, adv

grammatical_genderstring | null

Erlaubte Werte: masculine, feminine, neuter, other

grammatical_numberstring | null

The plural category (Unicode CLDR) the term is in, e.g. one singular, other plural in German and English.Erlaubte Werte: zero, one, two, few, many, other

usagestring

How to use the term — or why not to.

sourcestring

Where the term comes from, as free text.

contextstring

A sentence the term was found in.

ignore_caseboolean

Find the term regardless of upper and lower case in term checks.

value_formattingobject[]

Subscript and superscript in the value, as ranges over it: start and end (exclusive) count UTF-16 code units, so CO2 with a subscript 2 is [{"start": 2, "end": 3, "type": "sub"}].

3 Felder

startintegerPflicht

endintegerPflicht

typestringPflicht

Erlaubte Werte: sub, sup

fieldsobject

Values of custom fields, keyed by their identifier (see GET /termbases/{identifier}).

Antworten

• 200 OKThe new term.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
• 404 Not FoundNot found in the token's termbase.
• 422 Unprocessable EntityA parameter has an invalid value, e.g. a required custom field is empty or value is blank.

GET/terms/:identifier

Get a term

Pfad-Parameter

identifierstring · uuidPflicht

Identifier of the term.

Query-Parameter

translation_locale_codestring

Language in which names of languages and titles of topics are returned, e.g. en.

fieldsstring

publishing_info adds published, has_unpublished_changes and term_entry_published.

Antworten

• 200 OKThe term.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
• 404 Not FoundNot found in the token's termbase.

PATCH/terms/:identifier

Change a term

Benötigter Scope:edit_terms

Pfad-Parameter

identifierstring · uuidPflicht

Identifier of the term.

Body-Parameter · JSON

valuestring

The term.

subjectstring

Subject area of the term entry; changes it for all of its terms.

locale_codestring

Language of the term.

statestring

preferred, admitted, deprecated, not_recommended or the identifier of a custom state of the termbase.

term_typestring | null

fullForm full form, abbreviation abbreviation, acronym acronym, short short form, variant variant, colloquial colloquial term, combination term combination.

part_of_speechstring | null

Erlaubte Werte: noun, proper_noun, verb, adj, adv

grammatical_genderstring | null

Erlaubte Werte: masculine, feminine, neuter, other

grammatical_numberstring | null

The plural category (Unicode CLDR) the term is in, e.g. one singular, other plural in German and English.Erlaubte Werte: zero, one, two, few, many, other

usagestring

How to use the term — or why not to.

sourcestring

Where the term comes from, as free text.

contextstring

A sentence the term was found in.

ignore_caseboolean

Find the term regardless of upper and lower case in term checks.

value_formattingobject[]

Subscript and superscript in the value, as ranges over it: start and end (exclusive) count UTF-16 code units, so CO2 with a subscript 2 is [{"start": 2, "end": 3, "type": "sub"}].

3 Felder

startintegerPflicht

endintegerPflicht

typestringPflicht

Erlaubte Werte: sub, sup

fieldsobject

Values of custom fields, keyed by their identifier (see GET /termbases/{identifier}).

Antworten

• 200 OKThe changed term.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
• 404 Not FoundNot found in the token's termbase.
• 422 Unprocessable EntityA parameter has an invalid value, e.g. a required custom field is empty or value is blank.

DELETE/terms/:identifier

Delete a term

Benötigter Scope:edit_terms

Pfad-Parameter

identifierstring · uuidPflicht

Identifier of the term.

Antworten

• 204 No ContentDeleted.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
• 404 Not FoundNot found in the token's termbase.

GET/terms/:identifier/versions

List the versions of a term

Pfad-Parameter

identifierstring · uuidPflicht

Identifier of the term.

Antworten

• 200 OKThe versions of the term.
• 401 UnauthorizedThe token is missing, invalid, expired or revoked, its user has no access to the termbase any more, or it lacks the required scope.
• 404 Not FoundNot found in the token's termbase.