Export tasks
Export tasks as part of a translation kit and translate them in an external editor.
For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The
sessionId in the response is your session token. Use this token in all the other calls that you make.
Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to and then select your user type.
API call
<protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks/export?token=<sessionId>
Details
- POST method
- Content-Type in the header:
application/json - Mandatory parameters:
- the session token (as a query string parameter or as a key-value pair in the header)
- the IDs of the tasks that you want to export (in the JSON body)
- type: One of
UNKNOWN,WSXZ,BDX,XLIFF,REGULATOR_BUNDLE, orXLZ(in the JSON body)
- Optional parameters (all in the JSON body):
- allowSplitAndMerge: boolean
- tmInfo: One of
CONTENT,LINK, orCONTENT_AND_LINK - segmentExclusion: One of
NONE,ICE, orICE100 - tdFilterId: integer
- tmFilterId: integer
- urlOfOrigin
Request body example
Response
The response status can be:
- OK: All the tasks have been exported.
- PARTIAL_SUCCESS: Some of the tasks have been exported.
- ERROR: None of the tasks has been exported.
Error messages
| Message | Status code |
|---|---|
| Resource Task is not valid (If the ID of the task is not a valid number.) | 400 Bad Request |
Allow Split Merge is not valid (If the value you specified is not true or false.) | 400 Bad Request |
| Td Filter Id is not valid (If the ID of the TD filter is not a valid number.) | 400 Bad Request |
| Tm Filter Id is not valid (If the ID of the TM filter is not a valid number.) | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |
| Resource TASK (ID) not found | 404 Not Found |
| Resource TASK not found | 404 Not Found |
| Invalid export type | 500 Internal Server Error |
| Resource type not specified | 500 Internal Server Error |