| API |
UpdateApprovalStage |
| Description |
Approval of API to action on request. Requests can be approved, referred to
back or rejected by approval users. |
| Method |
POST
|
| URL |
Http(s)://{xx.xxxx.xx.xx:xxx}/v3/approval/requestNumber/{requestNumber}
|
| URL Parameters (fields in curly {} braces) |
- requestNumber (Mandatory): Unique request
number for approval. RequestNumber is generated by placing new request using
v3/requests Post API.
|
| Body Parameters |
{
"stageName": "",
"status": "",
"remarks": "",
"requestJson": [
{
"itemNumber": 0,
"businessParameters": {}
}]
}
-
StageName (Mandatory): Name of approval stage to approve/refer
back/reject request. To approve/refer back/reject all the stages one time so
user can define StageName=” ALL”.
-
Status (Mandatory): Status should be “Approved”,”Referback” and
“Reject”
-
Requestjson (Optional): It is a JSON object containing key value pair to
update business parameters against request and item number.
|
| Header |
-
Authorization Key: The initial step that needs to be performed before
consuming HCL BigFix CLM API is to obtain the Token
Value for an authorization key. Once a Token
value is obtained, it remains valid for all API calls
made in a session. For more information on how to do that, refer Token API description.
-
Content-type: application/json
|
| Response
|
A Sample Response:
|
| Response Parameters |
|
