| Note |
|---|
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. |
...
locale=(en|de) Optional. default 'en'. See titles in l10n in example response below
...
| language | js |
|---|---|
| title | Response |
| collapse | true |
...
...
...
...
...
clientIds Optional. Comma-separated list of integers, representing client IDs. See filterWindow.clients in Client app setup data response structure
...
termEntryTbxId Optional. Partially known tbx ids are supported
...
| Note |
|---|
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. |
...
tbxUpdatedLt Optional. Should be used to search terms updated until certain date, inclusively, according to imported tbx data. Value is expected in format yyyy-mm-dd. Can be used with tbxUpdatedGt if search by date range is needed.
...
tbxUpdatedAt Optional. Exact date of creation specified in imported tbx data. Date in format yyyy-mm-dd is expected. This can only be used if tbxUpdatedGt and tbxUpdatedLt are NOT given
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"totalCount": 5,
"data": [
{
"id": "187459",
"collectionId": "82",
"termEntryId": "16610",
"languageId": "5",
"term": "federated database",
"proposal": "",
"processStatus": "provisionallyProcessed",
"status": "admittedTerm",
"definition": "language-level definition",
"termEntryTbxId": "c6",
"collectionName": "C:\\fakepath\\TBX-basic-sample"
},
{
"id": "573874",
"collectionId": "82",
"termEntryId": "16611",
"languageId": "5",
"term": "progressive power lens1",
"proposal": "progressive power lens",
"processStatus": "provisionallyProcessed",
"status": "deprecatedTerm",
"definition": "entry-level def2",
"termEntryTbxId": "c7",
"collectionName": "C:\\fakepath\\TBX-basic-sample"
},
...
]
} |
...
Response contains attributes for this particular term itself, for it's language-level, and for it's ternEntry-level, under 'term', 'language' and 'entry' keys, respectively. Also, response object contains the array of all other terms that belong to the same termEntry that current term belongs to. FYI: the requested term is NOT excluded from the list of siblings.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"entry": {
"client": "defaultcustomer",
"tbx": "c6",
"origination": "Pavel Perminov, 21.10.2021 00:00:00",
"modification": "Pavel Perminov, 05.05.2022 14:07:02",
"attributes": [
{
"id": "2020439",
"elementName": "note",
"value": "some entry-level comment",
"type": null,
"dataTypeId": "20",
"language": null,
"target": null,
"deletable": true,
"created": "Unknown user, 20.04.2022 18:49:18",
"updated": "Pavel Perminov, 05.05.2022 15:06:50"
},
...
],
"hasComment": true,
"xrefs": {
"xGraphic": [
{
"id": "2020461",
"elementName": "xref",
"value": "logo",
"type": "xGraphic",
"dataTypeId": "71",
"language": null,
"target": "https://mydomain.com/logo.png",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:59:51",
"updated": "Pavel Perminov, 05.05.2022 15:00:18",
"isValidUrl": true
},
{
"id": "2020460",
"elementName": "xref",
"value": null,
"type": "xGraphic",
"dataTypeId": "71",
"language": null,
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:59:51",
"updated": "Pavel Perminov, 05.05.2022 13:59:51"
},
{
"id": "2020459",
"elementName": "xref",
"value": null,
"type": "xGraphic",
"dataTypeId": "71",
"language": null,
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:59:44",
"updated": "Pavel Perminov, 05.05.2022 13:59:44"
},
...
],
"externalCrossReference": [
{
"id": "2020458",
"elementName": "xref",
"value": "info page",
"type": "externalCrossReference",
"dataTypeId": "75",
"language": null,
"target": "https://wikipedia.org",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:58:58",
"updated": "Pavel Perminov, 05.05.2022 14:59:26",
"isValidUrl": true
},
{
"id": "2020457",
"elementName": "xref",
"value": null,
"type": "externalCrossReference",
"dataTypeId": "75",
"language": null,
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:58:53",
"updated": "Pavel Perminov, 05.05.2022 13:58:53"
},
...
]
},
"images": [
{
"id": "2020462",
"elementName": "descrip",
"value": "Image",
"type": "figure",
"dataTypeId": "85",
"language": null,
"target": "826561d7-cda4-4b49-a1b2-1a1225b07a2c",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:00:41",
"updated": "Pavel Perminov, 05.05.2022 14:00:41",
"src": "/editor/plugins/termimage/TermPortal/tc_82/ac9c6217-b92d-4a5d-bef7-8320123bd750.jpg"
},
...
],
"refs": [
{
"id": "2020456",
"elementName": "ref",
"value": null,
"type": "crossReference",
"dataTypeId": "78",
"language": null,
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:58:40",
"updated": "Pavel Perminov, 05.05.2022 13:58:40"
},
{
"termEntryId": "16611",
"collectionId": "82",
"language": "en",
"termId": "573874",
"languageId": "5",
"value": "progressive power lens1",
"processStatus": "provisionallyProcessed",
"status": "deprecatedTerm",
"isValidTbx": true,
"id": "2020453",
"elementName": "ref",
"type": "crossReference",
"dataTypeId": "78",
"target": "c7",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 13:54:58",
"updated": "Pavel Perminov, 05.05.2022 14:55:20"
},
...
]
},
"siblings": {
"langToShow": [],
"data": [
{
"id": "187459",
"tbx": "450f86e8-7a31-4aa8-9c25-ce0a5f968262",
"languageId": "5",
"language": "en",
"term": "federated database",
"proposal": "",
"collectionId": "82",
"status": "admittedTerm",
"processStatus": "provisionallyProcessed",
"termEntryId": "16610",
"termEntryTbxId": "c6",
"createdBy": "2",
"deletable": true,
"images": [
{
"id": "2020462",
"elementName": "descrip",
"value": "Image",
"type": "figure",
"dataTypeId": "85",
"language": null,
"target": "826561d7-cda4-4b49-a1b2-1a1225b07a2c",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:00:41",
"updated": "Pavel Perminov, 05.05.2022 14:00:41",
"src": "/editor/plugins/termimage/TermPortal/tc_82/ac9c6217-b92d-4a5d-bef7-8320123bd750.jpg"
},
...
]
},
{
"id": "607613",
"tbx": "idb96a459e-e866-4041-9542-a5547969fb23",
"languageId": "5",
"language": "en",
"term": "more database",
"proposal": "",
"collectionId": "82",
"status": "admittedTerm",
"processStatus": "finalized",
"termEntryId": "16610",
"termEntryTbxId": "c6",
"createdBy": "17",
"deletable": true,
"images": [
{
"id": "2020462",
"elementName": "descrip",
"value": "Image",
"type": "figure",
"dataTypeId": "85",
"language": null,
"target": "826561d7-cda4-4b49-a1b2-1a1225b07a2c",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:00:41",
"updated": "Pavel Perminov, 05.05.2022 14:00:41",
"src": "/editor/plugins/termimage/TermPortal/tc_82/ac9c6217-b92d-4a5d-bef7-8320123bd750.jpg"
},
...
]
},
{
"id": "187460",
"tbx": "5c87200f-e4fc-4147-9494-662253811b56",
"languageId": "253",
"language": "fr",
"term": "base de données fédérée",
"proposal": "base de données fédérée1",
"collectionId": "82",
"status": "admittedTerm",
"processStatus": "unprocessed",
"termEntryId": "16610",
"termEntryTbxId": "c6",
"createdBy": "2",
"deletable": true,
"images": [
{
"id": "2020462",
"elementName": "descrip",
"value": "Image",
"type": "figure",
"dataTypeId": "85",
"language": null,
"target": "826561d7-cda4-4b49-a1b2-1a1225b07a2c",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:00:41",
"updated": "Pavel Perminov, 05.05.2022 14:00:41",
"src": "/editor/plugins/termimage/TermPortal/tc_82/ac9c6217-b92d-4a5d-bef7-8320123bd750.jpg"
},
...
]
}
]
},
"language": {
"language": "en",
"id": "5",
"origination": "Pavel Perminov, 21.10.2021 14:10:30",
"modification": "Pavel Perminov, 05.05.2022 14:07:02",
"attributes": [
{
"id": "2020469",
"elementName": "note",
"value": "some language-level comment",
"type": null,
"dataTypeId": "20",
"language": "en",
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:06:28",
"updated": "Pavel Perminov, 05.05.2022 15:06:35"
},
...
],
"hasComment": true,
"images": [
{
"id": "2020470",
"elementName": "descrip",
"value": "Image",
"type": "figure",
"dataTypeId": "85",
"language": "en",
"target": "770ffd14-b713-4ef8-958e-88ad9f31beb4",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:07:01",
"updated": "Pavel Perminov, 05.05.2022 14:07:01",
"src": "/editor/plugins/termimage/TermPortal/tc_82/80527568-48a9-483a-9b3c-d900ea613213.jpg"
},
...
]
},
"term": {
"id": "187459",
"tbx": "450f86e8-7a31-4aa8-9c25-ce0a5f968262",
"languageId": "5",
"language": "en",
"term": "federated database",
"proposal": "",
"collectionId": "82",
"status": "admittedTerm",
"processStatus": "provisionallyProcessed",
"termEntryId": "16610",
"termEntryTbxId": "c6",
"origination": "Pavel Perminov, 21.10.2021 14:10:30",
"modification": "Pavel Perminov, 05.05.2022 14:06:43",
"attributes": [
{
"id": "669225",
"elementName": "termNote",
"value": "provisionallyProcessed",
"type": "processStatus",
"dataTypeId": "47",
"language": "en",
"target": "",
"deletable": false,
"created": "Unknown user, 20.10.2021 19:59:06",
"updated": "Unknown user, 26.04.2022 12:30:39",
"imported": {
"value": "finalized",
"target": ""
}
},
{
"id": "669226",
"elementName": "termNote",
"value": "admitted",
"type": "administrativeStatus",
"dataTypeId": "21",
"language": "en",
"target": "",
"deletable": false,
"created": "Unknown user, 20.10.2021 19:59:06",
"updated": "Unknown user, 26.04.2022 12:30:39",
"imported": {
"value": "admittedTerm-admn-sts",
"target": ""
}
},
{
"id": "2020468",
"elementName": "note",
"value": "Some term-level comment",
"type": null,
"dataTypeId": "20",
"language": "en",
"target": null,
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:06:12",
"updated": "Pavel Perminov, 05.05.2022 15:06:43"
},
...
],
"hasComment": true,
"xrefs": {
"xGraphic": [
{
"id": "2020467",
"elementName": "xref",
"value": "term external image 1",
"type": "xGraphic",
"dataTypeId": "71",
"language": "en",
"target": "https://images.google.com",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:05:21",
"updated": "Pavel Perminov, 05.05.2022 15:05:41",
"isValidUrl": true
},
...
],
"externalCrossReference": [
{
"id": "2020465",
"elementName": "xref",
"value": "term info page",
"type": "externalCrossReference",
"dataTypeId": "75",
"language": "en",
"target": "https://google.com",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:04:51",
"updated": "Pavel Perminov, 05.05.2022 15:05:05",
"isValidUrl": true
},
...
]
},
"refs": [
{
"termEntryId": "16611",
"collectionId": "82",
"language": "en",
"termId": "187461",
"languageId": "5",
"value": "progressive lens",
"processStatus": "unprocessed",
"status": "deprecatedTerm",
"isValidTbx": true,
"id": "2020463",
"elementName": "ref",
"type": "crossReference",
"dataTypeId": "78",
"target": "61806997-dfea-47df-a129-56f60b554df3",
"deletable": true,
"created": "Pavel Perminov, 05.05.2022 14:03:31",
"updated": "Pavel Perminov, 05.05.2022 15:04:43"
},
...
]
}
} |
...
Same as for 'terminfo', described above, except two things:
- Does NOT contain 'siblings'-key
- Does NOT contain termEntry-level attributes except 'refs', which are required due to that reference targets on termEntry-level are pointing to termEntries, which, in thir turn, anyway need to be somehow shown in TermPortal client app GUI, and the solution that was implemented to solve that problem assumes that terms are shown there, but they can be different depending on the language of term given by 'termId' request-param
Provides access to the Term collections available in the application.
...
URL:
...
/editor/term/[ID]
...
Available Methods:
...
GET / POST / PUT / DELETE
...
/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
...
status
...
preferredTerm, admittedTerm, legalTerm, regulatedTerm, standardizedTerm, deprecatedTerm, supersededTerm
...
processStatus
...
string
...
The current processing status of a term, one of: unprocessed, provisionallyProcessed, finalized
...
Propose Operation
...
URL:
...
/editor/term/[ID]/propose/operation
...
Available Methods:
...
Description
...
Confirm Proposal Operation
...
URL:
...
/editor/term/[ID]/confirmproposal/operation
...
Available Methods:
...
Description
...