Documentation Center

Redo projects

Re-execute 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/v1/projects/redo?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) and the ID of each project that you want to redo (in the JSON body)
  • Optional parameters: comment (in the JSON body)

Request body example

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

Response

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

Error messages

MessageStatus code
Could not read document [...] (If the ID of the project is not a valid number.)400 Bad Request
Required request body is missing400 Bad Request
No session token provided or invalid token401 Unauthorized
Resource WorkflowTransition (Redo) not found (If the task is not in a failed step.)404 Not Found