Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Publish Terminology

Publish this organization’s terminology so checks start using it.

Returns immediately with a job to poll via GET /jobs/{job_id} or GET /jobs/current; publishing continues in the background and typically takes from a few seconds to several minutes depending on how many terms there are.

Publishing an organization with no terminology succeeds and does nothing.

Returns 409 if a publish or import is already in progress — only one runs per organization at a time, so wait for the current one to finish.

Authentication

AuthorizationBearer

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

Response

Successful Response
idstringformat: "uuid"
job_typestring

Either publish or import.

statusstring

One of queued, running, succeeded, failed, or canceled. The first two mean the job is still holding the lock.

started_atdatetime
stagestring or nullOptional

Coarse progress label while running; null once finished.

started_bystring or nullOptional
Who started the job, for display.
finished_atdatetime or nullOptional
errorstring or nullOptional

Why the job failed; null unless status is failed.

term_countinteger or nullOptional
Terms published, for a successful publish.
statsmap from strings to integers or nullOptional

Per-record-type counts, for a successful import.

languageslist of objectsOptional

How each language fared, for a publish. Empty for an import, and for publishes that ran before per-language reporting existed.

import_term_filterslist of objectsOptional
What an import did with each of the legacy terminology's saved term filters. Empty for a publish, and for imports that ran before this was reported.
publish_term_filterslist of objectsOptional
What a publish did with each filter used for checking. Empty for an import, and for publishes that ran before this was reported.

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error