Scheduled Tasks API

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.

Authentication - Use Basic Authentication for this API.

GET

GET by TaskId

This GET service will find a scheduled task with the given task Id and return the JSON representation of the object. 

Request

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return a scheduled task.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Task was found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Task not found
500Unexpected internal server error

Example

If we had a scheduled task in our database with an Id of 10000 and the following attributes

Scheduled Task - 10000
{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled/10000

The GET request would return the following JSON scheduled task object

Scheduled Task - 10000
{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

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.

API URLs

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

The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example.

Request

Parameter

Type

Required

Description

workflowRequestIdQuery - LongNoThis is a URL query parameter for the workflow request Id which is used to search the scheduled tasks.
folderRequestIdQuery - LongNoThis is a URL query parameter for the folder request Id which is used to search the scheduled tasks.
pipelineStageGateExecIdQuery - LongNoThis is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks.
pipelineStageStepExecIdQuery - LongNoThis is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks.
projectIdQuery - LongNoThis is a URL query parameter for the project Id which is used to search the scheduled tasks.
applicationIdQuery - LongNoThis is a URL query parameter for the application Id which is used to search the scheduled tasks.
environmentIdQuery - LongNoThis is a URL query parameter for the environment Id which is used to search the scheduled tasks.
notesQuery - StringNo

This is a URL query parameter for notes added to the task when running or canceling it.

Equals type search.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

scheduled Task
{
   "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": "PENDING",
   "notes": null
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled?projectid=10002

The GET request would return the  following JSON scheduled task object

Approval Task
{
   "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": "PENDING",
   "notes": null
}

Run Now By TaskId

This PUT service will run a scheduled task with the given Id.

Request

AttributesTypeRequiredDescription
IdLongYesThe Id of the scheduled task you wish to run
notesStringNoThis is a URL query parameter to add notes to the task when running it.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Task was found and schedule set to run immediately
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Task not found
500Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Approval Task
{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled/runnow/14332?notes=Approved+by+George

The PUT request would run the scheduled task and return the following JSON scheduled task object

Approval Task
{
   "projectVersionName": "1.0.11",
   "projectName": "Scheduled Tasks Project",
   "workflowRequestId": 656423,
   "projectId": 576267,
   "scheduledDate": "2099-03-16 22:17:52.0",
   "taskId": 14332,
   "requestType": "Project",
   "flexFields": [],
   "environmentId": 77954,
   "status": "APPROVED",
   "notes": "Approved by George"
}

Run Now using Query Parameters

This PUT service will run a scheduled task with the given attributes.

API URLs

http://host:port/flexdeploy/rest/v1/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 = {notes}

Returned Tasks

Only one scheduled task can be run at a time. If more than one task matches the query parameters an exception will be thrown.

Request

Parameter

Type

Required

Description

workflowRequestIdURLNoThis is a URL query parameter for the workflow request Id which is used to search the scheduled tasks.
folderRequestIdURLNoThis is a URL query parameter for the folder request Id which is used to search the scheduled tasks.
pipelineStageGateExecIdURLNoThis is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks.
pipelineStageStepExecIdURLNoThis is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks.
projectIdURLNoThis is a URL query parameter for the project Id which is used to search the scheduled tasks.
applicationIdURLNoThis is a URL query parameter for the application Id which is used to search the scheduled tasks.
environmentIdURLNoThis is a URL query parameter for the environment Id which is used to search the scheduled tasks.
notesURLNoThis is a URL query parameter to add notes to the task when running it.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Task was found and schedule set to run immediately
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Task not found
500Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Approval Task
{
   "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": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled/runnow?projectid=10002&notes=Approved+by+George

The PUT request would run the scheduled task and return the following JSON scheduled task object

Approval Task
{
   "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": "APPROVED",
   "notes": "Approved by George"
}

Cancel By TaskId

This PUT service will reject a scheduled task with the given Id.

Request

AttributesTypeRequiredDescription
IdLongYesThe Id of the scheduled task you wish to cancel
notesStringNoThis is a URL query parameter to add notes to the task when canceling it.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Task was found and cancelled
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Task not found
500Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Approval Task
{
   "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": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled/cancel/14332?notes=

The PUT request would cancel the scheduled task and return the following JSON scheduled task object

Approval Task
{
   "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
}

Cancel using Query Parameters

This PUT service will cancel a scheduled task with the given attributes.

API URLs

http://host:port/flexdeploy/rest/v1/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}

Returned Tasks

Only one scheduled task can be canceled at a time. If more than one task matches the query parameters an exception will be thrown.

Request

Parameter

Type

Required

Description

workflowRequestIdURLNoThis is a URL query parameter for the workflow request Id which is used to search the scheduled tasks.
folderRequestIdURLNoThis is a URL query parameter for the folder request Id which is used to search the scheduled tasks.
pipelineStageGateExecIdURLNoThis is a URL query parameter for the pipeline stage gate execution Id which is used to search the scheduled tasks.
pipelineStageStepExecIdURLNoThis is a URL query parameter for the pipeline stage step execution Id which is used to search the scheduled tasks.
projectIdURLNoThis is a URL query parameter for the project Id which is used to search the scheduled tasks.
applicationIdURLNoThis is a URL query parameter for the application Id which is used to search the scheduled tasks.
environmentIdURLNoThis is a URL query parameter for the environment Id which is used to search the scheduled tasks.
notesURLNoThis is a URL query parameter to add notes to the task when canceling it.

Response

AttributesTypeDescription
taskIdLongThe task id of the scheduled task.
statusStringThe status of the scheduled task.
scheduleDateStringThis is the scheduled date to run the scheduled task.
environmentIdLongThe environment Id of the scheduled task.
requestTypeStringThe request type of the scheduled task. The request type can be a step, gate, application, or project request.
flexFieldsList<FlexField>The list of flex fields for the scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Each scheduled task can be one of four different types: Step, Gate, Application, and Project.

Step Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the step scheduled task.
pipelineNameStringThe pipeline name of the step scheduled task.
environmentNameStringThe environment name of the step scheduled task.
stepNameStringThe step name of the step scheduled task.
releaseNameStringThe release name of the step scheduled task.
releaseIdLongThe release Id of the step scheduled task. 
snapshotNameStringThe snapshot name of the step scheduled task.
pipelineStageStepExecIdLongThe pipeline stage step execution Id of the step scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Gate Scheduled Task

AttributesTypeDescription
snapshotIdLongThe snapshot id of the gate scheduled task.
pipelineNameStringThe pipeline name of the gate scheduled task.
environmentNameStringThe environment name of the gate scheduled task.
gateNameStringThe gate name of the gate scheduled task.
releaseNameStringThe release name of the gate scheduled task.
releaseIdLongThe release Id of the gate scheduled task. 
snapshotNameStringThe snapshot name of the gate scheduled task.
pipelineStageGateExecIdLongThe pipeline stage gate execution Id of the gate scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Application Scheduled Task

AttributesTypeDescription
applicationIdLongThe application Id of the application scheduled task.
applicationNameStringThe application name of the application scheduled task.
folderVersionNameStringThe folder version name of the application scheduled task.
folderRequestIdLong

The folder request Id of the application scheduled task.

notesStringNotes added when running or canceling the scheduled task.

Project Scheduled Task

AttributesTypeDescription
projectIdLongThe project Id of the project scheduled task.
projectNameStringThe project name of the project scheduled task.
projectVersionNameStringThe project version name of the project scheduled task.
workflowRequestIdLongThe workflow request Id of the project scheduled task.
notesStringNotes added when running or canceling the scheduled task.

Response Codes

HTTP CodeDescription
200Task was found and cancelled
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Task not found
500Unexpected internal server error

Example

If we had a scheduled task in our database with the following attributes

Approval Task
{
   "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": "PENDING",
   "notes": null
}

When we run a PUT request at the following URL

http://host:port/flexdeploy/rest/v1/tasks/scheduled/cancel?projectid=10002&notes=Approved+by+George

The PUT request would cancel the scheduled task and return the following JSON scheduled task object

Approval Task
{
   "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": "Approved by George"
}