Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Create Term

Create a term.

Without masterterm_id the term starts a new entry (concept) and becomes its head term. With masterterm_id set to an entry’s head term, the term joins that entry: as a synonym in the same language, or as a translation in another.

Language, status and the other categories are given by ID; list them with GET /categories. Returns 400 if a category or the master term does not exist in this organization.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
surfacestringRequired<=255 characters
language_idstringRequiredformat: "uuid"
status_idstringRequiredformat: "uuid"
msr_idstring or nullOptionalformat: "uuid"
masterterm_idstring or nullOptionalformat: "uuid"
Link to existing head term. If null, creates a new head term.
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
concept_idstring or nullOptional

Human-readable concept ID. Defaults to surface text.

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