...
Import terms to the TermCollection via tbx-file | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 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 containing TBX files) uploaded as multipart/form-data. If multiple tbx 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. | ||||||||||
| importSource Optional. If given, should be either 'filesystem' or 'crossApi' | ||||||||||
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 at 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 are were last updated before the the start of the current import. | ||||||||||
| 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 (of 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 from 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 term collection.
| ||||||||||
POST request parameters example(json):
{
"data":{
"collectionId": 1,
"customerId":1000,
"mergeTerms":true,
"tbxUpload": ,
"deleteTermsLastTouchedOlderThan": "2018-05-01",
"deleteTermsOlderThanCurrentImport": true,
"deleteProposalsLastTouchedOlderThan": 2018-05-01",
"deleteProposalsOlderThanCurrentImport" : true
| ||
}tbxUpload
tbx file/files (or a zip file containing TBX files) uploaded as multipart/form-data
Important: with the import call, one or multiple tbx files must be provided. Importing additional files in term collection is also available via the general language resource import route: /editor/languageresourceinstance/[ID]/import. More info can be found here.
There can be additional possibility to import terms to the term collection.
...