Reservation

System Property

Type

Description

Changeable

Identity

Required for creation

system_id

int

Id of reservation


Yes


system_name

string

The name of the reservation

Yes


Yes

system_folder

Reference [type=Folder] (to be referenced as: system_folder.system_name)

The folder in which this entity is saved

 


Yes

system_maintype

string

The main type (Reservation)




system_custom_type

string

The custom type of the reservation.



For CSV format

system_type_version

string

The type version of the reservation




system_description

string

The description of the reservation

Yes



system_status

string

Status of the reservation.




system_owner

reference (to be referenced as: system_owner.system_name)

The owner of the reservation

Yes


Yes

system_planned_from

datetime

Planned date/time of the start of the reservation.

Note: Date/time format is set according to the display option defined in the user settings. Refresh the view or start a new session for display changes to take effect.

Yes


Yes

system_planned_to

datetime

Planned date/time of the end of the reservation.

Note: Date/time format is set according to the display option defined in the user settings. Refresh the view or start a new session for display changes to take effect.

Yes


Yes

system_environment

reference

[Type=Environment]

Reference to environment

Yes



system_archived Boolean Flag indicating whether the entity is archived or not. Yes    
system_planning_mode String

Indicator whether the reservation allows overlapping with other reservations or not. Possible values:

  • Shared (Default): Overlapping other Reservations are allowed
  • Exclusive: Overlapping other Reservations are prohibited
Yes    
system_validation_mode String

Defines how the Reservation acts in case that conflicting executions are planned. Possible values:

  • Approval (Default): An Approval Request is automatically generated and sent to the Reservation Team
  • Warning: Only a warning is displayed which can be confirmed (overridden in the API)
Yes    

Export

Export available, system_id is used as identifier.

Reporting

Main type and its custom types are available in reports.

You cannot add the following elements to a report definition as they are always added automatically:

  • system_id
  • system_custom_type (for custom-types of a main type only)
  • system_custom_type_version (for custom-types of a main type only)
  • system_date_changed
  • system_is_deleted