Anchor | ||||
---|---|---|---|---|
|
...
Each function returns a JSON approval task object. The approval task object has these attributes:
Application Approval Task
Attributes | Type | Description |
---|---|---|
taskId | Long | The task id of the approval task. |
status | String | The status of the approval task. |
environmentId | Long | The environment Id of the approval task. |
requestType | String | The request type of the approval task. The request type can be a release, application, or project request. |
flexFields | List<FlexField> | The list of flex fields for the approval task. |
requestorPath | String | The requestor path of the approval task. |
Each approval task can be one of three different types: Release, Application, and Project.
Release Approval Task
...
externalId | String | The externalId of the approval task. If the approval task is not an external approval task this will be null. |
externalSystemId | Long | The externalSystemId of the approval task. If the approval task is not an external approval task this will be null. |
externalSystemTyp | String | The externalSystemType of the approval task. If the approval task is not an external approval task this will be null. |
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. | If|
environmentName | String | The environment name of the release approval task | is not an external approval this will be null. |
gateName | LongString | The | pipeline stage execution Idgate name of the release approval task. |
Project Approval Task
Attributes | Type | Description | |||
---|---|---|---|---|---|
snapshotId | Long | The snapshot idreleaseName | String | The release name of the release approval task. | |
releaseDefinitionId | StringLong | The | pipeline namerelease definition Id of the release approval task. | ||
releaseSnapshot | String | The | environment namerelease snapshot of the release approval task. | ||
pipelineStageGateExecId | StringLong | The | gate namepipeline stage execution Id of the release approval task. | releaseName | String | The release name of the release
Application Approval Task
Attributes | Type | Description | |||
---|---|---|---|---|---|
applicationId | Long | The application id of the application approval task. | |||
applicationName | LongString | The | release definition Idapplication name of the | releaseapplication approval task. | |
folderVersionName | String | The | release snapshotfolder version name of the | releaseapplication approval task. | |
folderRequestId | String | The | externalfolder request Id of the | releaseapplication approval task. | If the release approval task is not an external approval this will be null.externalSystemId
Project Approval Task
Attributes | Type | Description | |||
---|---|---|---|---|---|
projectId | Long | The project id of the project approval task. | |||
projectName | String | The | external System Idprohect name of the | releaseproject approval task. | If the release approval task is not an external approval this will be null.externalSystemType|
projectVersionName | String | The | external System typeproject version name of the | releaseproject approval task | . If the release approval task is not an external approval this will be null. |
workflowRequestId | Long | The | pipeline stage execution Idworkflow request id of the | releaseproject approval task. |
...
GET
GET by TaskId
...
Parameter | Type | Required | Description |
---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return an approval task. |
Example
If we had an application approval task in our database with an Id of 10000 and had the following attributes
...
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 = {workflowRequestId} foldererquestid folderRequestId = {folderRequestId} pipelinestageexecid pipelineStageExecId = {pipelineStageExecId} projectid projectId = {projectId} applicationid applicationId = {applicationId} environmentid environmentId = {environmentId} externalId = {externalId} externalSystemType = {externalSystemType} externalSystemId = {externalSystemId} 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 |
...
Parameter | Type | Required | Description |
---|---|---|---|
workflowrequestidworkflowRequestId | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
foldererquestid folderRequestId | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
pipelinestageexecidpipelineStageExecId | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
projectidprojectId | URL | No | This is a URL query parameter for the project Id which is used to search the approval tasks. |
applicationidapplicationId | URL | No | This is a URL query parameter for the application Id which is used to search the approval tasks. |
environmentidenvironmentId | URL | No | This is a URL query parameter for the environment Id which is used to search the approval tasks. |
externalId | URL | No | This is a URL query paramter for the external Id which is used to search the approval tasks. |
externalSystemType | URL | No | This is a URL query parameter for the external system type which is used to search the approval tasks. |
externalSystemId | URL | No | This is a URL query parameter for the external system Id which is used to seach the approval tasks. |
...
Info | ||
---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/approval/approve? Append the following character sequences to the above URL to specify Query parameters.workflowrequestid workflowRequestId = {workflowRequestId} foldererquestid folderRequestId = {folderRequestId} pipelinestageexecid pipelineStageExecId = {pipelineStageExecId} projectid projectId = {projectId} applicationid applicationId = {applicationId} environmentid environmentId = {environmentId} externalId = {externalId} externalSystemType = {externalSystemType} externalSystemId = {externalSystemId} |
Info | ||
---|---|---|
| ||
Only one approval task can be approved at a time. If more than one task matches the query parameters an exception will be thrown. |
...
Parameter | Type | Required | Description |
---|---|---|---|
workflowrequestidworkflowRequestId | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
foldererquestidfolderRequestId | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
pipelinestageexecidpipelineStageExecId | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
projectidprojectId | URL | No | This is a URL query parameter for the project Id which is used to search the approval tasks. |
applicationidapplicationId | URL | No | This is a URL query parameter for the application Id which is used to search the approval tasks. |
environmentidenvironmentId | URL | No | This is a URL query parameter for the environment Id which is used to search the approval tasks. |
externalId | URL | No | This is a URL query parameter for the external Id which is used to search the approval tasks. |
externalSystemType | URL | No | This is a URL query parameter for the external Id which is used to search the approval tasks. |
externalSystemId | URL | No | This is a URL query parameter for the external Id which is used to search the approval tasks. |
...
Info | ||
---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/approval/reject? Append the following character sequences to the above URL to specify Query parameters.workflowrequestid workflowRequestId = {workflowRequestId} foldererquestid folderRequestId = {folderRequestId} pipelinestageexecid pipelineStageExecId = {pipelineStageExecId} projectid projectId = {projectId} applicationid applicationId = {applicationId} environmentid environmentId = {environmentId} externalId = {externalId} externalSystemType = {externalSystemType} externalSystemId = {externalSystemId} |
Info | ||
---|---|---|
| ||
Only one approval task can be rejected at a time. If more than one task matches the query parameters an exception will be thrown. |
...
Parameter | Type | Required | Description |
---|---|---|---|
workflowrequestidworkflowRequestId | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
foldererquestidfolderRequestId | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
pipelinestageexecidpipelineStageExecId | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
projectidprojectId | URL | No | This is a URL query parameter for the project Id which is used to search the approval tasks. |
applicationidapplicationId | URL | No | This is a URL query parameter for the application Id which is used to search the approval tasks. |
environmentidenvironmentId | URL | No | This is a URL query parameter for the environment Id which is used to search the approval tasks. |
externalId | URL | No | This is a URL query parameter for the external Id which is used to search the approval tasks. |
externalSystemType | URL | No | This is a URL query paramater for the external Id which is used to search the approval tasks. |
externalSystemId | URL | No | This is a URL query parameter for the external Id which is used to search the approval tasks. |
...