REST V1 Scheduled Task Response

REST V1 Scheduled Task Response

Response

Attributes

Type

Description

Attributes

Type

Description

taskId

Long

The task id of the scheduled task.

status

String

The status of the scheduled task.

scheduleDate

String

This is the scheduled date to run the scheduled task.

environmentId

Long

The environment Id of the scheduled task.

requestType

String

The request type of the scheduled task. The request type can be a step, gate, application, or project request.

flexFields

List<FlexField>

The list of flex fields for the scheduled task.

notes

String

Notes 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

Attributes

Type

Description

Attributes

Type

Description

snapshotId

Long

The snapshot id of the step scheduled task.

pipelineName

String

The pipeline name of the step scheduled task.

environmentName

String

The environment name of the step scheduled task.

stepName

String

The step name of the step scheduled task.

releaseName

String

The release name of the step scheduled task.

releaseId

Long

The release Id of the step scheduled task. 

snapshotName

String

The snapshot name of the step scheduled task.

pipelineStageStepExecId

Long

The pipeline stage step execution Id of the step scheduled task.

notes

String

Notes added when running or canceling the scheduled task.

Gate Scheduled Task

Attributes

Type

Description

Attributes

Type

Description

snapshotId

Long

The snapshot id of the gate scheduled task.

pipelineName

String

The pipeline name of the gate scheduled task.

environmentName

String

The environment name of the gate scheduled task.

gateName

String

The gate name of the gate scheduled task.

releaseName

String

The release name of the gate scheduled task.

releaseId

Long

The release Id of the gate scheduled task. 

snapshotName

String

The snapshot name of the gate scheduled task.

pipelineStageGateExecId

Long

The pipeline stage gate execution Id of the gate scheduled task.

notes

String

Notes added when running or canceling the scheduled task.

Application Scheduled Task

Attributes

Type

Description

Attributes

Type

Description

applicationId

Long

The application Id of the application scheduled task.

applicationName

String

The application name of the application scheduled task.

folderVersionName

String

The folder version name of the application scheduled task.

folderRequestId

Long

The folder request Id of the application scheduled task.

notes

String

Notes added when running or canceling the scheduled task.

Project Scheduled Task

Attributes

Type

Description

Attributes

Type

Description

projectId

Long

The project Id of the project scheduled task.

projectName

String

The project name of the project scheduled task.

projectVersionName

String

The project version name of the project scheduled task.

workflowRequestId

Long

The workflow request Id of the project scheduled task.

notes

String

Notes added when running or canceling the scheduled task.

The following macros are not currently supported in the footer:
  • style