If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
Client app setup data | |
---|---|
Request | GET /editor/plugins_termportal_data |
Params | locale=(en|de) optional, default 'en'. Titles stored in response.l10n rely on this |
Term search | |
---|---|
Request | GET /editor/plugins_termportal_data/search |
Params | query * Required. |
language Required. ID of language which searched terms belong to | |
clientIds Optional. Comma-separated list of integers, representing client IDs. | |
collectionIds Optional. Comma-separated list of integers, representing collection. | |
processStatus Optional. Comma-separated list of any of 'unprocessed', 'provisionallyProcessed', 'finalized' and 'rejected'. | |
noTermDefinedFor If of language, that term is not yet defined for | |
attr-x Attribute search, where 'x' - is the key in filterWindow.attributes (see Client app setup data response structure). If param name is mentioned among request params but no param value given, the search will return the terms having such attributes defined even with empty value. If param value is given, wildcard characters '*' and '?' are supported, first for multichar and second for single-char purpose | |
termEntryTbxId asd | |
termTbxId qw | |
tbxCreatedBy 53 | |
tbxCreatedGt 2021-10-13 | |
tbxCreatedLt 2022-05-04 | |
tbxCreatedAt | |
tbxUpdatedBy | |
tbxUpdatedGt | |
tbxUpdatedLt | |
tbxUpdatedAt | |
page Page number, default 1 | |
start Results offset, default 0 | |
limit Results limit per page, default 250 |
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 | - |