| \n\nresult\n\n | \n\nReturn results for the requested recurring reservation.Data type: Object\n\n```\n\"result\": {\n \"occurencesTotalCount\": \"String\",\n \"reservation\": {Object}\n}\n```\n\n |
| \n\nresult.occurencesTotalCount\n\n | \n\nTotal number of meeting occurrences in the recurring series.Data type: String\n\n |
| \n\nresult.reservation\n\n | \n\nDetails about the requested recurring reservation.Data type: Object\n\n```\n\"reservation\": {\n \"active\": Boolean,\n \"attendees\": [Array],\n \"check_in_state\": {Object},\n \"edit_restriction\": {Object},\n \"end\": \"String\",\n \"external_ical\": \"String\",\n \"external_id\": \"String\",\n \"is_parent\": Boolean,\n \"last_updated_sub_source\": {Object},\n \"location\": {Object},\n \"notification_custom_message\": \"String\",\n \"notification_recipients\": [Array],\n \"number\": \"String\",\n \"number_of_attendees\": Number,\n \"opened_by\": {Object},\n \"recording_details\": [Array],\n \"recurring_pattern\": {Object},\n \"requested_for\": {Object},\n \"reservable_module\": {Object},\n \"sensitivity\": {Object},\n \"shift\": {Object},\n \"source\": {Object},\n \"source_icon\": {Object},\n \"source_reservation\": {Object},\n \"source_reservation_requester\": {Object},\n \"start\": \"String\",\n \"state\": {Object},\n \"subject\": \"String\",\n \"sub_source\": {Object},\n \"sync_state\": {Object},\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_on\": \"String\",\n \"virtual_meeting\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.active\n\n | \n\nFlag that indicates whether the reservation is active.Valid values:\n\n- true: Reservation is active.\n- false: Reservation is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.attendees\n\n | \n\nList of attendees for the reservation.Data type: Array of Objects\n\n```\n\"attendees\": [\n {\n \"avatar\": \"String\",\n \"displayValue\": \"String\",\n \"display_value\": \"String\",\n \"email\": \"String\",\n \"initials\": \"String\",\n \"label\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"table\": \"String\",\n \"user_name\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.reservation.attendees.avatar\n\n | \n\nSys\\_id of the avatar associated with the attendee.Data type: String\n\nTable: Attachments \\[sys\\_attachment\\]\n\n |
| \n\nresult.reservation.attendees.displayValue\n\n | \n\nDisplay value for the attendee.Data type: String\n\n |
| \n\nresult.reservation.attendees.display\\_value\n\n | \n\nDisplay value of the attendee. Same as **displayValue**.Data type: String\n\n |
| \n\nresult.reservation.attendees.email\n\n | \n\nAttendee's email address.Data type: String\n\n |
| \n\nresult.reservation.attendees.initials\n\n | \n\nAttendee's initials.Data type: String\n\n |
| \n\nresult.reservation.attendees.name\n\n | \n\nAttendee's name.Data type: String\n\n |
| \n\nresult.reservation.attendees.sys\\_id\n\n | \n\nSys\\_id of the attendee record.Data type: String\n\n |
| \n\nresult.reservation.attendees.table\n\n | \n\nTable in which the attendee record exists.Data type: String\n\n |
| \n\nresult.reservation.attendees.user\\_name\n\n | \n\nAttendee's user name.Data type: String\n\n |
| \n\nresult.reservation.attendees.value\n\n | \n\nInternal value of the attendee.Data type: String\n\n |
| \n\nresult.reservation.check\\_in\\_state\n\n | \n\nDetails about the check-in state of the reservation.Data type: Object\n\n```\n\"check_in_state\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.check\\_in\\_state.display\\_value\n\n | \n\nDisplay value for the current check-in state of the reservation, such as In progress or complete.Data type: String\n\n |
| \n\nresult.reservation.check\\_in\\_state.value\n\n | \n\nInternal value for the current check-in state of the reservation, such as 2.Data type: String\n\n |
| \n\nresult.reservation.edit\\_restriction\n\n | \n\nDescription of the user edit restrictions for the reservation, such as no\\_restrictions, service\\_only, or fully\\_restricted.Data type: Object\n\n```\n\"edit_restriction\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.edit\\_restriction.display\\_value\n\n | \n\nDisplay value for the edit restrictions for the reservation, such as `No restriction`.Data type: String\n\n |
| \n\nresult.reservation.edit\\_restriction.value\n\n | \n\nInternal value for the edit restrictions for the reservation, such as `no_restriction`.Data type: String\n\n |
| \n\nresult.reservation.end\n\n | \n\nReservation end date and time.Data type: String\n\nFormat: UTC: yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z\n\n |
| \n\nresult.reservation.external\\_ical\n\n | \n\nUnique external iCalendar identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String\n\n |
| \n\nresult.reservation.external\\_id\n\n | \n\nUnique external identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String\n\n |
| \n\nresult.reservation.is\\_parent\n\n | \n\nFlag that indicates whether this reservation is a parent reservation.Possible values:\n\n- true: Parent reservation.\n- false: Not a parent reservation.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.last\\_updated\\_sub\\_source\n\n | \n\nDetails about the last updated sub-source for the reservation. Sub-sources are used when integrating reservations with an external calendar. This object contains information such as \"servicenow\\_workplace\\_service\\_delivery\", \"google\\_calendar\", or \"microsoft\\_exchange\".Data type: Object\n\n```\n\"last_updated_sub_source\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.last\\_updated\\_sub\\_source.display\\_value\n\n | \n\nDisplay value for the last updated sub-source of the reservation, such as `ServiceNow Workplace Service Delivery` or `Google Calendar`. Used when integrating the reservation with an outside service such as Google calendar or Microsoft Outlook.Data type: String\n\n |
| \n\nresult.reservation.last\\_updated\\_sub\\_source.value\n\n | \n\nInternal value for the last updated sub-source of the reservation, such as `servicenow_workplace_service_delivery` or `google_calendar`. Used when integrating the reservation with an outside service such as Google calendar or Microsoft Outlook.Data type: String\n\n |
| \n\nresult.reservation.location\n\n | \n\nDetails about the location associated with the reservation.Data type: Object\n\n```\n\"location\": {\n \"area\": {Object},\n \"building\": {Object},\n \"campus\": {Object},\n \"capacity\": Number,\n \"description\": \"String\",\n \"display_value\": \"String\",\n \"email\": \"String\",\n \"floor\": {Object},\n \"label_value\": \"String\",\n \"name\": \"String\",\n \"number\": \"String\",\n \"number_of_attendees\": Boolean,\n \"region\": {Object},\n \"requested_for\": {Object},\n \"reservable_module\": {Object},\n \"reservation\": {Object},\n \"site\": {Object},\n \"state\": {Object},\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.area\n\n | \n\nDetails about the area associated with the location.Data type: Object\n\n```\n\"area\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.area.active\n\n | \n\nFlag that indicates whether the area is active.Valid values:\n\n- true: Area is active.\n- false: Area is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.area.display\\_value\n\n | \n\nDisplay value of the area to which this location belongs, such as Desk A2.Data type: String\n\n |
| \n\nresult.reservation.location.area.sys\\_id\n\n | \n\nSys\\_id of the area to which this location belongs.Data type: String\n\nTable: Area \\[sn\\_wsd\\_core\\_area\\]\n\n |
| \n\nresult.reservation.location.building\n\n | \n\nDetails about the building associated with the location.Data type: Object\n\n```\n\"building\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\",\n \"timezone\": {Object}\n}\n```\n\n |
| \n\nresult.reservation.location.building.active\n\n | \n\nFlag that indicates whether the building is active.Valid values:\n\n- true: Building is active.\n- false: Building is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.building.display\\_value\n\n | \n\nDisplay value of the building to which this location belongs, such as AMS - Bld1.Data type: String\n\n |
| \n\nresult.reservation.location.building.sys\\_id\n\n | \n\nSys\\_id of the building to which this location belongs.Data type: String\n\nTable: Building \\[sn\\_wsd\\_core\\_building\\]\n\n |
| \n\nresult.reservation.location.building.timezone\n\n | \n\nDetails of the time zone for the building.Data type: Object\n\n```\n\"timezone\": {\n \"displayValue\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.building.timezone.display\\_value\n\n | \n\nDisplay value of the time zone in which the associated building resides.Data type: String\n\n |
| \n\nresult.reservation.location.building.timezone.value\n\n | \n\nInternal value for the time zone to which this location belongs.Data type: String\n\n |
| \n\nresult.reservation.location.campus\n\n | \n\nDetails about the campus associated with the location.Data type: Object\n\n```\n\"campus\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.campus.active\n\n | \n\nFlag that indicates whether the campus is active.Valid values:\n\n- true: Campus is active.\n- false: Campus is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.campus.display\\_value\n\n | \n\nDisplay value of the campus to which this location belongs, such as Amsterdam Campus.Data type: String\n\n |
| \n\nresult.reservation.location.campus.sys\\_id\n\n | \n\nSys\\_id of the campus to which this location belongs.Data type: String\n\nTable: Campus \\[sn\\_wsd\\_core\\_campus\\]\n\n |
| \n\nresult.reservation.location.capacity\n\n | \n\nMaximum number of occupants for the location.Data type: Number\n\n |
| \n\nresult.reservation.location.description\n\n | \n\nBrief description of the location.Data type: String\n\n |
| \n\nresult.reservation.location.display\\_value\n\n | \n\nValue to display in the UI for this location.Data type: String\n\n |
| \n\nresult.reservation.location.email\n\n | \n\nEmail address for the location.Data type: String\n\n |
| \n\nresult.reservation.location.floor\n\n | \n\nDetails about the floor associated with the location.Data type: Object\n\n```\n\"floor\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.floor.active\n\n | \n\nFlag that indicates whether the floor is active.Valid values:\n\n- true: Floor is active.\n- false: Floor is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.floor.display\\_value\n\n | \n\nDisplay value of the floor to which this location belongs, such as First floor.Data type: String\n\n |
| \n\nresult.reservation.location.floor.sys\\_id\n\n | \n\nSys\\_id of the floor to which this location belongs.Data type: String\n\nTable: Floor \\[sn\\_wsd\\_core\\_floor\\]\n\n |
| \n\nresult.reservation.location.label\\_value\n\n | \n\nType of value specified in the **name** parameter, such as Room name.Data type: String\n\n |
| \n\nresult.reservation.location.name\n\n | \n\nName of the location.Data type: String\n\n |
| \n\nresult.reservation.location.number\n\n | \n\nReservation number.Data type: String\n\n |
| \n\nresult.reservation.location.number\\_of\\_attendees\n\n | \n\nNumber of attendees for the reservation.Data type: Number\n\n |
| \n\nresult.reservation.location.reservable\\_module\n\n | \n\nDetails about the reservable module associated with the reservation.Data type: Object\n\n```\n\"reservable_module\": {\n \"inline_title\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"title\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.reservable\\_module.inline\\_title\n\n | \n\nInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String\n\n |
| \n\nresult.reservation.location.reservable\\_module.name\n\n | \n\nName of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.location.reservable\\_module.sys\\_id\n\n | \n\nSys\\_id of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.location.reservable\\_module.title\n\n | \n\nTitle of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.location.region\n\n | \n\nDetails about the region associated with the location.Data type: Object\n\n```\n\"region\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.region.active\n\n | \n\nFlag that indicates whether the region is active.Valid values:\n\n- true: Region is active.\n- false: Region is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.region.display\\_value\n\n | \n\nDisplay value of the region to which this location belongs, such as Europe.Data type: String\n\n |
| \n\nresult.reservation.location.region.sys\\_id\n\n | \n\nSys\\_id of the region to which this location belongs.Data type: String\n\nTable: Region \\[sn\\_wsd\\_core\\_region\\]\n\n |
| \n\nresult.reservation.location.reservation\n\n | \n\nDetails about the reservation associated with the location.Data type: Object\n\n```\n\"reservation\": {\n \"active\": Boolean,\n \"number\": \"String\",\n \"number_of_attendees\": Number,\n \"requested_for\": {Object},\n \"state\": {Object},\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.reservation.active\n\n | \n\nFlag that indicates whether the reservation is active.Valid values:\n\n- true: Reservation is active.\n- false: Reservation is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.reservation.number\n\n | \n\nReservation number.Data type: String\n\n |
| \n\nresult.reservation.location.reservation.number\\_of\\_attendees\n\n | \n\nNumber of attendees of the reservation.Data type: Number\n\n |
| \n\nresult.reservation.location.reservation.requested\\_for\n\n | \n\nDetails about the person for whom the reservation was requested on behalf of.Data type: Object\n\n```\n\"requested_for\": {\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"user_name\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.reservation.requested\\_for.name\n\n | \n\nName of the user for whom the reservation was requested for.Data type: String\n\n |
| \n\nresult.reservation.location.reservation.requested\\_for.sys\\_id\n\n | \n\nSys\\_id of the requested for user.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nresult.reservation.location.reservation.requested\\_for.user\\_name\n\n | \n\nUser name of the user for whom the reservation was requested for.Data type: String\n\n |
| \n\nresult.reservation.location.reservation.state\n\n | \n\nDetails about the state of the reservation for the location.Data type: Object\n\n```\n\"state\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.reservation..state.display\\_value\n\n | \n\nDisplay value for the current state of the reservation, such as confirmed.Data type: String\n\n |
| \n\nresult.reservation.location.reservation..state.value\n\n | \n\nInternal value for the current state of the reservation, such as 2.Data type: String\n\n |
| \n\nresult.reservation.location.site\n\n | \n\nSite to which the location belongs.Data type: Object\n\n```\n\"site\": {\n \"active\": Boolean,\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\nTable: Site \\[sn\\_wsd\\_core\\_site\\]\n\n |
| \n\nresult.reservation.location.site.active\n\n | \n\nFlag that indicates whether the site is active.Valid values:\n\n- true: Site is active.\n- false: Site is inactive.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.location.site.display\\_value\n\n | \n\nDisplay value of the site to which this location belongs, such as Western Europe.Data type: String\n\n |
| \n\nresult.reservation.location.site.sys\\_id\n\n | \n\nSys\\_id of the site to which this location belongs.Data type: String\n\nTable: Site \\[sn\\_wsd\\_core\\_site\\]\n\n |
| \n\nresult.reservation.location.standard\\_services\n\n | \n\nStandard available services.Data type: String\n\n |
| \n\nresult.reservation.location.state\n\n | \n\nDetails about the state of the reservation for the location.Data type: Object\n\n```\n\"state\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.location.state.display\\_value\n\n | \n\nDisplay value for the current state of the reservation, such as confirmed.Data type: String\n\n |
| \n\nresult.reservation.location.state.value\n\n | \n\nInternal value for the current state of the reservation, such as 2.Data type: String\n\n |
| \n\nresult.reservation.location.sys\\_id\n\n | \n\nSys\\_id of the associated location record.Data type: String\n\nTable: Workplace Location \\[sn\\_wsd\\_core\\_workplace\\_location\\]\n\n |
| \n\nresult.reservation.notification\\_custom\\_message\n\n | \n\nCustom message for the notification sent to the recipients listed in **reservation.notification\\_recipients**.Data type: String\n\n |
| \n\nresult.reservation.notification\\_recipients\n\n | \n\nList of recipients that receive notification about the reservation.Data type: Array of Objects\n\n```\n\"notification_recipients\":[\n {\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"user_name\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.reservation.notification\\_recipients.name\n\n | \n\nName of the recipient.Data type: String\n\n |
| \n\nresult.reservation.notification\\_recipients.sys\\_id\n\n | \n\nSys\\_id of the recipient.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nresult.reservation.notification\\_recipients.user\\_name\n\n | \n\nUser name of the recipient.Data type: String\n\n |
| \n\nresult.reservation.number\n\n | \n\nUnique number of the reservation record. You can use this value to query the reservation.Data type: String\n\nTable: Workplace Reservation \\[sn\\_wsd\\_rsv\\_reservation\\]\n\n |
| \n\nresult.reservation.number\\_of\\_attendees\n\n | \n\nNumber of attendees in this reservation.Data type: Number\n\n |
| \n\nresult.reservation.opened\\_by\n\n | \n\nDetails about the user that created the reservation.Data type: Object\n\n```\n\"opened_by\": {\n \"avatar\": \"String\",\n \"displayValue\": \"String\",\n \"display_value\": \"String\",\n \"email\": \"String\",\n \"initials\": \"String\",\n \"label\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"table\": \"String\",\n \"user_name\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.opened\\_by.avatar\n\n | \n\nAvatar for the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.displayValue\n\n | \n\nDisplay value of the opened by user.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.display\\_value\n\n | \n\nDisplay value of the opened by user.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.email\n\n | \n\nEmail address for the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.initials\n\n | \n\nInitials of the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.name\n\n | \n\nName of the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.user\\_name\n\n | \n\nUser name of the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.opened\\_by.value\n\n | \n\nInternal value of the user that opened the reservation.Data type: String\n\n |
| \n\nresult.reservation.recording\\_details\n\n | \n\nDetails about the recordings associated with the reservation \\(meeting\\).Data type: Array of Objects\n\n```\n\"recording_details\": [\n \"recording_url\": \"String\"\n]\n```\n\n |
| \n\nresult.reservation.recording\\_details.recording\\_url\n\n | \n\nURL of the recordings associated with the reservation.Data type: String\n\n |
| \n\nresult.reservation.recurring\\_pattern\n\n | \n\nDetails about the recurring pattern for the reservation.Data type: Object\n\n```\n\"recurring_pattern\": {\n \"amountOfDates\": \"String\",\n \"duration\": Number,\n \"label\": \"String\",\n \"options\": {Object},\n \"repeats\": \"String\",\n \"startDate\":\"String\",\n \"startDateGdt\": {Object}\n}\n```\n\n |
| \n\nresult.reservation.recurring\\_pattern.amountOfDates\n\n | \n\nNumber of dates for which the reservables are reserved.Data type: String\n\n |
| \n\nresult.reservation.recurring\\_pattern.duration\n\n | \n\nLength of time to reserve the reservable.\n\nData type: Number\n\nUnit: Seconds\n\n |
| \n\nresult.reservation.recurring\\_pattern.label\n\n | \n\nDescriptive name for the recurring reservation.Data type: String\n\n |
| \n\nresult.reservation.recurring\\_pattern.options\n\n | \n\nDetails about the options associated with the recurring reservation.Data type: Object\n\n```\n\"options\": {\n \"count\": Number,\n \"daysOfWeek\": \"String\",\n \"every\": Number,\n \"endDate\": \"String\"\n \"endDateGdt\": {Object}\n}\n```\n\n |
| \n\nresult.reservation.recurring\\_pattern.options.count\n\n | \n\nNumber of times to repeat the pattern.\n\nData type: Number\n\n |
| \n\nresult.reservation.recurring\\_pattern.options.daysOfWeek\n\n | \n\nDays of the week that the reservable is needed.\n\nValid values:\n\n- 1 = Monday\n- 2 = Tuesday\n- 3 = Wednesday\n- 4 = Thursday\n- 5 = Friday\n- 6 = Saturday\n- 7 = Sunday\n\nFor example, to specify Tuesday, Thursday, and Friday, pass 245 \\(no delimiter\\). If **repeats** is `weekly`, **count** is `5`, and **daysOfWeek** is`245`, then in the return results, the total is equal to `count*daysOfWeek.length` \\(5\\*3=15\\).\n\nData type: String\n\n |
| \n\nresult.reservation.recurring\\_pattern.options.every\n\n | \n\nPattern repeat interval. For example, the value '2' indicates that the pattern repeats every 2 days or 2 months depending on the value of the **repeats** property.**Note:** This setting is not applicable to weekly repeat intervals. You can set the **repeats** property to `daily` and this value to `14` for biweekly repeat intervals.\n\nData type: Number\n\nDefault value: 1\n\n |
| \n\nresult.reservation.recurring\\_pattern.options.endDate\n\n | \n\nEnd date and time of the recurrence of the meeting, such as \"2022-07-08T14:00:00Z\".Data type: String\n\nFormat: UTC yyyy-mm-dd hh:mm:ss\n\n |
| \n\nresult.reservation.recurring\\_pattern.options.endDateGdt\n\n | \n\nEnd date and time of the recurrence of the meeting.Data type: String\n\nFormat: GDT, such as \"2022-07-08T14:00:00Z\"\n\n |
| \n\nresult.reservation.recurring\\_pattern.repeats\n\n | \n\nRepeating pattern for the reservable.\n\nValid values: \\(case-sensitive\\)\n\n- daily\n- monthly\n- weekly\n\n**Note:** The pattern repeat interval is set in the **options.every** property. The only valid repeat interval for weekly patterns is one.\n\nData type: String\n\n |
| \n\nresult.reservation.recurring\\_pattern.startDate\n\n | \n\nStart date and time for the recurring pattern, such as \"2022-07-08T14:00:00Z\".\n\nData type: String\n\nFormat: UTC yyyy-mm-dd hh:mm:ss\n\n |
| \n\nresult.reservation.recurring\\_pattern.startDateGdt\n\n | \n\nStart date and time for the recurring pattern, such as \"2022-07-08T14:00:00Z\".\n\nData type: String\n\nFormat: UTC yyyy-mm-dd hh:mm:ss\n\n |
| \n\nresult.reservation.requested\\_for\n\n | \n\nDetails about the user that the reservation was made on behalf of.Data type: Object\n\n```\n\"requested_for\": {\n \"avatar\": \"String\",\n \"displayValue\": \"String\",\n \"display_value\": \"String\",\n \"email\": \"String\",\n \"initials\": \"String\",\n \"label\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"table\": \"String\",\n \"user_name\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.requested\\_for.avatar\n\n | \n\nAvatar for the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.displayValue\n\n | \n\nDisplay value of the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.display\\_value\n\n | \n\nDisplay value of the user that the reservation was made on behalf of. Same as displayValue.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.email\n\n | \n\nEmail address for the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.initials\n\n | \n\nInitials of the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.label\n\n | \n\nLabel for the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.name\n\n | \n\nName of the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.rservation.requested\\_for.sys\\_id\n\n | \n\nSys\\_id\\_of the user that the reservation was made on behalf of.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nresult.rservation.requested\\_for.table\n\n | \n\nTable that contains the user record.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.user\\_name\n\n | \n\nUser name of the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.requested\\_for.value\n\n | \n\nInternal value of the user that the reservation was made on behalf of.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module\n\n | \n\nDetails for the requested reservable module.Data type: Object\n\n```\n\"reservable_module\": {\n \"allow_invitees\": Boolean,\n \"allow_whole_day\": Boolean,\n \"apply_to_shift\": Boolean,\n \"browse_by_area_enabled\": Boolean,\n \"browse_near_a_person_enabled\": Boolean,\n \"buildingSysIds\": [Array],\n \"checkin_before_minutes\": Number,\n \"display_number_of_attendees\": Boolean,\n \"display_on_behalf_of\": Boolean,\n \"display_sensitivity\": Boolean,\n \"display_value\": \"String\",\n \"enable_browse_by_area\": Boolean,\n \"enable_browse_near_a_person\": Boolean,\n \"enable_facet_filter\": Boolean,\n \"enable_group_reservations\": Boolean,\n \"enable_ical_generation\": Boolean,\n \"font_awesome_icon\": \"String\",\n \"inline_title\": \"String\", \n \"layout_mapping\": {Object},\n \"max_days_in_future\": Number,\n \"max_occurrences\": Number,\n \"name\": \"String\",\n \"override_approval_policy\": \"String\",\n \"require_cancel_notes\": Boolean,\n \"require_cc_dept_check\": Boolean,\n \"require_subject\": Boolean,\n \"reservable_columns\": [Array],\n \"reservable_container_field\": \"String\",\n \"reservable_filter\": \"String\",\n \"reservable_quantity_field\": \"String\",\n \"reservable_table\": \"String\",\n \"reservable_type\": \"String\",\n \"reservable_views\": [Array],\n \"reservation_paths\": [Array],\n \"search_limit\": Number,\n \"selection_type\": \"String\",\n \"short_description\": \"String\",\n \"show_map_view\": Boolean,\n \"sys_id\": \"String\",\n \"timeSlots\": [Array],\n \"title\": \"String\",\n \"virtual_meeting_provider\": {Object}\n}\n```\n\n |
| \n\nresult.reservation.reservable\\_module.allow\\_invitees\n\n | \n\nFlag that indicates whether employees are able to add invitees to the reservation. Valid values:\n\n- true: Allow employees to add invitees to the reservation.\n- false: Don't allow employees to add invitees to the reservation.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.allow\\_whole\\_day\n\n | \n\nFlag that indicates whether users can reserve the reservable for the entire day. Valid values:\n\n- true: Allow users to reserve for the entire day.\n- false: Don't allow users to reserve for the entire day.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.apply\\_to\\_shift\n\n | \n\nFlag that indicates whether shift-based reservations are enabled for the reservable module. Valid values:\n\n- true: Allow shift-based reservations.\n- false: Don't allow shift-based reservations.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.browse\\_by\\_area\\_enabled\n\n | \n\nFlag that indicates whether users are able to search for reservable modules by area.Valid values:\n\n- true: Allow users to browse reservable modules by area.\n- false: Don't allow users to browse reservable modules by area.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.browse\\_near\\_a\\_person\\_enabled\n\n | \n\nFlag that indicates whether users are able to search for reservable modules located by a specified person.Valid values:\n\n- true: Allow users to browse reservable modules near a person.\n- false: Don't allow users to browse reservable modules near a person.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.buildingSysIds\n\n | \n\nList of sys\\_ids of the buildings associated with the reservable module.Data type: Array of Strings\n\n |
| \n\nresult.reservation.reservable\\_module.checkin\\_before\\_minutes\n\n | \n\nAmount of time before a reservation starts that a user can check into their reservation.Unit: Minutes\n\nData type: Number\n\n |
| \n\nresult.reservation.reservable\\_module.display\\_number\\_of\\_attendees\n\n | \n\nFlag that indicates whether users can specify the number of attendees in the reservation. Valid values:\n\n- true: Users can specify the number of attendees.\n- false: Users can't specify the display number of attendees.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.display\\_on\\_behalf\\_of\n\n | \n\nFlag that indicates whether reservations can be made on behalf of someone else. Valid values:\n\n- true: On behalf of supported.\n- false: On behalf of not supported.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.display\\_sensitivity\n\n | \n\nFlag that indicates whether users can set the sensitivity of the reservation, such as normal or private.Valid values:\n\n- true: Able to set sensitivity.\n- false: Not able to set sensitivity. Defaults to normal.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.display\\_value\n\n | \n\nDisplay value of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.enable\\_browse\\_by\\_area\n\n | \n\nFlag that indicates whether users are able to search for reservable modules by area. Same as **browse\\_by\\_area\\_enabled**.Valid values:\n\n- true: Allow users to browse reservable modules by area.\n- false: Don't allow users to browse reservable modules by area.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.enable\\_browse\\_near\\_a\\_person\n\n | \n\nFlag that indicates whether users are able to search for reservable modules located by a specified person. Same as**browse\\_near\\_a\\_person\\_enabled**.Valid values:\n\n- true: Allow users to browse reservable modules near a person.\n- false: Don't allow users to browse reservable modules near a person.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.enable\\_facet\\_filter\n\n | \n\nFlag that indicates whether facet filtering on workplace items is enabled. When enabled, the filter options that appear are based on the search results. Only the items that are available in the generated search result are available to users for selection in the filter.Valid values:\n\n- true: Facet filters are enabled.\n- false: Facet filters aren't enabled.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.enable\\_group\\_reservations\n\n | \n\nFlag that indicates whether users can make a group reservation.Valid values:\n\n- true: Able to make group reservations.\n- false: Not able to make group reservations.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.enable\\_ical\\_generation\n\n | \n\nFlag that indicates whether users can generate an iCalendar for the reservation.Valid values:\n\n- true: iCalendar generation allowed.\n- false: iCalendar generation isn't allowed.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.font\\_awesome\\_icon\n\n | \n\nName of the font icon attached to the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.inline\\_title\n\n | \n\nInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping\n\n | \n\nDetails about the structure of the layout mapping of locations. Use this data to lay out the information in the UI. Data type: Object\n\n```\n\"layout_mapping\": {\n \"body\": [Array],\n \"description\": [Array],\n \"image\": \"String\",\n \"subtitle\": [Array],\n \"subtitle_asc\": [Array],\n \"title\": [Array]\n}\n```\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.body\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: Array of Objects\n\n```\n\"body\": [\n {\n \"field\": \"String\",\n \"field_to_display\": \"String\",\n \"icon\": \"String\",\n \"label\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.body.field\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.body.field\\_to\\_display\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.body.icon\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.body.label\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.description\n\n | \n\nPlaceholder for mapping the front-end UI data. Description of the layout mapping.Data type: Array\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.image\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.subtitle\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: Array\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.subtitle\\_asc\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: Array\n\n |
| \n\nresult.reservation.reservable\\_module.layout\\_mapping.title\n\n | \n\nPlaceholder for mapping the front-end UI data.Data type: Array\n\n |
| \n\nresult.reservation.reservable\\_module.max\\_days\\_in\\_future\n\n | \n\nMaximum number of the days in the future that a user can reserve the reservable module.Data type: Number\n\n |
| \n\nresult.reservation.reservable\\_module.max\\_occurrences\n\n | \n\nMaximum number of recurring reservation occurrences if recurring reservations are available for the reservable module.Data type: Number\n\n |
| \n\nresult.reservation.reservable\\_module.name\n\n | \n\nName of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.override\\_approval\\_policy\n\n | \n\nOption to specify how to implement the approval policy. Choices:\n\n- No override: The approval policy is implemented as set in the **Requires approval** field of a workplace space or room.\n- Always require approval: The approval policy is required regardless of what is set in the **Requires approval** field of a workplace space or room.\n- Never require approval: The approval policy is removed regardless of what is set in the **Requires approval**l field of a workplace space or room.\n\nData type: String\n\n |
| \n\nresult.reservation.reservable\\_module.require\\_cancel\\_notes\n\n | \n\nFlag that indicates whether users must enter a cancellation note before cancelling a reservable module.Valid values:\n\n- true: Cancellation note required.\n- false: Cancellation note not required.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.require\\_cc\\_dept\\_check\n\n | \n\nFlag that indicates whether to check if there's a cost center or department mismatch between the workspace item and the logged in user. Valid values:\n\n- true: Check for a mismatch.\n- false: Don't check for a mismatch.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.require\\_subject\n\n | \n\nFlag that indicates whether the user must enter a subject when making the reservation.Valid values:\n\n- true: Subject required.\n- false: Subject isn't required.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_columns\n\n | \n\nList of the columns of a reservable.Data type: Array\n\nTable: Workplace Location \\[sn\\_wsd\\_core\\_workplace\\_location\\]\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_container\\_field\n\n | \n\nLevel of the container, such as a group of desks in a specific area.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_filter\n\n | \n\nFilter conditions used to filter out reservable items in the associated Reservable table. Reservable table is a field in the Reservable Module \\[sn\\_wsd\\_rsv\\_reservable\\_module\\] table. These filter conditions were applied to the table contained in the field Reservable table.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_quantity\\_field\n\n | \n\nReservable quantity of all the spaces. The quantity is used when assigning neighbourhood spaces to an area. For additional information, see [Assign neighborhood spaces to an area](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/employee-service-management/add-neighbourhood-spaces-to-an-area.md).Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_table\n\n | \n\nTable that contains the reservable workplace items.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_type\n\n | \n\nType of the reservable item, such as location.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views\n\n | \n\nDetails about the different views associated with the reservable module, such as card view or schedule view.Data type: Object\n\n```\n\"reservable_views\": {\n \"iconClass\": \"String\",\n \"isDefault\": Boolean,\n \"label\": \"String\",\n \"order\": Number,\n \"type\": \"String\"\n}\n```\n\nTable: Reservable View \\[sn\\_wsd\\_rsv\\_reservable\\_view\\]\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views.iconClass\n\n | \n\nIcon class of the reservable view.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views.isDefault\n\n | \n\nFlag that indicates whether to make this reservable view the default for reservable modules. Valid values:\n\n- true: Make default.\n- false: Don't make default.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views.label\n\n | \n\nName of the reservable view.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views.order\n\n | \n\nOrder in which the views are displayed for the reservable module in the UI. The lower order number come first in the UI. In case of the same order number, it is assigned random ordering.Data type: Number\n\n |
| \n\nresult.reservation.reservable\\_module.reservable\\_views.type\n\n | \n\nBackend name of the reservable view. Used for internal processing.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservation\\_paths\n\n | \n\nReservation paths associated with the reservable modules such as Browse all, Browse near a person.Data type: Array of Objects\n\n```\n\"reservation_paths\": [\n {\n \"displayValue\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.reservation.reservable\\_module.reservation\\_paths.display\\_value\n\n | \n\nDisplay value for the reservation path, such as \"Browse near a person\".Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.reservation\\_paths.value\n\n | \n\nInternal value for the reservation path, such as \"browse\\_near\\_a\\_person\".Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.search\\_limit\n\n | \n\nMaximum number of search results to return when a user searches for a workplace location.Data type: Number\n\n |
| \n\nresult.reservation.reservable\\_module.selection\\_type\n\n | \n\nType of selection to display in the search results.\n\n Can be one of the following options:\n\n- Specific unit: The search result displays every workplace item.\n- Container: The search result displays the parent or container of the workplace items.\n\n Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.short\\_description\n\n | \n\nBrief description of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.show\\_map\\_view\n\n | \n\nFlag that indicates whether to enable the map view for reservable modules. Valid values:\n\n- true: Enable map view.\n- false: Don't enable map view.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservable\\_module.sys\\_id\n\n | \n\nSys\\_id of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots\n\n | \n\nDetails about the time slots associated for a reservable module.Data type: Array of Objects\n\n```\n[\n {\n \"name\": \"String\",\n \"short_description\": \"String\",\n \"slot_end\": \"String\",\n \"slot_start\": \"String\",\n \"sys_id\": \"String\"\n }\n]\n```\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots.name\n\n | \n\nName of the time slot.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots.short\\_description\n\n | \n\nBrief description of the time slot.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots.slot\\_end\n\n | \n\nEnd time of the time slot.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots.slot\\_start\n\n | \n\nStart time of the slot.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.timeSlots.sys\\_id\n\n | \n\nSys\\_id of the time slot record.Data type: String\n\nTable: Time Slot \\[sn\\_wsd\\_rsv\\_time\\_slot\\]\n\n |
| \n\nresult.reservation.reservable\\_module.title\n\n | \n\nTitle of the reservable module.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.virtual\\_meeting\\_provider\n\n | \n\nDetails about the virtual provider associated with the reservable module.Data type: Object\n\n```\n\"virtual_meeting_provider\": {\n \"display_value\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.reservable\\_module.virtual\\_meeting\\_provider.display\\_value\n\n | \n\nDisplay value of the virtual meeting provider.Data type: String\n\n |
| \n\nresult.reservation.reservable\\_module.virtual\\_meeting\\_provider.sys\\_id\n\n | \n\nSys\\_id of the virtual meeting provider.Data type: String\n\n |
| \n\nresult.reservation.reservationAcl\n\n | \n\nDetails of the user access control levels \\(ACL\\) checks set on the associated reservation.Data type: Object\n\n```\n\"reservationAcl\": {\n \"read\": Boolean,\n \"write\": {Object}\n}\n```\n\n |
| \n\nresult.reservation.reservationAcl.read\n\n | \n\nFlag that indicates whether to check if the user can read this reservation.Valid values:\n\n- true: Check if user can read the reservation.\n- false: Don't check if user can read the reservation.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write\n\n | \n\nDetails about the user's write capabilities for the associated reservation.Data type: Object\n\n```\n\"write\": {\n \"allFields\": Boolean,\n \"fields\": {Object},\n \"record\": Boolean\n}\n```\n\n |
| \n\nresult.reservation.reservationAcl.write.allFields\n\n | \n\nFlag that indicates whether to check if the user can write to all fields specified in the **reservationACL.write.fields** object. If the user only has access to some specific fields, then only those fields are true in the **reservationACL.write.fields** object.Valid values:\n\n- true: Check if user can write to all fields specified in the **reservationACL.write.fields** object.\n- false: Don't check if user can write to all fields specified in the **reservationACL.write.fields** object\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.fields\n\n | \n\nDetails of the access controls on various fields of the reservation.Data type: Object\n\n```\n\"fields\": {\n \"location\": Boolean,\n \"number_of_attendees\": Boolean,\n \"requested_for\": Boolean,\n \"sensitivity\": Boolean,\n \"subject\": Boolean\n}\n```\n\n |
| \n\nresult.reservation.reservationAcl.write.fields.location\n\n | \n\nFlag that indicates whether to check if the user can write to the location fields in this reservation.Valid values:\n\n- true: Check if user can write to the location fields.\n- false: Don't check if user can write to the location fields.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.fields.number\\_of\\_attendees\n\n | \n\nFlag that indicates whether to check if the user can write to the number of attendees fields in this reservation.Valid values:\n\n- true: Check if user can write to the number of attendees field.\n- false: Don't check if user can write to the number of attendees field.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.fields.requested\\_for\n\n | \n\nFlag that indicates whether to check if the user can write to the requested for fields in this reservation.Valid values:\n\n- true: Check if user can write to the requested for field.\n- false: Don't check if user can write to the requested for field.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.fields.sensitivity\n\n | \n\nFlag that indicates whether to check if the user can write to the sensitivity fields in this reservation.Valid values:\n\n- true: Check if user can write to the sensitivity field.\n- false: Don't check if user can write to the sensitivity field.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.fields.subject\n\n | \n\nFlag that indicates whether to check if the user can write to the subject fields in this reservation.Valid values:\n\n- true: Check if user can write to the subject field.\n- false: Don't check if user can write to the subject fields.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservationAcl.write.record\n\n | \n\nFlag that indicates whether to check if the user can write to the entire reservation record.Valid values:\n\n- true: Check if user can write to the entire reservation record.\n- false: Don't check if user can write to the entire reservation record.\n\nData type: Boolean\n\n |
| \n\nresult.reservation.reservation\\_purpose\n\n | \n\nDetails about the purpose of the reservation.Data type: Object\n\n```\n\"reservation_purpose\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.reservation\\_purpose.display\\_value\n\n | \n\nDisplay value for the purpose of the reservation, such as Company meeting.Data type: String\n\n |
| \n\nresult.reservation.reservation\\_purpose.value\n\n | \n\nInternal value for the purpose of the reservation, such as company\\_meeting.Data type: String\n\n |
| \n\nresult.reservation.reservation\\_type\n\n | \n\nDetails about the type of the reservation.Data type: Object\n\n```\n\"reservation_type\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.reservation\\_type.display\\_value\n\n | \n\nDisplay value for the type of the reservation, such as Space.Data type: String\n\n |
| \n\nresult.reservation.reservation\\_type.value\n\n | \n\nInternal value for the type of the reservation, such as space.Data type: String\n\n |
| \n\nresult.reservation.reservation\\_subtype\n\n | \n\nDetails about the subtype of the reservation. Subtypes indicate the type of reservation, such as single, Multi parent, Multi child, Recurring parent, or occurrence.Data type: Object\n\n```\n\"reservation_subtype\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.reservation\\_subtype.display\\_value\n\n | \n\nDisplay value for the subtype of the reservation, such as Single.Data type: String\n\n |
| \n\nresult.reservation.reservation\\_subtype.value\n\n | \n\nInternal value for the subtype of the reservation, such as single.Data type: String\n\n |
| \n\nresult.reservation.sensitivity\n\n | \n\nDetails about the sensitivity of the reservation.Data type: Object\n\n```\n\"sensitivity\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.sensitivity.display\\_value\n\n | \n\nDisplay value for the sensitivity of the reservation, such as high or low.Data type: String\n\n |
| \n\nresult.reservation.sensitivity.value\n\n | \n\nInternal value for the sensitivity of the reservation, such as 1 or 3.Data type: String\n\n |
| \n\nresult.reservation.shift\n\n | \n\nDetails about the shift applied to the reservation.Data type: Object\n\n```\n\"shift\": {\n \"display_value\": \"String\",\n \"name\": \"String\",\n \"shiftDetails\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.shift.display\\_value\n\n | \n\nDisplay value of the shift.Data type: String\n\n |
| \n\nresult.reservation.shift.name\n\n | \n\nName of the shift. Same as **display\\_value**.Data type: String\n\n |
| \n\nResult.reservation.shift.shiftDetails\n\n | \n\nDetails of shift.Data type: String\n\n |
| \n\nresult.reservation.shift.sys\\_id\n\n | \n\nSys\\_id of the shift record.Data type: String\n\nTable: Shift \\[sn\\_wsd\\_core\\_shift\\]\n\n |
| \n\nresult.reservation.source\n\n | \n\nDetails about the source for the reservation, such as Workplace Services or Google Mail..Data type: Object\n\n```\n\"source\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.source.display\\_value\n\n | \n\nDisplay value for the reservation source, such as Workplace Services.Data type: String\n\n |
| \n\nresult.reservation.source.value\n\n | \n\nInternal value for the reservation source, such as servicenow.Data type: String\n\n |
| \n\nresult.reservation.source\\_icon\n\n | \n\nDetails about the source of the icon used in the reservation. This icon is used in the UI.Data type: Object\n\n```\n\"source_icon\": {\n \"classNames\": \"String\",\n \"imgSrc\": \"String\",\n \"tooltip\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.source\\_icon.classNames\n\n | \n\nComma-separated class names for the source icon.Data type: String\n\n |
| \n\nresult.reservation.source\\_icon.imgSrc\n\n | \n\nName of the image source for source icon. This icon is stored in the Images \\[db\\_image\\] table.Data type: String\n\n |
| \n\nresult.reservation.source\\_icon.tooltip\n\n | \n\nTooltip associated with the source icon.Data type: String\n\n |
| \n\nresult.reservation.source\\_reservation\n\n | \n\nSource reservation of the current reservation. For example, for recurring reservations, the recurring parent reservation is the source of the series of occurrence reservations.Data type: Object\n\n```\n\"source_reservation\": {\n \"display_value\": \"String\",\n \"name\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.source\\_reservation.display\\_value\n\n | \n\nDisplay value for the source reservation.Data type: String\n\n |
| \n\nresult.reservation.source\\_reservation.name\n\n | \n\nName of the source reservation.Data type: String\n\n |
| \n\nresult.reservation.source\\_reservation.sys\\_id\n\n | \n\nSys\\_id of the source reservation record.Data type: String\n\nTable:Workplace Reservation \\[sn\\_wsd\\_rsv\\_reservation\\]\n\n |
| \n\nresult.reservation.source\\_reservation\\_requester\n\n | \n\nUser who requested the recurring reservation.Data type: Object\n\n```\n\"source_reservation\": {\n \"name\": \"String\",\n \"sys_id\": \"String\",\n \"user_name\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.source\\_reservation\\_requester.name\n\n | \n\nName of the recurring reservation requester.Data type: String\n\n |
| \n\nresult.reservation.source\\_reservation\\_requester.sys\\_id\n\n | \n\nSys\\_id of the user who requested the recurring reservation.Data type: String\n\nTable: User \\[sys\\_user\\]\n\n |
| \n\nresult.reservation.source\\_reservation\\_requester.user\\_name\n\n | \n\nUser name of the recurring reservation requester.Data type: String\n\n |
| \n\nresult.reservation.start\n\n | \n\nReservation start date and time.Data type: String\n\nFormat: UTC - yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z\n\n |
| \n\nresult.reservation.state\n\n | \n\nDetails about the state of the reservation.Data type: Object\n\n```\n\"state\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.state.display\\_value\n\n | \n\nDisplay value for the current state of the reservation, such as confirmed.Data type: String\n\n |
| \n\nresult.reservation.state.value\n\n | \n\nInternal value for the current state of the reservation, such as 2.Data type: String\n\n |
| \n\nresult.reservation.subject\n\n | \n\nReservation's subject.Data type: String\n\n |
| \n\nresult.reservation.sub\\_source\n\n | \n\nDetails about the sub-source of the reservation. The sub-source specifies where the reservation originated such as Google Calendar or Microsoft Exchange.Data type: Object\n\n```\n\"sub_source\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.sub\\_source.display\\_value\n\n | \n\nDisplay value for the sub-source of the reservation, such as Google Calendar.Data type: String\n\n |
| \n\nresult.reservation.sub\\_source.value\n\n | \n\nInternal value of the sub-source field of the reservation, such as google\\_calendar.Data type: String\n\n |
| \n\nresult.reservation.sync\\_state\n\n | \n\nDetails about the synchronization state of a reservation from another service, such as \"sync\\_enqueued\" or \"synchronized\".Data type: Object\n\n```\n\"sync_state\": {\n \"display_value\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nresult.reservation.sync\\_state.display\\_value\n\n | \n\nDisplay value for the current sync state of the reservation, such as synchronized.Data type: String\n\n |
| \n\nresult.reservation.sync\\_state.value\n\n | \n\nInternal value of the current sync state of the reservation, such as synchronized.Data type: String\n\n |
| \n\nresult.reservation.sys\\_created\\_on\n\n | \n\nDate and time when the reservation was created.Data type: String\n\n |
| \n\nresult.reservation.sys\\_id\n\n | \n\nSys\\_id of the reservation record.\n\nData type: String\n\nTable: Workplace Reservation \\[sn\\_wsd\\_rsv\\_reservation\\]\n\n |
| \n\nResult.reservation.sys\\_updated\\_on\n\n | \n\nDate and time when the reservation was last updated. Data type: String\n\n |
| \n\nresult.reservation.virtual\\_meeting\n\n | \n\nURL of the virtual meeting link.Data type: String\n\n |
\n