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.
...
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Task was found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Task not found |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with an Id of 10000 and the following attributes
...
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 |
...
| Include Page | ||||
|---|---|---|---|---|
|
Example
...
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with the following attributes
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | Long | Yes | The Id of the scheduled task you wish to run |
| notes | String | No | This is a URL query parameter to add notes to the task when running it. |
| Include Page | ||||
|---|---|---|---|---|
|
Response
...
Codes
| HTTP Code | Description |
|---|---|
| 200 | Task was found and schedule set to run immediately |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Task not found |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with the following attributes
...
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowRequestId | URL | No | This is a URL query parameter for the workflow request Id which is used to search the scheduled tasks. |
| folderRequestId | URL | No | This is a URL query parameter for the folder request Id which is used to search the scheduled tasks. |
| pipelineStageGateExecId | URL | No | This is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks. |
| pipelineStageStepExecId | URL | No | This is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks. |
| projectId | URL | No | This is a URL query parameter for the project Id which is used to search the scheduled tasks. |
| applicationId | URL | No | This is a URL query parameter for the application Id which is used to search the scheduled tasks. |
| environmentId | URL | No | This is a URL query parameter for the environment Id which is used to search the scheduled tasks. |
| notes | URL | No | This is a URL query parameter to add notes to the task when running it. |
| Include Page | REST V1 Scheduled Task Response | REST V1 Scheduled Task Response|||
|---|---|---|---|---|
| Include Page | ||||
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Task was found and schedule set to run immediately |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Task not found |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with the following attributes
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | Long | Yes | The Id of the scheduled task you wish to cancel |
| notes | String | No | This is a URL query parameter to add notes to the task when canceling it. |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Task was found and cancelled |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Task not found |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with the following attributes
...
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Task was found and cancelled |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Task not found |
| 500 | Unexpected internal server error |
Example
If we had a scheduled task in our database with the following attributes
...