createSchedule
Create a new schedule.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
scheduleName | String | Name for the schedule; must be unique among all schedules for the project. (Required) |
actualParameters | ActualParameter array | Parameters passed to the invoked procedure/pipeline/process/release/workflow. |
applicationName | String | The name of the application that owns the process. |
applicationProjectName | String | Name for the project to which the application belongs to. |
beginDate | String | The date when this schedule will begin (for example, 2006-05-15). |
catalogItemName | String | Name of the catalog item to invoke. |
catalogName | String | Name of the catalog containing the catalog item to invoke. |
credentialName | String | The name of the credential to use for impersonation. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
endDate | String | The date when this schedule will end (for example, 2006-05-15). The end date is not included in the range of dates. |
environmentName | String | The name of the environment used to determine where to run the process. |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
environmentTemplateName | String | The name of the environment template used to determine the environment where to run the process. |
environmentTemplateProjectName | String | Name for the project to which the environment template belongs to. |
environmentTemplateTierMapName | String | The name of the environment template tier map used to determine how to spin up the environment which will be used to run the process. |
insertRollingDeployManualStep | Boolean | True to indicate a manual step needs to be injected after each phase or batch. |
interval | String | If specified, the procedure/pipeline/process/release/workflow will be rescheduled over and over again at intervals of this length. "Continuous" means reschedule the procedure/process/workflow as soon as the previous job finishes. |
intervalUnits | String | Units for the interval of rescheduling. |
misfirePolicy | String | Specifies the misfire policy for a schedule. |
monthDays | String | A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month. |
pipelineName | String | Name of the pipeline to invoke. |
pipelineParameters | PipelineParameter array | Pipeline parameters used by a release schedule to override the default parameters configured in the release |
pluginKey | String | Name for the project to which the schedule belongs to. |
priority | String | The priority of the job. |
procedureName | String | The name of the procedure to invoke. |
processName | String | The name of the application process to invoke. |
releaseName | String | Name of the release to invoke. |
rollingDeployEnabled | Boolean | Perform rolling deployment. |
rollingDeployManualStepAssignees | String array | A list of assignees who receive the notification when rolling deploy iteration completes. |
rollingDeployManualStepCondition | String | Defines run condition on manual step created during rolling deployment. |
rollingDeployPhases | String array | One or more rolling deploy phases to be used for deployment. |
scheduleDisabled | Boolean | If this box is "checked", the schedule will run. You can disable this schedule whenever necessary. |
snapshotName | String | The name of the snapshot to be used to invoke the application process. |
stagesToRun | String array | One or more stages to run in a pipeline. |
startTime | String | The time of day to begin invoking this schedule’s procedure/pipeline/process/release/workflow (24-hour clock, for example, 17:00). |
startingStage | String | Name of the starting stage in pipeline. |
startingStateName | String | The name of the starting state of the workflow. |
stopTime | String | The time of day to stop invoking this schedule’s procedure/pipeline/process/release/workflow (don’t start a new job after this time); time values use a 24-hour clock, for example, 17:00. |
subproject | String | Name for the project to which the schedule target object belongs to. |
tierMapName | String | The name of the tier map used to determine where to run the process. |
tierResourceCounts | TierResourceCount array | Resource count per resource template tier |
timeZone | String | The time zone to use when interpreting times. |
weekDays | String | Days of the week: any number of names such as Monday or Tuesday, separated by spaces |
workflowName | String | The name of the workflow to invoke. |
deleteSchedule
getRunSchedules
Return schedules.
Arguments
Argument Name | Type | Description |
---|---|---|
beginDate | String | Date of beginning reservation |
endDate | String | The date when reservation event ends |
filters | Filter array | Filters |
includeTimeslots | Boolean | Include timeslots in reservation response |
timeZone | String | The time zone to use when interpreting times. |
getSchedule
getSchedules
Retrieve all schedules in a project.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
applicationName | String | The name of the application that owns the process. |
applicationProjectName | String | Name for the project to which the application belongs to. |
catalogItemName | String | The name of the catalog item. |
catalogName | String | The name of the catalog. |
includeWorkflows | String | To include workflow related schedules |
pipelineName | String | The name of the pipeline. |
processName | String | The name of the application process. |
releaseName | String | The name of the release. |
tierMapName | String | The name of the tier map used to determine where to run the process. |
modifySchedule
Modify a schedule.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
scheduleName | String | Name for the schedule; must be unique among all schedules for the project. (Required) |
actualParameters | ActualParameter array | Parameters passed to the invoked procedure/pipeline/process/release/workflow. |
applicationName | String | The name of the application that owns the process. |
beginDate | String | The date when this schedule will begin (for example, 2006-05-15). |
catalogItemName | String | Name of the catalog item to invoke. |
catalogName | String | Name of the catalog containing the catalog item to invoke. |
clearActualParameters | Boolean | Whether or not to clear actual parameters for this object. |
clearPipelineParameters | Boolean | Whether or not to clear pipeline parameters for the schedule. |
credentialName | String | The name of the credential to use for impersonation. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
endDate | String | The date when this schedule will end (for example, 2006-05-15). The end date is not included in the range of dates. |
environmentName | String | The name of the environment used to determine where to run the process. |
environmentProjectName | String | Name for the project to which the environment or environment template belongs to. |
environmentTemplateName | String | The name of the environment template used to determine the environment where to run the process. |
environmentTemplateProjectName | String | Name for the project to which the environment template belongs to. |
environmentTemplateTierMapName | String | The name of the environment template tier map used to determine how to spin up the environment which will be used to run the process. |
insertRollingDeployManualStep | Boolean | True to indicate a manual step needs to be injected after each phase or batch. |
interval | String | If specified, the procedure/pipeline/process/release/workflow will be rescheduled over and over again at intervals of this length. "Continuous" means reschedule the procedure/process/workflow as soon as the previous job finishes. |
intervalUnits | String | Units for the interval of rescheduling. |
misfirePolicy | String | Specifies the misfire policy for a schedule. |
monthDays | String | A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month. |
newName | String | New name for an existing object that is being renamed. |
pipelineName | String | Name of the pipeline to invoke. |
pipelineParameters | PipelineParameter array | Pipeline parameters used by a release schedule to override the default parameters configured in the release |
pluginKey | String | Name for the project to which the schedule belongs to. |
priority | String | The priority of the job. |
procedureName | String | The name of the procedure to invoke. |
processName | String | The name of the application process to invoke. |
releaseName | String | Name of the release to invoke. |
rollingDeployEnabled | Boolean | Perform rolling deployment. |
rollingDeployManualStepAssignees | String array | A list of assignees who receive the notification when rolling deploy iteration completes. |
rollingDeployManualStepCondition | String | Defines run condition on manual step created during rolling deployment. |
rollingDeployPhases | String array | One or more rolling deploy phases to be used for deployment. |
scheduleDisabled | Boolean | If this box is "checked", the schedule will run. You can disable this schedule whenever necessary. |
snapshotName | String | The name of the snapshot to be used to invoke the application process. |
stagesToRun | String array | One or more stages to run in a pipeline. |
startTime | String | The time of day to begin invoking this schedule’s procedure/pipeline/process/release/workflow (24-hour clock, for example, 17:00). |
startingStage | String | Name of the starting stage in pipeline. |
startingStateName | String | The name of the starting state of the workflow. |
stopTime | String | The time of day to stop invoking this schedule’s procedure/pipeline/process/release/workflow (don’t start a new job after this time); time values use a 24-hour clock, for example, 17:00. |
subproject | String | Name for the project to which the schedule target object belongs to. |
tierMapName | String | The name of the tier map used to determine where to run the process. |
tierResourceCounts | TierResourceCount array | Resource count per resource template tier |
timeZone | String | The time zone to use when interpreting times. |
weekDays | String | Days of the week: any number of names such as Monday or Tuesday, separated by spaces |
workflowName | String | The name of the workflow to invoke. |