Update tasks

Update the settings of one or more tasks, such as their due dates or their priority.

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

Details

  • PATCH 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 ID of the task (as part of the JSON request body)
  • Optional parameters (in the JSON body): priority, dueDate, expectedDuration, steps, status

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
Request body not sent, or invalid400 Bad Request
Field "fieldName" is not allowed400 Bad Request
Resource TASK (ID) is invalid (If the ID of the task is not a valid number.)400 Bad Request
Priority is invalid (If the priority you entered is not a valid number.)400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource TASK (ID) not found404 Not Found