Documentation Center

Cancel projects

Cancel certain projects.

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/<api-version>/projects/cancel?token=<sessionId>

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)

Request body example

A screen shot that shows a possible JSON body for this call.

Response (v2)

A screen shot that shows a typical response to this call.

Error messages

MessageStatus 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 sent400 Bad Request
Field comment not sent400 Bad Request
No session token provided or invalid token401 Unauthorized