Scheduled Tasks can be accessed through this API using GET. This API can also run and cancel scheduled tasks based on task id and other parameters.
...
GET (Using Query Parameters)
This GET service will return a list of scheduled tasks in the form of JSON objects based on a query parameter for the display name. Scheduled tasks are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of scheduled tasks.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/tasks/scheduled? Append the following character sequences to the above URL to specify Query parameters.workflowRequestId = {workflowRequestId} folderRequestId = {folderRequestId} pipelineStageGateExecId = {pipelineStageGateExecId} pipelineStageStepExecId = {pipelineStageStepExecId} projectId = {projectId} applicationId = {applicationId} environmentId = {environmentId} notes = {notes} Examples:To return all of the scheduled tasks:http://host:port/flexdeploy/rest/v1/tasks/scheduled To search by project Id only:http://host:port/flexdeploy/rest/v1/tasks/scheduled?projectid=11001 |
...
| Tip |
|---|
The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example. |
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 scheduled tasks. |
| folderRequestId |
| Query - Long | No | This is a URL query parameter for the folder request Id which is used to search the scheduled tasks. |
| pipelineStageGateExecId |
| Query - Long | No | This is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks. |
| pipelineStageStepExecId |
| Query - Long | No | This is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks. |
| projectId |
| Query - Long | No | This is a URL query parameter for the project Id which is used to search the scheduled tasks. |
| applicationId |
| Query - Long | No | This is a URL query parameter for the application Id which is used to search the scheduled tasks. |
| environmentId |
| Query - Long | No | This is a URL query parameter for the environment Id which is used to search the scheduled tasks. |
| notes |
| Query - String | No | This is a URL query parameter for notes added to the task when running or canceling it. Equals type search. |
| Include Page | ||||
|---|---|---|---|---|
|
...