Documentation Center

Update task assets

Update the source asset of a task and restart the task.

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/<taskId>/asset?token=<sessionId>

Details

  • POST method
  • Content-Type in the header: application/json
  • Mandatory body type: form-data, with a file as its content (a property key named file and the file that you want to upload as its value)
  • Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header) and the ID of the task that you want to update (as a URI parameter)

Form-data example

A screen shot that shows the form-data body required to make this call.

Response

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

Error messages

MessageStatus code
The asset was not sent or the name of the new asset is not the same as the name of the existing asset.400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource TASK (ID) not found404 Not Found