Cancel projects
Cancel certain 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.
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 cancel projects.
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 ID of the project that you want to cancel (in the JSON body)
- Optional parameters:
- comment (in the JSON body)
- includeCostInProject (in the JSON body) — whether or not the cost has to be included in the project. Possible values are true or false. If you do not include this parameter in the JSON body, the false value is applied by default and the cost is not included in the project.
Request body example
Response (v2)
Error messages
| Message | Status code |
|---|---|
| Project Id is not valid (If the ID of the project is not a valid number.) | 400 Bad Request |
| Project is inactive (If the project was already canceled.) | 400 Bad Request |
| Not valid JSON body sent | 400 Bad Request |
| Field comment not sent | 400 Bad Request |
| No session token provided or invalid token | 401 Unauthorized |