Documentation Center

Cancel tasks

Cancel 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 call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/tasks/cancel?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 cancel, includeCostInProject, and comment (all 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
Task Id is not valid (If its value is not a valid number.)400 Bad Request
Task is already canceled400 Bad Request
Not valid JSON body sent400 Bad Request
IncludeCostInProject is not valid (If you specify a non-boolean value.)400 Bad Request
IncludeCostInProject is not set400 Bad Request
Field comment not set400 Bad Request
No session token provided or invalid token401 Unauthorized
No rights to CANCEL for resource type TASK403 Forbidden
Resource TASK (ID) not found404 Not Found