Description: Approve or reject a step. The request returns one of the following status codes:
4005: After the Pending Approval step is approved the step moves to
Waiting
status (and will later get picked up for execution).4013: After the Pending Approval step is rejected the step moves to
Canceling
status (and will later get canceled).
Security: Requires a valid user
Usage: POST api/v1/steps/{id}/approvalResponse
Consumes: application/json
Request Parameters:
Parameter | Data Type | Description | Required/Optional |
---|---|---|---|
| String | Approval response, either | Required |
| String | Approval comment. Max length: 100 characters. | Optional |
Sample Request:
POST api/v1/steps/1/approvalResponse
{ "response": "approved", "comment": "my comment" }
Sample Response:
POST api/v1/steps/1/approvalResponse
{ "stepId": 1, "updatedStatusCode": 4005 }
Response Codes:
200: Success
404:Invalid response type (should be approved/rejected)
404:Invalid step status (should be Pending Approval 4022)