createReservation
Create a new reservation.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
reservationName | String | The name of the environment reservation. (Required) |
environmentName | String | The name of the environment. |
applicationName | String | The name of the application |
beginDate | String | Date of beginning reservation |
blackout | Boolean | Do now allow executions against an environment at specified period |
description | String | Comment text describing this object that is not interpreted at all by CloudBees Flow. |
endDate | String | The date when reservation event ends |
environmentProjectName | String | The name of the environment project name |
environmentTierName | String | The name of the environment tier. |
monthDays | String | A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month. |
overlap | Boolean | Allow to overlap the reservation |
pipelineName | String | The name of the pipeline |
recurrence | Boolean | Recurrence reservation |
recurrenceEndDate | String | Date of beginning reservation |
releaseName | String | The name of the release |
serviceName | String | The name of the service |
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 |
deleteReservation
getReservation
Retrieve an environment reservations by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
reservationName | String | The name of the environment reservation. (Required) |
beginDate | String | Date of beginning reservation |
endDate | String | The date when reservation event ends |
includeTimeslots | Boolean | Include timeslots in reservation response |
timeZone | String | The time zone to use when interpreting times. |
getReservations
Retrieve an environment m_reservation by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | Name for the project; must be unique among all projects. |
applicationName | String | The name of the application |
beginDate | String | Date of beginning reservation |
blackout | Boolean | Blackout reservations |
endDate | String | The date when reservation event ends |
environmentName | String | The name of the environment. |
environmentProjectName | String | The name of the environment project name |
environmentTierName | String | The name of the environment tier. |
includeTimeslots | Boolean | Include timeslots in reservation response |
pipelineName | String | The name of the pipeline |
releaseName | String | The name of the release |
reserverTypes | String array | Reserver types |
serviceName | String | The name of the service |
timeZone | String | The time zone to use when interpreting times. |
modifyReservation
Modify an reservation
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
reservationName | String | The name of the environment reservation. (Required) |
environmentName | String | The name of the environment. |
applicationName | String | The name of the application |
beginDate | String | Date of beginning reservation |
blackout | Boolean | Do now allow executions against an environment at specified period |
description | String | Comment text describing this object that is not interpreted at all by CloudBees Flow. |
endDate | String | The date when reservation event ends |
environmentProjectName | String | The name of the environment project name |
environmentTierName | String | The name of the environment tier. |
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. |
overlap | Boolean | Allow to overlap the reservation |
pipelineName | String | The name of the pipeline |
recurrence | Boolean | Recurrence reservation |
recurrenceEndDate | String | Date of beginning reservation |
releaseName | String | The name of the release |
serviceName | String | The name of the service |
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 |