Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Update Term

Update a term. Omitted fields are left unchanged.

category_ids replaces the term’s whole set of domains and other categories, so send every category the term should keep. Custom field values are replaced only for the fields included. To move an entry to another domain, update each of its terms.

Returns 404 if the term does not exist, and 400 if a referenced category does not exist in this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

term_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
surfacestring or nullOptional<=255 characters
language_idstring or nullOptionalformat: "uuid"
status_idstring or nullOptionalformat: "uuid"
msr_idstring or nullOptionalformat: "uuid"
variantsconfigurationsstring or nullOptional

Raw variant configuration (newline-separated key=value). Prefer variant_settings; send one or the other.

variant_settingsobject or nullOptional
How variants of one term are matched during checking.
category_idslist of strings or nullOptional
custom_field_valueslist of objects or nullOptional
lemma_startinteger or nullOptional>=0

Character offset in surface of the word whose grammatical forms are checked. Send with lemma_length.

lemma_lengthinteger or nullOptional>=0

Length of that word; 0 turns off checking of grammatical forms.

Response

Successful Response
idstringformat: "uuid"
Identifier used by this API.
uuidstring

The term’s stable uuid, as in ACTIF term/uuid; searchable with term_uuid.

external_idstring

The term’s ID, as in ACTIF term/id.

conceptidstring

The entry’s ID, as in ACTIF entry/id.

conceptuuidstring

The entry’s uuid, as in ACTIF entry/uuid; searchable with entry_uuid.

isconceptstring

t for the entry’s head (primary) term, f otherwise.

surfaceobject or nullOptional
languageobject or nullOptional

One category: a language, status, domain, part of speech, or a value of a custom category type.

statusobject or nullOptional

One category: a language, status, domain, part of speech, or a value of a custom category type.

msrobject or nullOptional

One category: a language, status, domain, part of speech, or a value of a custom category type.

categorieslist of objectsOptionalDefaults to []
variantsconfigurationsstring or nullOptional
variant_settingsobjectOptional
How variants of one term are matched during checking.
frequencyintegerOptionalDefaults to 0
creationdatedatetime or nullOptional
creatorstring or nullOptional
lastmodificationdatedatetime or nullOptional
lastmodifierstring or nullOptional
linked_term_countintegerOptionalDefaults to 0
member_countintegerOptionalDefaults to 0
custom_fieldsmap from strings to nullable stringsOptionalDefaults to {}
custom_field_valueslist of objectsOptionalDefaults to []

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error