Complete project steps
Complete the steps of the tasks in one or more projects.
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 and then select your user type.
Prerequisites
- The IDs of the projects whose steps you want to complete. To retrieve a list of the most relevant projects, make a GET call to the following endpoint and write down the appropriate project IDs in the response:
<protocol>://<ws-host>:<ws-port>/ws-api/v2/projects?token=<sessionId>&limit=<number>&fields=<required-fields>
- The ID of the workflow corresponding to each project. This ID is part of the response when you make a GET call to the following endpoint:
<protocol>://<ws-host>:<ws-port>/ws-api/v2/projects/<projectId>?token=<sessionId>
- The transitionId of the next workflow step for each project. The ID is part of the response when you make a GET call to the following endpoint:
<protocol>://<ws-host>:<ws-port>/ws-api/v2/workflows/<workflowId>?token=<sessionId>
API call
Versioning notes
Starting with WorldServer 11.4, the actions of completing and canceling projects are no longer handled by the user interface; WorldServer now processes them as background jobs. If you make this call on v2 compared to v1, an additional property (backgroundTaskId) will be returned as part of the response. This property indicates the ID of the background job that handles your request to complete project steps.
If you make the call on v1 in this version of WorldServer, the backgroundTaskId is not returned, but the actions of completing and canceling projects are still processed as background jobs.
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 projects whose steps you want to complete (in the JSON body), and the transitionId of the next workflow step for each project (also in the JSON body)
Request body example
Response (v2)
Error messages
| Message | Status code |
|---|---|
| The transition you specified is not one of the valid options. You can only specify the next possible transition for the current workflow step. | 400 Bad Request |
| Project Id is not valid (If the ID of the project is not a valid number.) | 400 Bad Request |
| Transition Id is not valid (If the ID of the transition is not a valid number.) | 400 Bad Request |
| Not valid JSON body sent | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |
| Resource PROJECT (ID) not found | 404 Not Found |