| 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 |
...
...
...
...
query * Required. Search query. Wildcard characters '*' and '?' are supported for multi- and single-char searches, respectively.
...
...
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
...
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:
...
...
...
terms=(all|none) Required. Terms selection mode. Used in conjunction with except param, e.g. the idea of possible selections are:
- "all except 1,2,3". To use this mode you need to run Term search-request at least once, for search params to be catched in session, because this mode assumes that terms to be involved are recognized indirectly - e.g by search rather than by explicit IDs list. So except-param is used for deselection, e.g to exclude some of search results (by IDs) from being transfered into termtranslation-project. If nothing should be excluded, except-param should be kept empty
- "none except 1,2,3". Ordinary mode - terms to be transfered for translation are selected directly by their IDs, provided by except-param
...
Response is containing json-object with key names from step1 to step5, and responses from the corresponding steps of project creation workflow
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"step1": {
"success": true,
"rows": {
"id": "586",
"entityVersion": "3",
"modified": "2022-05-06 09:09:03",
"taskGuid": "{712ae3b6-7057-4a20-8de8-d4e7147db674}",
"taskNr": "",
"foreignId": "",
"taskName": "test project",
"foreignName": "",
"sourceLang": "5",
"targetLang": "0",
"relaisLang": "0",
"lockedInternalSessionUniqId": null,
"locked": null,
"lockingUser": null,
"state": "project",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"qmSubsegmentFlags": null,
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslation",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54",
"projectTasks": [
{
"id": "587",
"entityVersion": "4",
"modified": "2022-05-06 09:08:56",
"taskGuid": "{b4f17c98-9350-4d71-8f07-28ddbe9bd209}",
"taskNr": "",
"foreignId": "",
"taskName": "test project - en / bg-BG",
"foreignName": "",
"sourceLang": "5",
"targetLang": "352",
"relaisLang": "0",
"lockedInternalSessionUniqId": "*translate5InternalLock*import",
"locked": "2022-05-06 08:08:53",
"lockingUser": "{00000000-0000-0000-0000-000000000000}",
"state": "import",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "no workflow",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"qmSubsegmentFlags": null,
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslationTask",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54"
},
{
"id": "588",
"entityVersion": "6",
"modified": "2022-05-06 09:09:00",
"taskGuid": "{7a37f2af-ab76-44f8-ac45-182cc5ede849}",
"taskNr": "",
"foreignId": "",
"taskName": "test project - en / zh-TW",
"foreignName": "",
"sourceLang": "5",
"targetLang": "271",
"relaisLang": "0",
"lockedInternalSessionUniqId": "*translate5InternalLock*import",
"locked": "2022-05-06 08:08:53",
"lockingUser": "{00000000-0000-0000-0000-000000000000}",
"state": "import",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "no workflow",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"qmSubsegmentFlags": null,
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslationTask",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54"
}
]
}
},
"step2": {
"rows": {
"id": "586",
"entityVersion": "3",
"modified": "2022-05-06 09:09:03",
"taskGuid": "{712ae3b6-7057-4a20-8de8-d4e7147db674}",
"taskNr": "",
"foreignId": "",
"taskName": "test project",
"foreignName": "",
"sourceLang": "5",
"targetLang": "0",
"relaisLang": "0",
"lockedInternalSessionUniqId": null,
"locked": null,
"lockingUser": null,
"state": "project",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslation",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54",
"lockingUsername": null,
"segmentFields": [],
"userPrefs": [
{
"id": null,
"taskGuid": null,
"workflow": null,
"workflowStep": null,
"anonymousCols": false,
"visibility": "show",
"userGuid": null,
"fields": "",
"notEditContent": false,
"taskUserAssocId": null
}
],
"notEditContent": false,
"defaultSegmentLayout": true,
"userTracking": [],
"taskassocs": [],
"pixelMapping": [],
"lastErrors": [],
"workflowProgressSummary": [
{
"workflowStep": "no workflow",
"status": "edit",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translation",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "reviewing",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translatorCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "workflowEnded",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "pmCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "visiting",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
}
]
}
},
"step3": {
"587": {
"82": {
"rows": {
"id": "298",
"languageResourceId": "82",
"taskGuid": "{b4f17c98-9350-4d71-8f07-28ddbe9bd209}",
"segmentsUpdateable": "0",
"autoCreatedOnImport": "0"
}
}
},
"588": {
"82": {
"rows": {
"id": "299",
"languageResourceId": "82",
"taskGuid": "{7a37f2af-ab76-44f8-ac45-182cc5ede849}",
"segmentsUpdateable": "0",
"autoCreatedOnImport": "0"
}
}
}
},
"step4": {
"rows": {
"id": "586",
"entityVersion": "3",
"modified": "2022-05-06 09:09:03",
"taskGuid": "{712ae3b6-7057-4a20-8de8-d4e7147db674}",
"taskNr": "",
"foreignId": "",
"taskName": "test project",
"foreignName": "",
"sourceLang": "5",
"targetLang": "0",
"relaisLang": "0",
"lockedInternalSessionUniqId": null,
"locked": null,
"lockingUser": null,
"state": "project",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslation",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54",
"lockingUsername": null,
"segmentFields": [],
"userPrefs": [
{
"id": null,
"taskGuid": null,
"workflow": null,
"workflowStep": null,
"anonymousCols": false,
"visibility": "show",
"userGuid": null,
"fields": "",
"notEditContent": false,
"taskUserAssocId": null
}
],
"notEditContent": false,
"defaultSegmentLayout": true,
"userTracking": [],
"taskassocs": [],
"pixelMapping": [],
"lastErrors": [],
"workflowProgressSummary": [
{
"workflowStep": "no workflow",
"status": "edit",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translation",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "reviewing",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translatorCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "workflowEnded",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "pmCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "visiting",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
}
]
}
},
"step5": {
"rows": {
"id": "586",
"entityVersion": "3",
"modified": "2022-05-06 09:09:03",
"taskGuid": "{712ae3b6-7057-4a20-8de8-d4e7147db674}",
"taskNr": "",
"foreignId": "",
"taskName": "test project",
"foreignName": "",
"sourceLang": "5",
"targetLang": "0",
"relaisLang": "0",
"lockedInternalSessionUniqId": null,
"locked": null,
"lockingUser": null,
"state": "project",
"workflow": "default",
"workflowStep": "1",
"workflowStepName": "",
"pmGuid": "{686cb35b-8c6b-4ce9-9de7-e6af721ff9f5}",
"pmName": "Mustermann, Max (OID-35)",
"wordCount": "0",
"userCount": "0",
"orderdate": "2022-05-06 00:00:00",
"enddate": null,
"referenceFiles": "0",
"terminologie": "0",
"enableSourceEditing": "0",
"edit100PercentMatch": "0",
"lockLocked": "1",
"emptyTargets": "0",
"importAppVersion": "development",
"customerId": "1",
"usageMode": "cooperative",
"segmentCount": "0",
"segmentFinishCount": "0",
"taskType": "termtranslation",
"projectId": "586",
"diffExportUsable": "0",
"description": "",
"created": "2022-05-06 09:08:54",
"lockingUsername": null,
"segmentFields": [],
"userPrefs": [
{
"id": null,
"taskGuid": null,
"workflow": null,
"workflowStep": null,
"anonymousCols": false,
"visibility": "show",
"userGuid": null,
"fields": "",
"notEditContent": false,
"taskUserAssocId": null
}
],
"notEditContent": false,
"defaultSegmentLayout": true,
"userTracking": [],
"taskassocs": [],
"pixelMapping": [],
"lastErrors": [],
"workflowProgressSummary": [
{
"workflowStep": "no workflow",
"status": "edit",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translation",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "reviewing",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "translatorCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "workflowEnded",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "pmCheck",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
},
{
"workflowStep": "visiting",
"status": "open",
"progress": 0,
"segmentWorkCount": {
"edited": 0,
"confirmed": 0,
"sum": 0
}
}
]
}
}
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"query": "test term", // Same as given by term-param
"language": "5", // Language is returned as ID despite given as rfc5646
"collectionIds": "82", // Same as given by collectionId-param
"termId": "607616", // ID of created term
"termEntryId": "92182", // ID of created termEntry, or existing termEntry where new term was attached into
"termTbxId": "id7657b259-6393-45fa-b53d-7e857d4882aa",
"termEntryTbxId": "idaec78c6d-ea4b-46ab-bd84-9afa4070ecca"
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"updated": "Pavel Perminov, 06.05.2022 20:47:28 ",
"proposal": "polig1",
"processStatus": "unprocessed"
} |
...
Response contains isLast-property, indicating whether deleted term was the last having it's language, or last for the whole termEntry
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"isLast": "(false|language|entry)",
"modified": "Pavel Perminov, 06.05.2022 20:59:07"
} |
...
| Note |
|---|
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog. |
...
Batch-mode response example: as you can see, value of inserted.id contains comma-separated IDs of created attributes instead of just single integer value. Also please note that if attribute of some dataTypeId should be unique at it's level but it already exists, the response will contain existing-prop, having newly created attrs IDs as keys and existing attrs IDs as values. In the below example response two Comment-attributes on termEntry-level for different termEntries were created, but one of affected termEntries does already have Comment-attribute with ID=2020358. All attributes created in batch-mode are set up with isDraft=1 flag in the database, so they are drafts, and they need to be confirmed further, otherwise they will be deleted by daily cron job.
Response in case of non-batch-mode would be the same as below, except that:
inserted.idwould contain single value instead of comma-separated values,- there would be no
existing-property in response json - This is not mentioned in response, but not that isDraft would be =0,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"inserted": {
"id": "2020477,2020478",
"target": "",
"value": null,
"type": null,
"language": null,
"deletable": true,
"dataTypeId": "20",
"created": "Pavel Perminov, 09.05.2022 08:37:44",
"updated": "Pavel Perminov, 09.05.2022 08:37:44"
},
"updated": "Pavel Perminov, 09.05.2022 08:37:44",
"existing": {
"2020478": 2020358 // "ID of draft attr": "ID of attr of the same dataTypeId already existing at the same level"
}
} |
...
dataIndex=(value|target) Required if ALL attrs identified by attrId-param are of type xGraphic or externalCrossReference
...
Basically, there are the following use cases for this type of requests:
- Single-update
- Non-unique attribute at it's level (e.g. of type
xGraphic,externalCrossReference,crossReferenceandfigure)xGraphic,externalCrossReference- attrId
- dataIndex
- value
crossReference- attrId
- target
- termLang
- mainLang
figure- attrId
- figure
- Unique attribute at it's level (all other attribute types)
- Picklist attributes (e.g. of type
processStatus,administrativeStatus,termType,grammaticalGenderand others)- attrId
- value
- Plaintext attributes (e.g. of type
definition,source,context,geographicalUsage,subjectFieldand others)- attrId
- value
- Picklist attributes (e.g. of type
- Non-unique attribute at it's level (e.g. of type
- Batch-update
- Non-unique attribute at it's level.
- Unique attribute at it's level
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"updated": "Pavel Perminov, 09.05.2022 10:24:17"
} |
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
...