| Anchor | ||||
|---|---|---|---|---|
|
...
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} 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 |
|---|---|---|---|
| workflowrequestid | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
| foldererquestid | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
| pipelinestageexecid | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
| projectid | URL | No | This is a URL query parameter for the project Id which is used to search the approval tasks. |
| applicationid | URL | No | This is a URL query parameter for the application Id which is used to search the approval tasks. |
| environmentid | URL | No | This is a URL query parameter for the environment Id which is used to search the approval tasks. |
| externalId | URL |
Example
If we had an approval task in our database with the following attributes
...
| 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. |
Example
If we had an approval task in our database with the following attributes
| 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"
}
] |
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/approval/approve? 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} |
| 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. |
Parameters
...
Parameter
...
Type
...
Required
...
Description
...
environmentid = {environmentId} externalId = {externalId} externalSystemType = {externalSystemType} |
| 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. |
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowrequestid | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
| foldererquestid | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
| pipelinestageexecid | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
| projectid | URL | No | This is a URL query parameter for the workflow request project Id which is used to search the approval tasks. |
| foldererquestidapplicationid | URL | No | This is a URL query parameter for the folder request application Id which is used to search the approval tasks. |
| pipelinestageexecidenvironmentid | URL | No | This is a URL query parameter for the pipeline stage execution environment Id which is used to search the approval tasks. |
| projectidexternalId | URL | No | This is a URL query parameter for the project external Id which is used to search the approval tasks. |
| applicationidexternalSystemType | URL | No | This is a URL query parameter for the application external Id which is used to search the approval tasks. |
| environmentidexternalSystemId | URL | No | This is a URL query parameter for the environment external Id which is used to search the approval tasks. |
...
| 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. |
Parameters
...
Parameter
...
Type
...
Required
...
Description
...
be thrown. |
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowrequestid | URL | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
| foldererquestid | URL | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
| pipelinestageexecid | URL | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
| projectid | URL | No | This is a URL query parameter for the workflow request project Id which is used to search the approval tasks. |
| foldererquestidapplicationid | URL | No | This is a URL query parameter for the folder request application Id which is used to search the approval tasks. |
| pipelinestageexecidenvironmentid | URL | No | This is a URL query parameter for the pipeline stage execution environment Id which is used to search the approval tasks. |
| projectidexternalId | URLURL | No | This is a URL query parameter for the project external Id which is used to search the approval tasks. |
| applicationidexternalSystemType | URL | No | This is a URL query parameter paramater for the application external Id which is used to search the approval tasks. |
| environmentidexternalSystemId | URLURL | No | This is a URL query parameter for the environment external Id which is used to search the approval tasks. |
...