Documentation Center

Import tasks

Import translation kits that contain translated tasks.

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 Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks/import?token=<sessionId>

Prerequisites

Before you can import tasks, you need to upload the assets corresponding to those tasks into WorldServer.

After you upload an asset through the API, the response includes an internalName property. Take a screen shot of it or write down its value. You will need it in all operations involving uploaded assets.A screen shot that highlights the internalName of an asset.

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) and the file (the internalName returned as part of the response to uploading each asset of the task; in the JSON body)
  • Optional parameters: updateTM (boolean, in the JSON body) and type (one of UNKNOWN, WSXZ, BDX, REGULATOR_BUNDLE, XLZ; also in the JSON body)

Request body example

A screen shot that shows a possible JSON request body.

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
Field file is not set400 Bad Request
The given type is not valid400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource TASK (ID) not found404 Not Found
The system cannot find the file specified (If the internalName of the file is not correct.)500 Internal Server Error