Unclaim tasks

Unclaim tasks based on their IDs.

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 calls

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

Details

  • POST method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token (as a query string parameter) and the IDs of the tasks that you want to unclaim (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
Not valid JSON body sent400 Bad Request
Task is not claimed400 Bad Request
Step Translate (N) is not assigned400 Bad Request
No session token provided or invalid token401 Unauthorized
No rights to UNCLAIM for resource type TASK (If the user does not have the appropriate rights to unclaim the task.)403 Forbidden
Resource TASK (ID) not found404 Not Found