Developer

Page tree

Versions Compared

Old Version 21

changes.mady.by.user Pavel Perminov

Saved on

compared with

New Version 22

changes.mady.by.user Pavel Perminov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

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

Get termcollections list

RequestGET /editor/termcollection


Code Block
languagejs
titleResponse
collapsetrue
{
    "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 an info for a certain termcollection

Request

GET /editor/termcollection/ID 

URI ParamsID Required. Id of a termcollection


Code Block
languagejs
titleResponse
collapsetrue
{
    "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
    }
}



Delete termcollection

Request

DELETE /editor/termcollection/ID 

URI ParamsID Required. Id of a termcollection to be deleted

Note: Deleting term collection will remove all terms, terms attributes and term entry attributes assigned to this term collection

Code Block
languagejs
titleResponse
collapsetrue
{
    "success": true
}


Description

The database-side storage of terms is extended by the "TermCollection",  which makes it possible, for example, to group terms that belong to a specifc client. This way an end client can be assigned to one or more TermCollections.

...

URL:

/editor/termcollection/[ID]

Available Methods:

GET / POST / DELETE

Specialities:

Deleting term collection will remove all terms, terms attributes and term entry attributes assigned to this term collection

Resource Layout

Name

Type

Info

id

int

GET only

name

string

The name of the term collection (unique)

timestamp

DateTimeDate and time when the term collection is created

customerId

integer

Foreign key to the customers table

...