| Inhalt |
|---|
Using Browsers Development Tools
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/session' -X POST -H 'Accept: application/json' \ -H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \ --data-urlencode 'data={"login":"manager","passwd":"asdfasdf"}' |
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
{"sessionId":"HERE_WILL_BE_YOUR_SESSION_ID_THEN","sessionToken":"HERE_WILL_BE_YOUR_SESSION_TOKEN_THEN"} |
| Hinweis |
|---|
The examples can be tested with the commandline curl. In addition there are some online tools where you can directly paste the curl examples and test them too, for example https://reqbin.com/ --data-raw 'data=%7B%22login%22%3A%22manager%22%2C%22passwd%22%3A%22asdfasdf%22%7D' |
List translation tasks (GET examples)
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task?start=0&limit=20' -X GET -H 'Accept: application/json' -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' |
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task/TASKID' -X GET -H 'Accept: application/json' -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' |
On success this results in a JSON containing the requested task.
Filtering data
See Filtering, sorting and paging and other GET parameters.
Change Taskname (PUT example)
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task/TASKID' -X PUT -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' \ -H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' -H 'Accept: application/json' \ --data-urlencode 'data={"taskName":"New Task Name","entityVersion":123}' |
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task' -X POST \ -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' \ -F "format=jsontext" \ -F "taskName=This is a import test" \ -F "sourceLang=de" \ -F "targetLang=it" \ -F "edit100PercentMatch=1" \ -F "lockLocked=1" \ -F "importUpload=@/PATH/TO/YOUR/FILE.xlf" |
On success this results in a JSON containing the importing task.
Since a import is running in the background, the so created task will be returned with a state = import. For checking if the import is done, a callback should be configured: task import push callback
Associate users to a task
With the following example users can be added to a task to perform jobs on it.
More information about the task user association API.
To add such an association the task and user GUIDs are needed.
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://demo.translate5.net/editor/taskuserassoc/' \
-X POST -H 'Accept: application/json' \
-H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' \
--data-urlencode 'data={"taskGuid":"TASKGUID","userGuid":"USERGUID","role":"translator","state":"open", "entityVersion":TASKVERSION}' |
TASKGUID and USERGUID must be replaced with desired the values. TASKVERSION must be the current value of the tasks entityVersion. This is to ensure that no one has modified the task in the meantime.
For all possible roles and state values see the workflow description.
Export Task
With the following example the task will exported and saved as export.zip to the local disk.
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task/export/id/TASKID' -X GET -H 'Accept: application/json' -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' --output export.zip |
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
curl 'https://wwwdemo.translate5.net/editor/task/TASKID' -X DELETE -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' \ -H 'Accept: application/json' -H 'Mqi-Entity-Version: 123' |
On success this results in a JSON containing the deleted task.
Trigger manually a workflow action for a task
In special cases some workflow actions have to been triggered manually for a task.
For Details and Configuration see the Notes about Workflow Actions.
Calling the below request via POST will trigger the notifyAllUsers notification which sends an E-Mail to all associated reviewers.
For the request the TASKID is needed, and the authenticated API user have at least the role "pm".
| Codeblock |
|---|
curl 'https://demo.translate5.net/editor/task/TASKID/workflow' -X POST -H 'Cookie: zfExtended=HERE_WILL_BE_YOUR_SESSION_ID_THEN' \
-H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \
-H 'Accept: application/json' --data 'trigger=notifyAllUsersAboutTaskAssociation' --compressed |