This POST service will approve or reject an Approval Gate for a pipeline stage execution.
...
| Note |
|---|
The authenticated user must be a member of the pipeline role assigned to gate in order to approve or reject it. |
Complete Approval Gate Sample JSON Request
| |||||||
|---|---|---|---|---|---|---|---|
| Opening bracket Authentication section, used on all types of requests. | ||||||
Required parameters for creating or editing a release. | |||||||
| Complete the The Gate we want to complete is named The gate we're approving is in the The Status to give to the gate. Options are | ||||||
Optionally, include any of this information. Verify that your JSON is valid; check for trailing commas if you don't include this section. | |||||||
"snapshotName": "09-24-2017 14:26:47" | The name of the Snapshot we want to approve is "09-24-2017 14:26:47". If this is not specified, FlexDeploy will use the latest running snapshot. | ||||||
} | Closing bracket | ||||||
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Y | Object | The login information for the user connecting to FlexDeploy. |
| Y | String | The name of the release containing the gate we want to complete. |
| Y | String | The name of the gate to update the status on. |
| N | String | The name of the executing snapshot that is waiting on the gate. If not provided, latest Stage Execution will be used. |
| Y | String | The code for the environment the gate is executing in. |
| Y | String | The updated status to apply to the gate. Options are |
Example Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"authentication":
{
"userId": "fdadmin",
"password": "welcome1"
},
"releaseName": "Release 3",
"environmentCode": "TEST",
"gateName": "Manager Approval",
"status" : "APPROVED"
} |
...