Page History

...

Note
If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.

Get list of TermCollections

Request

GET /editor/termcollection

Code Block

language	js
title	Response
collapse	true

{
    "rows": [
        {
            "id": "1",
            "entityVersion": "4",
            "langResUuid": "6860f07a-e09f-4822-b82d-30d1961665aa",
            "name": "Some termcollection",
            "color": "19737d",
            "resourceId": "editor_Services_TermCollection",
            "serviceType": "editor_Services_TermCollection",
            "serviceName": "TermCollection",
            "specificData": "{\"fileName\":\"terminology.tbx\",\"status\":\"available\",\"termEntry\":2727,\"term\":15813,\"attribute\":47439}",
            "timestamp": "2025-05-29 09:59:02",
            "resourceType": "termcollection",
            "writeSource": "0",
            "specificId": null
        },
        {
            "id": "2",
            "entityVersion": "3",
            "langResUuid": "c6c275e1-fd72-47f2-9f8d-47ce01f0510e",
            "name": "Some another termcollection",
            "color": "19737d",
            "resourceId": "editor_Services_TermCollection",
            "serviceType": "editor_Services_TermCollection",
            "serviceName": "TermCollection",
            "specificData": "{\"fileName\":\"160.tbx\",\"status\":\"available\",\"termEntry\":1656,\"term\":13218,\"attribute\":48330}",
            "timestamp": "2025-05-29 10:10:10",
            "resourceType": "termcollection",
            "writeSource": "0",
            "specificId": null
        },
    ],
    "total": 2
}

Get details for a certain TermCollection

Request

GET /editor/termcollection/ID

URI Params

ID Required. Id of a TermCollection

Code Block

language	js
title	Response
collapse	true

{
    "rows": {
        "id": "2",
        "entityVersion": "3",
        "langResUuid": "c6c275e1-fd72-47f2-9f8d-47ce01f0510e",
        "name": "Some another termcollection",
        "color": "19737d",
        "resourceId": "editor_Services_TermCollection",
        "serviceType": "editor_Services_TermCollection",
        "serviceName": "TermCollection",
        "specificData": "{\"fileName\":\"160.tbx\",\"status\":\"available\",\"termEntry\":1656,\"term\":13218,\"attribute\":48330}",
        "timestamp": "2025-05-29 10:10:10",
        "resourceType": "termcollection",
        "writeSource": "0",
        "specificId": null
    }
}

Create a TermCollection

Request

POST /editor/termcollection

Params

name Required. Human-readable name for the TermCollection, up to 1024 characters.

customerIds Required. Comma-separated list of customers ids for this TermCollection to be associated with.

Code Block

language	js
title	Response
collapse	true

{
    "rows": {
        "id": 13,
        "entityVersion": "0",
        "langResUuid": "4df34ca9-5e2f-42ad-a31e-946990bb135a",
        "name": "Some new termcollection",
        "color": "19737d",
        "resourceId": "editor_Services_TermCollection",
        "serviceType": "editor_Services_TermCollection",
        "serviceName": "TermCollection",
        "specificData": null,
        "timestamp": "2025-06-17 12:18:31",
        "resourceType": "termcollection",
        "writeSource": "0",
        "specificId": null
    }
}

Delete TermCollection

Request

DELETE /editor/termcollection/ID

URI Params

ID Required. Id of a TermCollection to be deleted

Note: Deleting TermCollection will remove all terms themselves, all term entries those terms are contained in, and all attributes on entry, language and term levels

Code Block

language	js
title	Response
collapse	true

{
    "success": true
}

Import terms to the TermCollection via tbx-file(s)

Request

POST /editor/termcollection/import

Params

collectionId Required. Id of a TermCollection where terms should be imported to.

tbxUpload Required. Tbx file(s) (or a zip file(s) containing TBX files) uploaded as multipart/form-data. If multiple tbx or zip files are given - they should be uploaded under tbxUpload[0], tbxUpload[1], etc params names.

customerIds Optional. Comma-separated list of customers ids for this termcollection to be associated with.

mergeTerms Optional. Boolean value to merge imported terms with terms already existing (if any) in the target termcollection. By default - false. The merge process is complex and completely described here.

deleteTermsLastTouchedOlderThan Optional. If given, should be a date in YYYY-MM-DD format, so that any terms last updated before that date - will be deleted from the target TermCollection. 'Last updated' date for a term is initially set up as a current date on import and then refreshed each time term is renamed and/or any of it's attributes created/updated/deleted.

'Last updated' date is maintained internally by translate5, and is not directly shown in TermPortal UI. However, it is replicated to 'Updated by'-field in 'Term attributes'-panel in TermPortal UI each time any further change happended to the term itself or it's attributes after initial import.

deleteTermsOlderThanCurrentImport Optional. Boolean value to delete all terms from the target TermCollection, that were last updated before the the start of the current import, and if given as true - it will have the same affect as if the current date is used as a value for the previously described param.

deleteProposalsLastTouchedOlderThan Optional. If given, should be a date in YYYY-MM-DD format, so that any terms last updated before that date and having Process status = Unprocessed - will be deleted from the target TermCollection. Also, any attributes (for any remaining terms) initially imported from tbx and updated since then but before the given date - will be reverted to back to their original values. At the same time, any attributes that were not initially imported from tbx, i.e. created afterwards but before the given date - will be deleted for the any remaining terms in the target TermCollection.

deleteProposalsOlderThanCurrentImport Optional. Boolean value having the same affect as if the current date is used as a value for the previously described param.

Note: there are additional possibilities to import terms into the TermCollection.

Import tbx files via 'Language resources' tab for the resource of type 'TermCollection', manually, or
1. programmatically via /editor/languageresourceinstance/ID/import endpoint - you can read more here about it
Using the TermImport Plug-In

Code Block

language	js
title	Response
collapse	true

{
    "success": true
}

Page tree

Versions Compared

Old Version 39

New Version 40

Key

Get list of TermCollections

Get details for a certain TermCollection

Create a TermCollection

Delete TermCollection

Import terms to the TermCollection via tbx-file(s)