| Anchor | ||||
|---|---|---|---|---|
|
...
Each approval task can be one of three different types: Release, Application, and Project.
Release Approval Task
| Attributes | Type | Description |
|---|---|---|
| snapshotId | Long | The snapshot id of the release approval task. |
| pipelineName | String | The pipeline name of the release approval task. |
| environmentName | String | The environment name of the release approval task. |
| gateName | String | The gate name of the release approval task. |
| releaseName | String | The release name of the release approval task. |
| releaseDefinitionId | Long | The release definition Id of the release approval task. |
| releaseSnapshot | String | The release snapshot of the release approval task. |
| externalId | String | The external Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemId | String | The external System Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemType | String | The external System type of the release approval task. If the release approval task is not an external approval this will be null. |
| pipelineStageGateExecId | Long | The pipeline stage execution Id of the release approval task. |
Application Approval Task
| Attributes | Type | Description |
|---|---|---|
| snapshotId | Long | The snapshot id of the release approval task. |
| pipelineName | String | The pipeline name of the release approval task. |
| environmentName | String | The environment name of the release approval task. |
| gateName | String | The gate name of the release approval task. |
| releaseName | String | The release name of the release approval task. |
| releaseDefinitionId | Long | The release definition Id of the release approval task. |
| releaseSnapshot | String | The release snapshot of the release approval task. |
| externalId | String | The external Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemId | String | The external System Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemType | String | The external System type of the release approval task. If the release approval task is not an external approval this will be null. |
| pipelineStageGateExecId | Long | The pipeline stage execution Id of the release approval task. |
Project Approval Task
| Attributes | Type | Description |
|---|---|---|
| snapshotId | Long | The snapshot id of the release approval task. |
| pipelineName | String | The pipeline name of the release approval task. |
| environmentName | String | The environment name of the release approval task. |
| gateName | String | The gate name of the release approval task. |
| releaseName | String | The release name of the release approval task. |
| releaseDefinitionId | Long | The release definition Id of the release approval task. |
| releaseSnapshot | String | The release snapshot of the release approval task. |
| externalId | String | The external Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemId | String | The external System Id of the release approval task. If the release approval task is not an external approval this will be null. |
| externalSystemType | String | The external System type of the release approval task. If the release approval task is not an external approval this will be null. |
| pipelineStageGateExecId | Long | The pipeline stage execution Id of the release approval task. |
...
GET (Using Query Parameters)
This GET service will return a list of approval tasks in the form of JSON objects based on a query parameter for the display name. Approval tasks are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of approval tasks.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/approval? Append the following character sequences to the above URL to specify Query parameters.workflowrequestid = {workflowRequestId} foldererquestid = {folderRequestId} pipelinestageexecid = {pipelineStageExecId} projectid = {projectId} applicationid = {applicationId} environmentid = {environmentId} Examples:To return all of the approval tasks:http://host:port/flexdeploy/rest/tasks/approval To search by project Id only:http://host:port/flexdeploy/rest/tasks/approval?projectid=11001 |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"projectName": "Project 1",
"projectVersionName": "1.0.21",
"workflowRequestId": 11701,
"projectId": 10002,
"taskId": 11702,
"status": "PENDING",
"environmentId": 16109,
"flexFields": [],
"requestType": "Project",
"requestorPath": "FlexDeploy / Application 1"
}
] |
...
ApproveByTaskIdApprove By TaskId
This PUT service will approve an approval task with the given Id.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"projectName": "Project 1",
"projectVersionName": "1.0.21",
"workflowRequestId": 11701,
"projectId": 10002,
"taskId": 11702,
"status": "APPROVED",
"environmentId": 16109,
"flexFields": [],
"requestType": "Project",
"requestorPath": "FlexDeploy / Application 1"
} |
...
Approve using Query Parameters
This PUT service will approve an approval task with the given attributes.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"projectName": "Project 1",
"projectVersionName": "1.0.21",
"workflowRequestId": 11701,
"projectId": 10002,
"taskId": 11702,
"status": "APPROVED",
"environmentId": 16109,
"flexFields": [],
"requestType": "Project",
"requestorPath": "FlexDeploy / Application 1"
} |
...
RejectByTaskIdReject By TaskId
This PUT service will reject an approval task with the given Id.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"projectName": "Project 1",
"projectVersionName": "1.0.21",
"workflowRequestId": 11701,
"projectId": 10002,
"taskId": 11702,
"status": "REJECTED",
"environmentId": 16109,
"flexFields": [],
"requestType": "Project",
"requestorPath": "FlexDeploy / Application 1"
} |
...
Reject using Query Parameters
This PUT service will approve an approval task with the given attributes.
...