| Anchor | ||||
|---|---|---|---|---|
|
...
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/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/tasks/scheduled To search by project Id only:http://host:port/flexdeploy/rest/tasks/scheduled?projectid=11001 |
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/scheduled/runnow? 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 = {comment to add to the task. Only applicable for stage gate and step tasksnotes} |
| Info | ||
|---|---|---|
| ||
Only one scheduled task can be run at a time. If more than one task matches the query parameters an exception will be thrown. |
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/tasks/scheduled/cancel? 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} |
| Info | ||
|---|---|---|
| ||
Only one scheduled task can be canceled at a time. If more than one task matches the query parameters an exception will be thrown. |
...
http://host:port/flexdeploy/rest/tasks/scheduled/cancel?projectid=10002¬es=Approved+by+George
The PUT request would cancel the scheduled task and return the following JSON scheduled task object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"projectVersionName": "1.0.11",
"projectName": "Scheduled Tasks Project",
"workflowRequestId": 656423,
"projectId": 10002,
"scheduledDate": "2099-03-16 22:17:52.0",
"taskId": 14332,
"requestType": "Project",
"flexFields": [],
"environmentId": 77954,
"status": "REJECTED",
"notes": null"Approved by George"
} |
...