If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
Description
Single Terms can be accessed via API.
Provides access to the Term collections available in the application.
URL: | /editor/term/[ID] |
Available Methods: | GET / POST / PUT / DELETE |
Operations (POST) | /editor/term/[ID]/propose/operation /editor/term/[ID]/confirmProposal/operation |
Specialities: | - |
Resource Layout
Name | Type | Info |
id | int | GET only |
term | string | The term itself |
mid | string | A textual mid used in the TBX file |
status | string | The term status, one of: preferredTerm, admittedTerm, legalTerm, regulatedTerm, standardizedTerm, deprecatedTerm, supersededTerm |
processStatus | string | The current processing status of a term, one of: unprocessed, provisionallyProcessed, finalized |
definition | string | The term describing definition |
groupId | string | The mid of the termEntry |
language | integer | the internal language id of the term |
collectionId | integer | the collection id of the collection to which the term belongs |
termEntryId | integer | the internal term entry id of the term entry to which the term belongs |
created | timestamp | GET only, Date and time when the term collection is created |
updated | timestamp | GET only, Date and time when the term collection is updated |
proposal | object | GET only, null, or an object containing the proposal data object. |
Propose Operation
URL: | /editor/term/[ID]/propose/operation |
Available Methods: | POST |
Description | Creates a new proposal for the term |
POST Data (form encoded) | data={"term": "New Proposal"} |
Confirm Proposal Operation
URL: | /editor/term/[ID]/confirmproposal/operation |
Available Methods: | POST |
Description | Confirms a proposal and takes it over into the term itself. |
POST Data | - |