Complete task steps

Complete the steps of certain 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.

Prerequisites

Before you can complete task steps, you need to obtain the following information:
  • The ID of the workflow that is used to process the task. This ID is part of the response when you make a GET call to the following endpoint:

    <protocol>://<ws-host>:<ws-port>/ws-api/v1/tasks/<taskId>?token=<sessionId>

  • The ID of the transition of the next outbound transition in the workflow. This ID is part of the response when you make a GET call to the following endpoint:

    <protocol>://<ws-host>:<ws-port>/ws-api/v1/workflows/<workflowId>?token=<sessionId>

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v1/tasks/complete?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 ID of the tasks (in the JSON body), and the transitionId for the next workflow step (also in the JSON body)
  • Other parameters: comment (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
The supplied completion transition is not one of the valid options (You can only select the next possible transitions for the current workflow step.)400 Bad Request
Task Id is not valid (If its value is not a valid number.)400 Bad Request
Transition Id is not valid (If its value is not a valid number.)400 Bad Request
No session token provided or invalid token401 Unauthorized
No rights to COMPLETE for resource type TASK403 Forbidden
Resource TASK (ID) not found404 Not Found