Approval Tasks can be accessed through this API using GET. This API can also approve and reject approval tasks based on task id and other parameters.
...
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/v1/tasks/approval? Append the following character sequences to the above URL to specify Query parameters.workflowRequestId = {workflowRequestId} folderRequestId = {folderRequestId} pipelineStageExecId = {pipelineStageExecId} projectId = {projectId} applicationId = {applicationId} environmentId = {environmentId} externalId = {externalId} externalSystemType = {externalSystemType} externalSystemId = {externalSystemId} notes = {notes}* Examples:To return all of the approval tasks:http://host:port/flexdeploy/rest/v1/tasks/approval To search by project Id only:http://host:port/flexdeploy/rest/v1/tasks/approval?projectid=11001 |
...
| Tip |
|---|
The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example. *notes are used to add a note, not search by a note. |
Request
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowRequestId |
| Query - Long | No | This is a URL query parameter for the workflow request Id which is used to search the approval tasks. |
folderRequestId |
| Query - Long | No | This is a URL query parameter for the folder request Id which is used to search the approval tasks. |
| pipelineStageExecId |
| Query - Long | No | This is a URL query parameter for the pipeline stage execution Id which is used to search the approval tasks. |
| projectId |
| Query - Long | No | This is a URL query parameter for the project Id which is used to search the approval tasks. |
| applicationId |
| Query - Long | No | This is a URL query parameter for the application Id which is used to search the approval tasks. |
| environmentId |
| Query - Long | No | This is a URL query parameter for the environment Id which is used to search the approval tasks. |
| externalId |
| Query - Long | No | This is a URL query paramter for the external Id which is used to search the approval tasks. |
| externalSystemType |
| Query - String | No | This is a URL query parameter for the external system type which is used to search the approval tasks. Equals type search. |
| externalSystemId |
| Query - Long | No | This is a URL query parameter for the external system Id which is used to seach the approval tasks. |
| notes |
| Query - String | No | Notes entered when approving or rejecting the task Equals type search. |
| Include Page | ||||
|---|---|---|---|---|
|
...