Page History

...

Transfer terms to main translate5 app as project of type 'termtranslation'

Request POST /editor/plugins_termportal_data/transfer

Params clientId Required. Id of a customer, that newly created termtranslation-project will belong to

projectName Required. Project name

sourceLang Required. ID of source language. See lang in Client app setup data response

targetLang Required. Comma-separated list of target languages IDs. See langAll in Client app setup data response

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

except Required if terms=none. Empty string or comma-separated list of term IDs

translated=(0|1) Required. Whether to transfer terms for translation even if they already have translation for given target languages

definition=(0|1) Required. Whether to transfer terms definition-attrs for translation as well

Response is containing json-object with key names from step1 to step5, and responses from the corresponding steps of project creation workflow

Code Block

language	js
title	Response
collapse	true

{
    "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
                    }
                }
            ]
        }
    }
}

Create new term

Request POST /editor/attribute

Params collectionId Required. ID of TermCollection that new term should be created in See filterWindow.collections in Client app setup data response

language Required. Rfc5646-code of a new term's language. See langAll[*].value in Client app setup data response

term Required. Term text itself. String.

note Required if runtimeOptions.termportal.commentAttributeMandatory config is On. String.

termEntryId Optional. ID of termEntry, which new term should be attached under. If not given - new termEntry will be created.

Code Block

language	js
title	Response
collapse	true

{
    "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"
}

Create proposal for existing term

Request

PUT /editor/attribute

Params

termId Required. ID of existing term, for proposal to be created for

proposal Optional. If not given, the existing proposal will be deleted, so existing term will be kept with no proposal

Code Block

language	js
title	Response
collapse	true

{
    "updated": "Pavel Perminov, 06.05.2022 20:47:28 ",
    "proposal": "polig1",
    "processStatus": "unprocessed"
}

Provides access to the Term collections available in the application.

...

Page tree

Versions Compared

Old Version 25

New Version 26

Key

Provides access to the Term collections available in the application.