Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Contribute Term

Propose a new term.

Always creates a new entry with proposed status, for a terminologist to review; the optional comment is recorded in the term’s history. Status, master term and morphosyntactic restriction cannot be set here.

Requires terminology.term-browser:contribute. Returns 403 without that permission, and also when the organization has term contribution turned off — both conditions must hold.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
surfacestringRequired1-255 characters
language_idstringRequiredformat: "uuid"
category_idslist of stringsRequired
custom_field_valueslist of objects or nullOptional
commentstring or nullOptional<=3000 characters

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