If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
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.
Provides access to the Term collections available in the application.
GET / POST / DELETE
The name of the term collection (unique)
|DateTime||Date and time when the term collection is created|
Foreign key to the customers table
POST request parameters example :
- create new empty term collection
"name":"The name of the term collection",
"customerId":"the id of the customer to whom this collection is associated"
GET request parameters example :
- return the term collection name,timestamp and customerId for the termcollection with id = 1
Search term in term collection.
|Search term string. The search string can be combined with wildcards also.|
Term language/s ids from lek_languages table
Disable the result limit configured in searchTermsCount config variable.
Search term entry and term attributes in term collection.
Info: For search and searchatribute actions, will search in the collection assigned to the customers which customers are assigned to the currently logged user assigned customers.
|Lek_terms table groupId field.|
- Response array example
Import terms to the term collection
|Specialities:||Import the provided terms from the tbx file to the term collection|
POST request parameters example(json):
"deleteProposalsOlderThanCurrentImport" : true
Details for the resource parameters:
The id of the term collection where those terms from the tbx file are going to
Customer to that this term collection is associated
The merging of terms into an existing term collection is controlled by this boolean parameter.
tbx file/files uploaded as multipart/form-data
deleteTermsLastTouchedOlderThan (date format Y-m-d)
Deletes all terms in all listed termCollections, that have a updated date older than the date configured for "deleteTermsLastTouchedOlderThan". Every term in a termCollection has a creation date, a modification date and an updated dated. The creation date and the modification date are taken from the dates as they appear in the TBX file.
Deletes all terms in all listed termCollections, that have an "updated date" older than the start of the current import. To learn, what the "updated date" is, please read above possible values: true or false.
deleteProposalsLastTouchedOlderThan (date format Y-m-d)
Delete all proposals in a listed termCollections, that have a creation date older than this configs value.
Delete all proposals in a listed termCollections, that have a creation date older than the start of the current import.
Important: with the import call, one or multiple tbx files must be provided.
There can be additional possibility to import terms to the term collection.
- Import tbx files via language resources panel with term collection as resource
- Using the term import plugin ( see more at Plug-In TermImport: TermImport )