REST V1 Scheduled Task Response

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.