Skip to content
REST API reference › API reference › API implementation and reference
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

WSD Reservation API

The Workplace Service Delivery (WSD) Reservation API provides endpoints for managing workplace reservations.

To access this API, the caller must have the sn_wsd_core.workplace_user role and the Workplace Safety Management (sn_wsd_core) and Workplace Reservation Management (sn_wsd_rsv) plugins must be activated.

This API runs in the sn_wsd_rsv namespace.

For additional information on Workplace Reservation Management, see Workplace Reservation Management.

Parent Topic:REST API reference

WSD Reservation - GET /api/sn_wsd_rsv/reservation/get

Retrieves the specified workplace reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/get

Default URL: /api/sn_wsd_rsv/reservation/get

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
NameDescription
external\_icalUnique external iCalendar identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation. Obtain this value from the associated external iCalendar application.Data type: String
external\_idUnique external identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation. Obtain this value from the associated external application.Data type: String
include\_multi\_child\_​dataIf the reservation\_subtype field value in the associated Workplace Reservation \[sn\_wsd\_rsv\_reservation\] record is set to multi\_child, this flag indicates whether to return the reservation details.Valid values: - true: Return the reservation details. - false: Do not return the reservation details. Data type: Boolean Default value: false
include\_standard\_​servicesFlag that indicates whether to return the standard services information in the response. This information is located in the Standard Service \[sn\_wsd\_rsv\_standard\_service\] table.A standard service describes basic provisions available with a reservable workplace item when the reservation is made, such as white boards, additional monitors, and similar services. For additional information on standard services, see Standard services. Valid values: - true: Return the standard services information. - false: Don't return the standard services information. Data type: Boolean Default: false
sys\_idRequired. Sys\_id of the reservation record. Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
NameDescription
None 

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
result.reservationDetails about the reservation.Data type: Object 
"reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "is_private": Boolean,
  "informEmployeePrivacy": Boolean.
  "last_updated_sub_source": {Object},
  "location" {Object},
  "number": "String",
  "number_of_attendees": Number,
  "recording_details": [Array],
  "reservable_module": {Object},
  "reservation_purpose": {Object},
  "reservation_type": {Object},
  "reservation_subtype": {Object},
  "sensitivity": {Object},
  "start": "String",
  "state": {Object},
  "source_reservation": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "sys_created_on: "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "virtual_meeting": "String"
}
result.reservation.activeFlag that indicates whether the reservation is active.Valid values: - true: Reservation is active. - false: Reservation is inactive. Data type: Boolean
result.reservation.attendeesList of attendees for the reservation.Data type: Array of Objects 
"attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
result.reservation.attendees.avatarSys\_id of the avatar associated with the attendee.Data type: String Table: Attachments \[sys\_attachment\]
result.reservation.attendees.displayValueDisplay value for the attendee.Data type: String
result.reservation.attendees.display\_valueDisplay value of the attendee. Same as displayValue.Data type: String
result.reservation.attendees.emailAttendee's email address.Data type: String
result.reservation.attendees.initialsAttendee's initials.Data type: String
result.reservation.attendees.nameAttendee's name.Data type: String
result.reservation.attendees.sys\_idSys\_id of the attendee record.Data type: String
result.reservation.attendees.tableTable in which the attendee record exists.Data type: String
result.reservation.attendees.user\_nameAttendee's user name.Data type: String
result.reservation.attendees.valueInternal value of the attendee.Data type: String
result.reservation.check\_in\_stateDetails about the check-in state of the reservation.Data type: Object 
"check_in_state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.check\_in\_state.​display\_valueDisplay value for the current check-in state of the reservation, such as In progress or complete.Data type: String
result.reservation.check\_in\_state.valueInternal value for the current check-in state of the reservation, such as 2.Data type: String
result.reservation.edit\_restrictionDescription of the user edit restrictions for the reservation, such as no\_restrictions, service\_only, or fully\_restricted.Data type: Object 
"edit_restriction": {
  "display_value": "String",
  "value": "String"
}
result.reservation.edit\_restriction.display\_​valueDisplay value for the edit restrictions for the reservation, such as `No restriction`.Data type: String
result.reservation.edit\_restriction.valueInternal value for the edit restrictions for the reservation, such as `no_restriction`.Data type: String
result.reservation.endReservation end date and time.Data type: String Format: UTC: yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z
result.reservation.external\_icalUnique external iCalendar identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String
result.reservation.external\_idUnique external identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String
result.reservation.is\_parentFlag that indicates whether this reservation is a parent reservation.Possible values: - true: Parent reservation. - false: Not a parent reservation. Data type: Boolean
result.reservation.is\_privateFlag that indicates whether the reservation is private. If private, the reservation doesn't appear to anyone except the owner.For additional information on these privacy settings, see Location privacy settings and impact. Valid values: - true: Reservation is private. - false: Reservation isn't private. Data type: Boolean Default: Value set for privacy in the system properties.
result.reservation.last\_updated\_sub\_sourceDetails 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 
"last_updated_sub_source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.last\_updated\_sub\_source.​display\_valueDisplay 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
result.reservation.last\_updated\_sub\_source.​valueInternal 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
result.reservation.locationDetails about the location associated with the reservation.Data type: Object 
"location": {
  "active": Boolean,
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number_of_attendees": Number,
  "region": {Object},
  "reservable_module": {Object},
  "reservation": {Object},
  "site": {Object},
  "state": {Object},
  "sys_id": "String"
}
result.reservation.location.areaDetails about the area associated with the location.Data type: Object 
"area": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.area.activeFlag that indicates whether the area is active.Valid values: - true: Area is active. - false: Area is inactive. Data type: Boolean
result.reservation.location.area.display\_valueDisplay value of the area to which this location belongs, such as Desk A2.Data type: String
result.reservation.location.area.sys\_idSys\_id of the area to which this location belongs.Data type: String Table: Area \[sn\_wsd\_core\_area\]
result.reservation.location.buildingDetails about the building associated with the location.Data type: Object 
"building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
result.reservation.location.building.activeFlag that indicates whether the building is active.Valid values: - true: Building is active. - false: Building is inactive. Data type: Boolean
result.reservation.location.building.​display\_valueDisplay value of the building to which this location belongs, such as AMS - Bld1.Data type: String
result.reservation.location.building.sys\_idSys\_id of the building to which this location belongs.Data type: String Table: Building \[sn\_wsd\_core\_building\]
result.reservation.location.building.timezoneDetails about the time zone associated with the location.Data type: Object 
"timezone": {
  "displayValue": "String",
  "value": "String"
}
result.reservation.location.building.timezone.​display\_valueDisplay value for the time zone to which this location belongs.Data type: String
result.reservation.location.building.timezone.​valueInternal value for the time zone to which this location belongs.Data type: String
result.reservation.location.campusDetails about the campus associated with the location.Data type: Object 
"campus": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.campus.activeFlag that indicates whether the campus is active.Valid values: - true: Campus is active. - false: Campus is inactive. Data type: Boolean
result.reservation.location.campus.​display\_valueDisplay value of the campus to which this location belongs, such as Amsterdam Campus.Data type: String
result.reservation.location.campus.sys\_idSys\_id of the campus to which this location belongs.Data type: String Table: Campus \[sn\_wsd\_core\_campus\]
result.reservation.location.capacityMaximum number of occupants for the location.Data type: Number
result.reservation.location.descriptionBrief description of the location.Data type: String
result.reservation.location.display\_valueValue to display in the UI for this location.Data type: String
result.reservation.location.emailEmail address for the location.Data type: String
result.reservation.location.floorDetails about the floor associated with the location.Data type: Object 
"floor": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.floor.activeFlag that indicates whether the floor is active.Valid values: - true: Floor is active. - false: Floor is inactive. Data type: Boolean
result.reservation.location.floor.display\_valueDisplay value of the floor to which this location belongs, such as First floor.Data type: String
result.reservation.location.floor.sys\_idSys\_id of the floor to which this location belongs.Data type: String Table: Floor \[sn\_wsd\_core\_floor\]
result.reservation.location.label\_valueType of value specified in the name parameter, such as Room name.Data type: String
result.reservation.location.nameName of the location.Data type: String
result.reservation.location.numberReservation number.Data type: String
result.reservation.location.number\_of\_​attendeesNumber of attendees for the reservation.Data type: Number
result.reservation.location.regionDetails about the region associated with the location.Data type: Object 
"region": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.region.activeFlag that indicates whether the region is active.Valid values: - true: Region is active. - false: Region is inactive. Data type: Boolean
result.reservation.location.region.​display\_valueDisplay value of the region to which this location belongs, such as Europe.Data type: String
result.reservation.location.region.sys\_idSys\_id of the region to which this location belongs.Data type: String Table: Region \[sn\_wsd\_core\_region\]
result.reservation.location.requested\_forDetails about the person for whom the reservation was requested on behalf of.Data type: Object 
"requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
result.reservation.location.requested\_for.​nameName of the user for whom the reservation was requested for.Data type: String
result.reservation.location.requested\_for.​sys\_idSys\_id of the user for whom the reservation is being requested.Data type: String Table: User \[sys\_user\]
result.reservation.location.requested\_for.​user\_nameUser name of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservationDetails about the reservation associated with the location.Data type: Object 
"reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
result.reservation.location.reservation.activeFlag that indicates whether the reservation is active.Valid values: - true: Reservation is active. - false: Reservation is inactive. Data type: Boolean
result.reservation.location.reservation.numberReservation number.Data type: String
result.reservation.location.reservation.​number\_of\_attendeesNumber of attendees of the reservation.Data type: Number
result.reservation.location.reservation.​requested\_forDetails about the person for whom the reservation was requested on behalf of.Data type: Object 
"requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
result.reservation.location.reservation.​requested\_for.nameName of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservation.​requested\_for.sys\_idSys\_id of the requested for user.Data type: String Table: User \[sys\_user\]
result.reservation.location.reservation.​requested\_for.user\_nameUser name of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservable\_moduleDetails about the reservable module associated with the reservation.Data type: Object 
"reservable_module": {
  "inline_title": "String",
  "name": "String",
  "sys_id": "String",
  "title": "String"
}
result.reservation.location.reservable\_module.​inline\_titleInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String
result.reservation.location.reservable\_module.​nameName of the reservable module.Data type: String
result.reservation.location.reservable\_module.​sys\_idSys\_id of the reservable module.Data type: String
result.reservation.location.reservable\_module.​titleTitle of the reservable module.Data type: String
result.reservation.location.siteSite to which the location belongs.Data type: Object 
"site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
Table: Site \[sn\_wsd\_core\_site\]
result.reservation.location.site.activeFlag that indicates whether the site is active.Valid values: - true: Site is active. - false: Site is inactive. Data type: Boolean
result.reservation.location.site.display\_valueDisplay value of the site to which this location belongs, such as Western Europe.Data type: String
result.reservation.location.site.sys\_idSys\_id of the site to which this location belongs.Data type: String Table: Site \[sn\_wsd\_core\_site\]
result.reservation.location.stateDetails about the state of the reservation for the location.Data type: Object 
"state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.location.state.display\_valueDisplay value for the current state of the reservation, such as confirmed.Data type: String
result.reservation.location.state.valueInternal value for the current state of the reservation, such as 2.Data type: String
result.reservation.location.sys\_idSys\_id of the associated location record.Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
result.reservation.notification\_custom\_​messageCustom message for the notification sent to the recipients listed in reservation.notification_recipients.Data type: String
result.reservation.notification\_recipientsList of recipients that receive notification about the reservation.Data type: Array of Objects 
"notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
result.reservation.notification\_recipients.nameName of the recipient.Data type: String
result.reservation.notification\_recipients.sys\_idSys\_id of the recipient.Data type: String Table: User \[sys\_user\]
result.reservation.notification\_recipients.​user\_nameUser name of the recipient.Data type: String
result.reservation.numberUnique number of the reservation record. You can use this value to query the reservation.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
result.reservation.opened\_byDetails about the user that created the reservation.Data type: Object 
"opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
result.reservation.opened\_by.avatarAvatar for the user that opened the reservation.Data type: String
result.reservation.opened\_by.displayValueDisplay value of the opened by user.Data type: String
result.reservation.opened\_by.display\_valueDisplay value of the opened by user.Data type: String
result.reservation.opened\_by.emailEmail address for the user that opened the reservation.Data type: String
result.reservation.opened\_by.initialsInitials of the user that opened the reservation.Data type: String
result.reservation.opened\_by.labelLabel for the user that opened the reservation. This is a combination of the title and department of the user.Data type: String
result.reservation.opened\_by.nameName of the user that opened the reservation.Data type: String
result.rservation.opened\_by.sys\_idSys\_id\_of the user that opened the reservation.Data type: String Table: User \[sys\_user\]
result.rservation.opened\_by.tableTable that contains the user record.Data type: String
result.reservation.opened\_by.user\_nameUser name of the user that opened the reservation.Data type: String
result.reservation.opened\_by.valueInternal value of the user that opened the reservation.Data type: String
result.reservation.numberReservation number.Data type: String
result.reservation.number\_of\_attendeesNumber of attendees in this reservation.Data type: Number
result.reservation.recording\_detailsDetails about the recordings associated with the reservation \(meeting\).Data type: Array of Objects 
"recording_details": [
  "recording_url": "String"
]
result.reservation.recording\_details.​recording\_urlURL of the recordings associated with the reservation.Data type: String
result.reservation.requested\_forDetails about the user that the reservation was made on behalf of.Data type: Object 
"requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
result.reservation.requested\_for.avatarAvatar for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.displayValueDisplay value of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.display\_valueDisplay value of the user that the reservation was made on behalf of. Same as displayValue.Data type: String
result.reservation.requested\_for.emailEmail address for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.initialsInitials of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.labelLabel for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.nameName of the user that the reservation was made on behalf of.Data type: String
result.rservation.requested\_for.sys\_idSys\_id\_of the user that the reservation was made on behalf of.Data type: String Table: User \[sys\_user\]
result.rservation.requested\_for.tableTable that contains the user record.Data type: String
result.reservation.requested\_for.user\_nameUser name of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.valueInternal value of the user that the reservation was made on behalf of.Data type: String
result.reservation.reservable\_moduleDetails for the requested reservable module.Data type: Object 
"reservable_module": {
  "allow_invitees": Boolean,
  "allow_whole_day": Boolean,
  "apply_to_shift": Boolean,
  "browse_by_area_enabled": Boolean,
  "browse_near_a_person_enabled": Boolean,
  "buildingSysIds": [Array],
  "checkin_before_minutes": Number,
  "display_number_of_attendees": Boolean,
  "display_on_behalf_of": Boolean,
  "display_sensitivity": Boolean,
  "display_value": "String",
  "enable_browse_by_area": Boolean,
  "enable_browse_near_a_person": Boolean,
  "enable_facet_filter": Boolean,
  "enable_group_reservations": Boolean,
  "enable_ical_generation": Boolean,
  "font_awesome_icon": "String",
  "inline_title": "String",      
  "layout_mapping": {Object},
  "max_days_in_future": Number,
  "max_occurrences": Number,
  "name": "String",
  "override_approval_policy": "String",
  "require_cancel_notes": Boolean,
  "require_cc_dept_check": Boolean,
  "require_subject": Boolean,
  "reservable_columns": [Array],
  "reservable_container_field": "String",
  "reservable_filter": "String",
  "reservable_quantity_field": "String",
  "reservable_table": "String",
  "reservable_type": "String",
  "reservable_views": [Array],
  "reservation_paths": [Array],
  "search_limit": Number,
  "selection_type": "String",
  "short_description": "String",
  "show_map_view": Boolean,
  "sys_id": "String",
  "timeSlots": [Array],
  "title": "String",
  "virtual_meeting_provider": {Object}
}
result.reservation.reservable\_module.​allow\_inviteesFlag that indicates whether employees are able to add invitees to the reservation. Valid values: - true: Allow employees to add invitees to the reservation. - false: Don't allow employees to add invitees to the reservation. Data type: Boolean
result.reservation.reservable\_module.​allow\_whole\_dayFlag that indicates whether users can reserve the reservable for the entire day. Valid values: - true: Allow users to reserve for the entire day. - false: Don't allow users to reserve for the entire day. Data type: Boolean
result.reservation.reservable\_module.​apply\_to\_shiftFlag that indicates whether shift-based reservations are enabled for the reservable module. Valid values: - true: Allow shift-based reservations. - false: Don't allow shift-based reservations. Data type: Boolean
result.reservation.reservable\_module.​browse\_by\_area\_enabledFlag that indicates whether users are able to search for reservable modules by area.Valid values: - true: Allow users to browse reservable modules by area. - false: Don't allow users to browse reservable modules by area. Data type: Boolean
result.reservation.reservable\_module.​browse\_near\_a\_person\_enabledFlag that indicates whether users are able to search for reservable modules located by a specified person.Valid values: - true: Allow users to browse reservable modules near a person. - false: Don't allow users to browse reservable modules near a person. Data type: Boolean
result.reservation.reservable\_module.​buildingSysIdsList of sys\_ids of the buildings associated with the reservable module.Data type: Array of Strings
result.reservation.reservable\_module.​checkin\_before\_minutesAmount of time before a reservation starts that a user can check into their reservation.Unit: Minutes Data type: Number
result.reservation.reservable\_module.​display\_number\_of\_attendeesFlag that indicates whether users can specify the number of attendees in the reservation. Valid values: - true: Users can specify the number of attendees. - false: Users can't specify the display number of attendees. Data type: Boolean
result.reservation.reservable\_module.​display\_on\_behalf\_ofFlag that indicates whether reservations can be made on behalf of someone else. Valid values: - true: On behalf of supported. - false: On behalf of not supported. Data type: Boolean
result.reservation.reservable\_module.​display\_sensitivityFlag that indicates whether users can set the sensitivity of the reservation, such as normal or private.Valid values: - true: Able to set sensitivity. - false: Not able to set sensitivity. Defaults to normal. Data type: Boolean
result.reservation.reservable\_module.​display\_valueDisplay value of the reservable module.Data type: String
result.reservation.reservable\_module.​enable\_browse\_by\_area

Flag that indicates whether users are able to search for reservable modules by area. Same as browse_by_area_enabled.Valid values:

  • true: Allow users to browse reservable modules by area.
  • false: Don't allow users to browse reservable modules by area.

Data type: Boolean

result.reservation.reservable\_module.​enable\_browse\_near\_a\_person

Flag that indicates whether users are able to search for reservable modules located by a specified person. Same asbrowse_near_a_person_enabled.Valid values:

  • true: Allow users to browse reservable modules near a person.
  • false: Don't allow users to browse reservable modules near a person.

Data type: Boolean

result.reservation.reservable\_module.​enable\_facet\_filterFlag 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: - true: Facet filters are enabled. - false: Facet filters aren't enabled. Data type: Boolean
result.reservation.reservable\_module.​enable\_group\_reservationsFlag that indicates whether users can make a group reservation.Valid values: - true: Able to make group reservations. - false: Not able to make group reservations. Data type: Boolean
result.reservation.reservable\_module.​enable\_ical\_generationFlag that indicates whether users can generate an iCalendar for the reservation.Valid values: - true: iCalendar generation allowed. - false: iCalendar generation isn't allowed. Data type: Boolean
result.reservation.reservable\_module.​font\_awesome\_iconName of the font icon attached to the reservable module.Data type: String
result.reservation.reservable\_module.​inline\_titleInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String
result.reservation.reservable\_module.​layout\_mappingDetails about the structure of the layout mapping of locations. Use this data to lay out the information in the UI. Data type: Object 
"layout_mapping": {
  "body": [Array],
  "description": [Array],
  "image": "String",
  "subtitle": [Array],
  "subtitle_asc": [Array],
  "title": [Array]
}
result.reservation.reservable\_module.​layout\_mapping.bodyPlaceholder for mapping the front-end UI data.Data type: Array of Objects 
"body": [
  {
    "field": "String",
    "field_to_display": "String",
    "icon": "String",
    "label": "String"
  }
]
result.reservation.reservable\_module.​layout\_mapping.body.fieldPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.field\_to\_displayPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.iconPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.labelPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.descriptionPlaceholder for mapping the front-end UI data. Description of the layout mapping.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.imagePlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.subtitlePlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.subtitle\_ascPlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.titlePlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​max\_days\_in\_futureMaximum number of the days in the future that a user can reserve the reservable module.Data type: Number
result.reservation.reservable\_module.​max\_occurrencesMaximum number of recurring reservation occurrences if recurring reservations are available for the reservable module.Data type: Number
result.reservation.reservable\_module.nameName of the reservable module.Data type: String
result.reservation.reservable\_module.​override\_approval\_policy

Option to specify how to implement the approval policy. Choices:

  • No override: The approval policy is implemented as set in the Requires approval field of a workplace space or room.
  • Always require approval: The approval policy is required regardless of what is set in the Requires approval field of a workplace space or room.
  • Never require approval: The approval policy is removed regardless of what is set in the Requires approvall field of a workplace space or room.

Data type: String

result.reservation.reservable\_module.​require\_cancel\_notesFlag that indicates whether users must enter a cancellation note before cancelling a reservable module.Valid values: - true: Cancellation note required. - false: Cancellation note not required. Data type: Boolean
result.reservation.reservable\_module.​require\_cc\_dept\_checkFlag 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: - true: Check for a mismatch. - false: Don't check for a mismatch. Data type: Boolean
result.reservation.reservable\_module.​require\_subjectFlag that indicates whether the user must enter a subject when making the reservation.Valid values: - true: Subject required. - false: Subject isn't required. Data type: Boolean
result.reservation.reservable\_module.​reservable\_columnsList of the columns of a reservable.Data type: Array Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
result.reservation.reservable\_module.​reservable\_container\_fieldLevel of the container, such as a group of desks in a specific area.Data type: String
result.reservation.reservable\_module.​reservable\_filterFilter 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
result.reservation.reservable\_module.​reservable\_quantity\_fieldReservable 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.Data type: String
result.reservation.reservable\_module.​reservable\_tableTable that contains the reservable workplace items.Data type: String
result.reservation.reservable\_module.​reservable\_typeType of the reservable item, such as location.Data type: String
result.reservation.reservable\_module.​reservable\_viewsDetails about the different views associated with the reservable module, such as card view or schedule view.Data type: Object 
"reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}
Table: Reservable View \[sn\_wsd\_rsv\_reservable\_view\]
result.reservation.reservable\_module.​reservable\_views.iconClassIcon class of the reservable view.Data type: String
result.reservation.reservable\_module.​reservable\_views.isDefaultFlag that indicates whether to make this reservable view the default for reservable modules. Valid values: - true: Make default. - false: Don't make default. Data type: Boolean
result.reservation.reservable\_module.​reservable\_views.labelName of the reservable view.Data type: String
result.reservation.reservable\_module.​reservable\_views.orderOrder 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
result.reservation.reservable\_module.​reservable\_views.typeBackend name of the reservable view. Used for internal processing.Data type: String
result.reservation.reservable\_module.​reservation\_pathsReservation paths associated with the reservable modules such as Browse all, Browse near a person.Data type: Array of Objects 
"reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
  }
]
result.reservation.reservable\_module.​reservation\_paths.display\_valueDisplay value for the reservation path, such as "Browse near a person".Data type: String
result.reservation.reservable\_module.​reservation\_paths.valueInternal value for the reservation path, such as "browse\_near\_a\_person".Data type: String
result.reservation.reservable\_module.​search\_limitMaximum number of search results to return when a user searches for a workplace location.Data type: Number
result.reservation.reservable\_module.​selection\_typeType of selection to display in the search results. Can be one of the following options: - Specific unit: The search result displays every workplace item. - Container: The search result displays the parent or container of the workplace items. Data type: String
result.reservation.reservable\_module.​short\_descriptionBrief description of the reservable module.Data type: String
result.reservation.reservable\_module.​show\_map\_viewFlag that indicates whether to enable the map view for reservable modules. Valid values: - true: Enable map view. - false: Don't enable map view. Data type: Boolean
result.reservation.reservable\_module.sys\_idSys\_id of the reservable module.Data type: String
result.reservation.reservable\_module.timeSlotsDetails about the time slots associated for a reservable module.Data type: Array of Objects 
[
  {
    "name": "String",
    "short_description": "String",
    "slot_end": "String",
    "slot_start": "String",
    "sys_id": "String"
  }
]
result.reservation.reservable\_module.​timeSlots.nameName of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.short\_descriptionBrief description of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.slot\_endEnd time of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.slot\_startStart time of the slot.Data type: String
result.reservation.reservable\_module.​timeSlots.sys\_idSys\_id of the time slot record.Data type: String Table: Time Slot \[sn\_wsd\_rsv\_time\_slot\]
result.reservation.reservable\_module.titleTitle of the reservable module.Data type: String
result.reservation.reservable\_module.​virtual\_meeting\_providerDetails about the virtual provider associated with the reservable module.Data type: Object 
"virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.reservable\_module.​virtual\_meeting\_provider.display\_valueDisplay value of the virtual meeting provider.Data type: String
result.reservation.reservable\_module.​virtual\_meeting\_provider.sys\_idSys\_id of the virtual meeting provider.Data type: String
result.reservation.reservationAclDetails of the user access control levels \(ACL\) checks set on the associated reservation.Data type: Object 
"reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
result.reservation.reservationAcl.readFlag that indicates whether to check if the user can read this reservation.Valid values: - true: Check if user can read the reservation. - false: Don't check if user can read the reservation. Data type: Boolean
result.reservation.reservationAcl.writeDetails about the user's write capabilities for the associated reservation.Data type: Object 
"write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
result.reservation.reservationAcl.write.allFields

Flag 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:

  • true: Check if user can write to all fields specified in the reservationACL.write.fields object.
  • false: Don't check if user can write to all fields specified in the reservationACL.write.fields object

Data type: Boolean

result.reservation.reservationAcl.write.fieldsDetails of the access controls on various fields of the reservation.Data type: Object 
"fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
result.reservation.reservationAcl.write.fields.​locationFlag that indicates whether to check if the user can write to the location fields in this reservation.Valid values: - true: Check if user can write to the location fields. - false: Don't check if user can write to the location fields. Data type: Boolean
result.reservation.reservationAcl.write.fields.​number\_of\_attendeesFlag that indicates whether to check if the user can write to the number of attendees fields in this reservation.Valid values: - true: Check if user can write to the number of attendees field. - false: Don't check if user can write to the number of attendees field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​requested\_forFlag that indicates whether to check if the user can write to the requested for fields in this reservation.Valid values: - true: Check if user can write to the requested for field. - false: Don't check if user can write to the requested for field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​sensitivityFlag that indicates whether to check if the user can write to the sensitivity fields in this reservation.Valid values: - true: Check if user can write to the sensitivity field. - false: Don't check if user can write to the sensitivity field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​subjectFlag that indicates whether to check if the user can write to the subject fields in this reservation.Valid values: - true: Check if user can write to the subject field. - false: Don't check if user can write to the subject fields. Data type: Boolean
result.reservation.reservationAcl.write.recordFlag that indicates whether to check if the user can write to the entire reservation record.Valid values: - true: Check if user can write to the entire reservation record. - false: Don't check if user can write to the entire reservation record. Data type: Boolean
result.reservation.reservation\_purposeDetails about the purpose of the reservation.Data type: Object 
"reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_purpose.​display\_valueDisplay value for the purpose of the reservation, such as Company meeting.Data type: String
result.reservation.reservation\_purpose.valueInternal value for the purpose of the reservation, such as company\_meeting.Data type: String
result.reservation.reservation\_typeDetails about the type of the reservation.Data type: Object 
"reservation_type": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_type.​display\_valueDisplay value for the type of the reservation, such as Space.Data type: String
result.reservation.reservation\_type.valueInternal value for the type of the reservation, such as space.Data type: String
result.reservation.reservation\_subtypeDetails 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 
"reservation_subtype": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_subtype.​display\_valueDisplay value for the subtype of the reservation, such as Single.Data type: String
result.reservation.reservation\_subtype.valueInternal value for the subtype of the reservation, such as single.Data type: String
result.reservation.sensitivityDetails about the sensitivity of the reservation.Data type: Object 
"sensitivity": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sensitivity.display\_valueDisplay value for the sensitivity of the reservation, such as high or low.Data type: String
result.reservation.sensitivity.valueInternal value for the sensitivity of the reservation, such as 1 or 3.Data type: String
result.reservation.shiftDetails about the shift applied to the reservation.Data type: Object 
"shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
result.reservation.shift.display\_valueDisplay value of the shift.Data type: String
result.reservation.shift.nameName of the shift. Same as display_value.Data type: String
Result.reservation.shift.shiftDetailsDetails of shift.Data type: String
result.reservation.shift.sys\_idSys\_id of the shift record.Data type: String Table: Shift \[sn\_wsd\_core\_shift\]
result.reservation.sourceDetails about the source for the reservation, such as Workplace Services or Google Mail..Data type: Object 
"source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.source.display\_valueDisplay value for the reservation source, such as Workplace Services.Data type: String
result.reservation.source.valueInternal value for the reservation source, such as servicenow.Data type: String
result.reservation.source\_iconDetails about the source of the icon used in the reservation. This icon is used in the UI.Data type: Object 
"source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
result.reservation.source\_icon.classNamesComma-separated class names for the source icon.Data type: String
result.reservation.source\_icon.imgSrcName of the image source for source icon. This icon is stored in the Images \[db\_image\] table.Data type: String
result.reservation.source\_icon.tooltipTooltip associated with the source icon.Data type: String
result.reservation.source\_reservationSource reservation of the current reservation.For example, in the case of multiple reservations, the parent reservation is the source of the child reservation. Data type: String
result.reservation.startReservation start date and time.Data type: String Format: UTC - yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z
result.reservation.subjectReservation's subject.Data type: String
result.reservation.sub\_sourceDetails 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 
"sub_source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sub\_source.display\_valueDisplay value for the sub-source of the reservation, such as Google Calendar.Data type: String
result.reservation.sub\_source.valueInternal value of the sub-source field of the reservation, such as google\_calendar.Data type: String
result.reservation.sync\_stateDetails about the synchronization state of a reservation from another service, such as "sync\_enqueued" or "synchronized".Data type: Object 
"sync_state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sync\_state.display\_valueDisplay value for the current sync state of the reservation, such as synchronized.Data type: String
result.reservation.sync\_state.valueInternal value of the current sync state of the reservation, such as synchronized.Data type: String
result.reservation.sys\_created\_onDate and time when the reservation was created.Data type: String
result.reservation.sys\_idRequired. Sys\_id of the reservation record. Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
Result.reservation.sys\_updated\_onDate and time when the reservation was last updated. Data type: String
result.reservation.virtual\_meetingURL of the virtual meeting link.Data type: String
result.reservationAclDetails of the user access control levels \(ACL\) checks set on the associated reservation.Data type: Object 
"reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
result.reservationAcl.readFlag that indicates whether to check if the user can read this reservation.Valid values: - true: Check if user can read the reservation. - false: Don't check if user can read the reservation. Data type: Boolean
result.reservationAcl.writeDetails about the user's write capabilities for the associated reservation.Data type: Object 
"write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
result.reservationAcl.write.allFields

Flag 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:

  • true: Check if user can write to all fields specified in the reservationACL.write.fields object.
  • false: Don't check if user can write to all fields specified in the reservationACL.write.fields object

Data type: Boolean

result.reservationAcl.write.fieldsDetails of the access controls on various fields of the reservation.Data type: Object 
"fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
result.reservationAcl.write.fields.locationFlag that indicates whether to check if the user can write to the location fields in this reservation.Valid values: - true: Check if user can write to the location fields. - false: Don't check if user can write to the location fields. Data type: Boolean
result.reservationAcl.write.fields.​number\_of\_attendeesFlag that indicates whether to check if the user can write to the number of attendees fields in this reservation.Valid values: - true: Check if user can write to the number of attendees field. - false: Don't check if user can write to the number of attendees field. Data type: Boolean
result.reservationAcl.write.fields.requested\_forFlag that indicates whether to check if the user can write to the requested for fields in this reservation.Valid values: - true: Check if user can write to the requested for field. - false: Don't check if user can write to the requested for field. Data type: Boolean
result.reservationAcl.write.fields.sensitivityFlag that indicates whether to check if the user can write to the sensitivity fields in this reservation.Valid values: - true: Check if user can write to the sensitivity field. - false: Don't check if user can write to the sensitivity field. Data type: Boolean
result.reservationAcl.write.fields.subjectFlag that indicates whether to check if the user can write to the subject fields in this reservation.Valid values: - true: Check if user can write to the subject field. - false: Don't check if user can write to the subject fields. Data type: Boolean
result.reservationAcl.recordFlag that indicates whether to check if the user can write to the entire reservation record.Valid values: - true: Check if user can write to the entire reservation record. - false: Don't check if user can write to the entire reservation record. Data type: Boolean
result.standard\_services

Only populated if the include_standard_services parameter is set to true. Associated standard services, such as flip chart, projector screen, and whiteboard and markers.

Data type: Array of Objects

"standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
result.standard\_services.font\_awesome\_iconName of the thumbnail icon associated with the standard service.Data type: String
result.standard\_services.nameName of the standard service.Data type: String
result.standard\_services.short\_descriptionBrief description of the standard service.Data type: String
result.standard\_services.sys\_idSys\_id of the standard service record.Data type: String Table: Standard Service \[sn\_wsd\_rsv\_standard\_service\]

cURL request

The following code example shows how to call this endpoint and include the standard services information.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get?sys_id=8e87c722870741106342b846dabb3573&include_standard_services=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Return results:

  "result": {
    "reservation": {
      "sys_id": "bf3621de842c2110fa9b813be354f327",
      "number": "WRES0001005",
      "location": {
        "sys_id": "9841e94adb7210106c731dcd13961914",
        "name": "A1-02-02",
        "description": "General desk available for reservation.",
        "display_value": "A1-02-02",
        "capacity": 1,
        "label_value": "Workspace/Desk name",
        "wsd_email": null,
        "reservable_module": {
          "sys_id": "5db44502dbb650106c731dcd13961937",
          "name": "Desks",
          "title": "Desks",
          "inline_title": "desk",
          "table": "sn_wsd_core_space"
        },
        "region": {
          "sys_id": "3752ac8edb3650106c731dcd139619e0",
          "display_value": "Americas",
          "active": true
        },
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America",
          "active": true
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus",
          "active": true
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1",
          "active": true,
          "timezone": {
            "value": "US/Pacific",
            "displayValue": "US/Pacific"
          }
        },
        "floor": {
          "sys_id": "fc7368cedb3650106c731dcd13961902",
          "display_value": "Floor 1",
          "active": true
        },
        "area": {
          "sys_id": "",
          "display_value": "",
          "active": false
        },
        "is_favorite": false,
        "reservation": {
          "sys_id": "bf3621de842c2110fa9b813be354f327",
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "auto_conflict_resolution_state": {
            "value": null,
            "display_value": null
          },
          "requested_for": {
            "sys_id": "6816f79cc0a8016401c5a33be04be441",
            "name": "System Administrator",
            "user_name": "admin"
          },
          "number": "WRES0001005",
          "active": true
        },
        "number_of_attendees": 1,
        "state": {
          "value": "confirmed",
          "display_value": "Confirmed"
        },
        "number": "WRES0001005",
        "requested_for": {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "name": "System Administrator",
          "user_name": "admin"
        },
        "is_private": true
      },
      "start": "2023-01-24T16:00:00Z",
      "end": "2023-01-24T17:00:00Z",
      "sys_created_on": "2023-01-24T15:49:49Z",
      "sys_updated_on": "2023-01-24T15:49:50Z",
      "source_reservation": null,
      "check_in_state": {
        "value": "awaiting_check_in",
        "display_value": "Awaiting check-in"
      },
      "external_id": null,
      "external_ical": null,
      "building": {
        "active": true,
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "campus": {
          "display_value": "California Campus",
          "value": "82b2a0cedb3650106c731dcd139619e9",
          "active": true
        },
        "site": {
          "display_value": "North America",
          "value": "628eec06db7650106c731dcd139619dd",
          "active": true
        },
        "timezone": {
          "value": "US/Pacific",
          "displayValue": "US/Pacific"
        }
      },
      "active": true,
      "state": {
        "value": "confirmed",
        "display_value": "Confirmed"
      },
      "sensitivity": {
        "value": "normal",
        "display_value": "Normal"
      },
      "reservation_type": {
        "value": "space",
        "display_value": "Space"
      },
      "reservation_subtype": {
        "value": "single",
        "display_value": "Single"
      },
      "reservation_purpose": {
        "value": "meeting",
        "display_value": "Meeting"
      },
      "attendees": [
        {
          "sys_id": "6816f79cc0a8016401c5a33be04be441",
          "value": "6816f79cc0a8016401c5a33be04be441",
          "displayValue": "System Administrator",
          "display_value": "System Administrator",
          "name": "System Administrator",
          "user_name": "admin",
          "table": "sys_user",
          "avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
          "initials": "SA",
          "email": "admin@example.com",
          "label": "System Administrator, Finance"
        }
      ],
      "number_of_attendees": 1,
      "is_parent": false,
      "is_private": true,
      "subject": "Reservation for A1-02-02",
      "virtual_meeting": null,
      "recording_details": [],
      "sync_state": {
        "value": "not_required",
        "display_value": "Synchronization not required"
      },
      "sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "last_updated_sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "reservable_module": {
        "sys_id": "5db44502dbb650106c731dcd13961937",
        "name": "Desks",
        "title": "Desks",
        "inline_title": "desk",
        "font_awesome_icon": "fa-desktop",
        "reservable_table": "sn_wsd_core_space",
        "reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
        "short_description": "Reserve a single desks",
        "reservable_type": "location",
        "require_subject": null,
        "require_cancel_notes": false,
        "virtual_meeting_provider": null,
        "enable_reservation_privacy": true,
        "allow_invitees": "1",
        "display_number_of_attendees": null,
        "display_on_behalf_of": "1",
        "display_sensitivity": null,
        "max_days_in_future": "90",
        "allow_recurring": "1",
        "auto_resolve_conflict": null,
        "allow_whole_day": "1",
        "allow_multi_building": "1",
        "require_whole_day": null,
        "selection_type": "unit",
        "reservable_container_field": null,
        "reservable_quantity_field": null,
        "apply_to_shift": null,
        "max_occurrences": "90",
        "enable_facet_filter": false,
        "search_limit": 10000,
        "enable_ical_generation": null,
        "enable_group_reservations": null,
        "enable_browse_near_a_person": "1",
        "enable_browse_by_area": "1",
        "enable_floor_search": null,
        "enable_browse_by_neighborhood": null,
        "require_cc_dept_check": false,
        "display_value": "Desks",
        "browse_near_a_person_enabled": true,
        "browse_by_area_enabled": true,
        "browse_by_neighborhood_enabled": false,
        "reservable_columns": [
          "sys_id",
          "external_id",
          "wsd_email",
          "name",
          "title",
          "description",
          "image",
          "number",
          "site",
          "campus",
          "building",
          "floor",
          "area",
          "capacity",
          "reservable_quantity",
          "location_type",
          "order",
          "requires_check_in",
          "is_reservable"
        ],
        "layout_mapping": {
          "title": [
            "name"
          ],
          "description": [
            "description"
          ],
          "subtitle": [
            "campus",
            "building",
            "floor",
            "area"
          ],
          "subtitle_asc": [
            "area",
            "floor",
            "building",
            "campus"
          ],
          "image": "image",
          "body": [
            {
              "label": "Capacity",
              "icon": "fa-users",
              "field": "capacity",
              "field_to_display": ""
            },
            {
              "label": "Standard services",
              "icon": "fa-check",
              "field": "standard_services",
              "field_to_display": "name"
            },
            {
              "label": "Reservable purposes",
              "icon": "fa-tags",
              "field": "reservable_purposes",
              "field_to_display": "name"
            }
          ]
        },
        "timeSlots": [
          {
            "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
            "name": "All day",
            "short_description": "8am - 6pm",
            "slot_start": "08:00",
            "slot_end": "18:00"
          },
          {
            "sys_id": "de131cf2dbb5f01038e42b24ca961931",
            "name": "Before noon",
            "short_description": "8am - 12pm",
            "slot_start": "08:00",
            "slot_end": "12:00"
          },
          {
            "sys_id": "6e99ab5ddbb930102e8e853e68961929",
            "name": "After noon",
            "short_description": "1pm - 6pm",
            "slot_start": "13:00",
            "slot_end": "18:00"
          }
        ],
        "buildingSysIds": [
          "03c45bf7dba41010d7981dcd1396196d",
          "07c45bf7dba41010d7981dcd1396196b",
          "07c45bf7dba41010d7981dcd13961972",
          "0bc45bf7dba41010d7981dcd13961970",
          "0fc45bf7dba41010d7981dcd1396196e",
          "1aa39b1977220110b3d7be377b5a9953",
          "2130659ae7321010809a268b03f6a91e",
          "22c41bf7dba41010d7981dcd139619fe",
          "2ac45bf7dba41010d7981dcd13961901",
          "2ec41bf7dba41010d7981dcd139619ff",
          "32c45bf7dba41010d7981dcd13961905",
          "32c45bf7dba41010d7981dcd1396190c",
          "32c45bf7dba41010d7981dcd13961943",

          "e2c41bf7dba41010d7981dcd139619fb"
        ],
        "reservable_views": [
          {
            "type": "card",
            "label": "Card view",
            "iconClass": "fa-th-large",
            "isDefault": true,
            "order": "1"
          },
          {
            "type": "schedule",
            "label": "Schedule view",
            "iconClass": "fa-calendar-o",
            "isDefault": false,
            "order": "2"
          }
        ],
        "checkin_before_minutes": 30,
        "reservation_paths": [
          {
            "value": "browse_all",
            "displayValue": "Browse all",
            "availableFor": true
          },
          {
            "value": "browse_favorites",
            "displayValue": "Browse favorites",
            "availableFor": false
          },
          {
            "value": "browse_near_a_person",
            "displayValue": "Browse near a person",
            "availableFor": true
          },
          {
            "value": "browse_by_area",
            "displayValue": "Browse by area",
            "availableFor": true
          }
        ],
        "override_approval_policy": "never_required"
      },
      "notification_recipients": null,
      "notification_custom_message": null,
      "opened_by": {
        "sys_id": "6816f79cc0a8016401c5a33be04be441",
        "value": "6816f79cc0a8016401c5a33be04be441",
        "displayValue": "System Administrator",
        "display_value": "System Administrator",
        "name": "System Administrator",
        "user_name": "admin",
        "table": "sys_user",
        "avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
        "initials": "SA",
        "email": "admin@example.com",
        "label": "System Administrator, Finance"
      },
      "requested_for": {
        "sys_id": "6816f79cc0a8016401c5a33be04be441",
        "value": "6816f79cc0a8016401c5a33be04be441",
        "displayValue": "System Administrator",
        "display_value": "System Administrator",
        "name": "System Administrator",
        "user_name": "admin",
        "table": "sys_user",
        "avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
        "initials": "SA",
        "email": "admin@example.com",
        "label": "System Administrator, Finance"
      },
      "auto_conflict_resolution_state": {
        "value": null,
        "display_value": null
      },
      "parent_reservation": {},
      "edit_restriction": {
        "value": "no_restriction",
        "display_value": "No restriction"
      },
      "source": {
        "value": "servicenow",
        "display_value": "Workplace Services"
      },
      "source_icon": {
        "classNames": "fa fa-calendar-check-o",
        "tooltip": "Reservation is confirmed",
        "imgSrc": ""
      },
      "shift": null,
      "hasPrivateReservation": true,
      "reservationAcl": {
        "write": {
          "record": true,
          "fields": {
            "subject": true,
            "sensitivity": true,
            "requested_for": true,
            "number_of_attendees": true,
            "location": true,
            "is_private": true
          },
          "allFields": true
        },
        "read": true
      }
    },
    "reservationAcl": {
      "write": {
        "record": true,
        "fields": {
          "subject": true,
          "sensitivity": true,
          "requested_for": true,
          "number_of_attendees": true,
          "location": true,
          "is_private": true
        },
        "allFields": true
      },
      "read": true
    }
  }
}

WSD Reservation - GET /api/sn_wsd_rsv/reservation/get_user_reservations

Retrieves the list of reservation for a specified user for the next seven days.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/get_user_reservations

Default URL: /api/sn_wsd_rsv/reservation/get_user_reservations

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
NameDescription
userIdSys\_id of the user whose reservations to return.Data type: String Table: User \[sys\_user\]
NameDescription
None 

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
resultReservation return results.Data type: Object 
"result":{
  "informEmployeePrivacy": Boolean,
  "reservationsByDate": {Object},
  "searchEndDate": "String",
  "searchStartDate": "String",
  "sortedReservationDates" : [Array],
  "workplaceProfile": {Object}
}
result.informEmployeePrivacyFlag that indicates whether to display a message when reservations are returned that are marked as private.Possible values: - true: Display a message to the user that there are private reservations that are not displayed. - false: Don't display any message. Data type: Boolean
result.reservationsByDateDetails about each reservation by date.Data type: Object - each date in its own Array 
"reservationsByDate": {
  string: [
    {
      "building": {Object},
      "floor": {Object},
      "location": {Object}
    }
  ]
}
result.reservationsByDate.buildingBuilding where the reservable is located.Data type: Object 
"building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
Table: Building \[sn\_wsd\_core\_building\]
result.reservationsByDate.building.​display\_valueDisplay value for the building.Data type: String
result.reservationsByDate.building.sys\_idSys\_id of the associated building record.Data type: String
result.reservationsByDate.building.timezoneDetails of the time zone for the building.Data type: Object 
"timezone": {
  "displayValue": "String",
  "value": "String"
}
result.reservationsByDate.building.timezone.​display\_valueDisplay value of the time zone in which the associated building resides.Data type: String
result.reservationsByDate.building.timezone.​sys\_idSys\_id of the time zone record in which the associated building resides.Data type: String
result.reservationsByDate.building.valueInternal value for the building.Data type: String
result.reservationsByDate.floorDetails about the floor associated with the reservation.Data type: Object 
"floor": {
  "displayValue": "String",
  "value": "String"
}
result.reservationsByDate.floor.displayValueDisplay number of the floor on which the reservable resides, such as 12.Data type: String
result.reservationsByDate.floor.valueInternal value of the floor on which the reservation resides.Data type: String
result.reservationsByDate.locationDetails on the location of the reservation.Data type: Object 
"location": {
  "displayValue": "String",
  "type": "String",
  "value": "String"
}
result.reservationsByDate.location.​displayValueDisplay value of the location, such as South Parks.Data type: String
result.reservationsByDate.location.typeType of location, such as workplace/desk, cafe, or gym.Data type: String
result.reservationsByDate.location.valueInternal value for the location, such as south\_parks.Data type: String
result.searchEndDateEnd date of the reservation search. Seven days from the start date.Format: yyyy-mm-dd Data type: String
result.searchStartDateStart date of the reservation search. Date on which the endpoint was called.Format: yyyy-mm-dd Data type: String
result.sortedReservationDatesDates on which the specified user has reservations for the next seven days, sorted in date order.Data type: Array
result.workplaceProfileUsers workplace profile. Describes where the specified user works.Data type: Object 
"reservationsByDate": {
  "building": {Object},
  "floor": {Object},
  "location": {Object}
}
result.workplaceProfile.buildingBuilding where the user works.Data type: Object 
"building": {
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
Table: Building \[sn\_wsd\_core\_building\]
result.workplaceProfile.building.display\_valueDisplay value for the building.Data type: String
result.workplaceProfile.building.sys\_idSys\_id of the associated building record.Data type: String
result.workplaceProfile.building.timezoneDetails of the time zone for the building.Data type: Object 
"timezone": {
  "displayValue": "String",
  "value": "String"
}
result.workplaceProfile.building.timezone.​display\_valueDisplay value of the time zone in which the associated building resides.Data type: String
result.workplaceProfile.building.timezone.​sys\_idSys\_id of the time zone record in which the associated building resides.Data type: String
result.workplaceProfile.building.valueInternal value for the building.Data type: String
result.workplaceProfile.floorDetails about the floor on which the user works.Data type: Object 
"floor": {
  "displayValue": "String",
  "value": "String"
}
result.workplaceProfile.floor.displayValueDisplay number of the floor on which the user works, such as Floor 8.Data type: String
result.workplaceProfile.floor.valueInternal value of the floor on which the user works.Data type: String
result.workplaceProfile.locationDetails on the location of the user.Data type: Object 
"location": {
  "displayValue": "String",
  "type": "String",
  "value": "String"
}
result.workplaceProfile.location.displayValueDisplay value of the location, such as San Diego.Data type: String
result.workplaceProfile.location.typeType of location, such as desk or office.Data type: String
result.workplaceProfile.location.valueInternal value for the location, such as san\_diego.Data type: String

cURL request

The following code example shows how to call this endpoint.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get_user_reservations?userId=2de07e1887cb89106342b846dabb35fe" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Return results:

{
  "result": {
    "sortedReservationDates": [
      "2023-01-24"
    ],
    "workplaceProfile": {
      "location": {
        "displayValue": "DDC-A2.0016A",
        "value": "96d3139977220110b3d7be377b5a9918",
        "externalId": "0e7bddfb475a011064062782846d43c2",
        "type": "Workspace/Desk"
      },
      "floor": {
        "displayValue": "Floor 2",
        "value": "68d31f5977220110b3d7be377b5a991b"
      },
      "building": {
        "displayValue": "Building A",
        "value": "dea39b1977220110b3d7be377b5a9955",
        "timezone": {
          "value": "Europe/Paris",
          "displayValue": "Europe/Paris"
        }
      }
    },
    "reservationsByDate": {
      "2023-01-24": [
        {
          "location": {
            "displayValue": "A1-02-04",
            "value": "3e41e94adb7210106c731dcd1396198c",
            "externalId": "",
            "type": "Workspace/Desk"
          },
          "floor": {
            "displayValue": "Floor 1",
            "value": "fc7368cedb3650106c731dcd13961902"
          },
          "building": {
            "displayValue": "CAL-B1",
            "value": "94e264cedb3650106c731dcd13961919",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          }
        },
        {
          "location": {
            "displayValue": "A1-02-02",
            "value": "9841e94adb7210106c731dcd13961914",
            "externalId": "",
            "type": "Workspace/Desk"
          },
          "floor": {
            "displayValue": "Floor 1",
            "value": "fc7368cedb3650106c731dcd13961902"
          },
          "building": {
            "displayValue": "CAL-B1",
            "value": "94e264cedb3650106c731dcd13961919",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          }
        },
        {
          "location": {
            "displayValue": "A1-02-03",
            "value": "fd41a94adb7210106c731dcd1396195a",
            "externalId": "",
            "type": "Workspace/Desk"
          },
          "floor": {
            "displayValue": "Floor 1",
            "value": "fc7368cedb3650106c731dcd13961902"
          },
          "building": {
            "displayValue": "CAL-B1",
            "value": "94e264cedb3650106c731dcd13961919",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          }
        }
      ]
    },
    "searchStartDate": "2023-01-24",
    "searchEndDate": "2023-01-31",
    "informEmployeePrivacy": true
  }
}

WSD Reservation - GET /api/sn_wsd_rsv/reservation/icalendar/{sys_id}

Generates an iCalendar file body for a specified reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/icalendar/{sys_id}

Default URL: /api/sn_wsd_rsv/reservation/icalendar/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
sys\_idSys\_id of the reservation for which to generate an iCalendar file body.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
NameDescription
None 
NameDescription
None 

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
resultiCalendar file body for the specified reservation.Data type: String

cURL request

The following code example shows how to call this endpoint to create an iCalender body.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/icalendar/60d26a0f47578910003a4587746d4331" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Return results:

{
  "result": "BEGIN:VCALENDAR\nPRODID:-//Service-now.com//Outlook 11.0 MIMEDIR//EN\nVERSION:2.0\nMETHOD:REQUEST\nBEGIN:VEVENT\nATTENDEE;ROLE=REQ-PARTICIPANT;RSVP=TRUE:MAILTO:workplace_user@example.com\nDTSTART:20220521T050000Z\nDTEND:20220521T060000Z\nUID:60d26a0f47578910003a4587746d4331\nDTSTAMP:20220511T044018Z\nSUMMARY:For user 1\nDESCRIPTION:Dear System Administrator,\\n\\nThank you for your reservation.\\n\\nYou can find more details on your reservation, or manage your reservation using the following link: https://damay2.service-now.com/ws?id=wsd_reservation_summary&reservation_id=60d26a0f47578910003a4587746d4331\\n\\nKind regards,\\nWorkplace Services Team\nLOCATION:Berlin\nCLASS:PUBLIC\nORGANIZER;CN=Workplace User:MAILTO:workplace_user@example.com\nATTENDEE;ROLE=REQ-PARTICIPANT;CN=Workplace User:RSVP=TRUE:MAILTO:workplace_user@example.com\nEND:VEVENT\nEND:VCALENDAR"
}

WSD Reservation - GET /api/sn_wsd_rsv/reservation/list

Retrieves the list of reservations belonging to a specified user.

This endpoint only returns reservations that were requested for or opened by the specified user.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/list

Default URL: /api/sn_wsd_rsv/reservation/list

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
NameDescription
encodedQueryEncoded query to use to filter the returned reservation record results. All fields within the Workplace Reservation \[sn\_wsd\_rsv\_reservation\] table are valid within the query.For example, `active=true^requested_for=2de07e1887cb89106342b846dabb35fe​^building=4703a4cedb3650106c731dcd13961945` Data type: String
endIndexLast reservation record in the results set to return when specifying indexes for pagination. If this value is greater than the available number of return results records, all remaining records are returned.Data Type: Number
orderByEndDescFlag that indicates whether to return the return results in start time descending order. Valid values: - true: Return the results in descending order. - false: Return the results in ascending order. Default: false
searchCriteriaText that has to match within the reservation for it to be included in the return results. The endpoint checks for this value in the following fields: - configuration\_item.name - location.name - private\_subject - requested\_for.name - subject Data Type: String
startIndexStarting record for which to return records, zero-based. Use this parameter to paginate through large record sets.Data Type: String Default: 0
userId

Sys_id of a user to filter out of the returned reservation information.When this value is passed, the endpoint filters out those reservations where the requested_for or opened_by field is equal to the currently logged-in user. From that reservation list, it then filters out those reservation where the requested_for or opened_by is equal to the passed userId.

Data type: String

Default: Returns all reservations where the requested_for or opened_by fields is equal to currently logged-in user.

Table: User [sys_user]

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the response body. Supported types: application/json or application/xml. Default: application/json
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
result.reservationDetails about the reservation.Data type: Object 
"reservation": {
  "active": Boolean,
  "attendees": [Array],
  "check_in_state": {Object},
  "end": "String",
  "external_ical": "String",
  "external_id": "String",
  "is_parent": Boolean,
  "is_private": Boolean,
  "informEmployeePrivacy": Boolean.
  "last_updated_sub_source": {Object},
  "location" {Object},
  "number": "String",
  "number_of_attendees": Number,
  "recording_details": [Array],
  "reservable_module": {Object},
  "reservation_purpose": {Object},
  "reservation_type": {Object},
  "reservation_subtype": {Object},
  "sensitivity": {Object},
  "start": "String",
  "state": {Object},
  "source_reservation": "String",
  "subject": "String",
  "sub_source": {Object},
  "sync_state": {Object},
  "sys_created_on: "String",
  "sys_id": "String",
  "sys_updated_on": "String",
  "virtual_meeting": "String"
}
result.reservation.activeFlag that indicates whether the reservation is active.Valid values: - true: Reservation is active. - false: Reservation is inactive. Data type: Boolean
result.reservation.attendeesList of attendees for the reservation.Data type: Array of Objects 
"attendees": [
  {
    "avatar": "String",
    "displayValue": "String",
    "display_value": "String",
    "email": "String",
    "initials": "String",
    "label": "String",
    "name": "String",
    "sys_id": "String",
    "table": "String",
    "user_name": "String",
    "value": "String"
  }
]
result.reservation.attendees.avatarSys\_id of the avatar associated with the attendee.Data type: String Table: Attachments \[sys\_attachment\]
result.reservation.attendees.displayValueDisplay value for the attendee.Data type: String
result.reservation.attendees.display\_valueDisplay value of the attendee. Same as displayValue.Data type: String
result.reservation.attendees.emailAttendee's email address.Data type: String
result.reservation.attendees.initialsAttendee's initials.Data type: String
result.reservation.attendees.nameAttendee's name.Data type: String
result.reservation.attendees.sys\_idSys\_id of the attendee record.Data type: String
result.reservation.attendees.tableTable in which the attendee record exists.Data type: String
result.reservation.attendees.user\_nameAttendee's user name.Data type: String
result.reservation.attendees.valueInternal value of the attendee.Data type: String
result.reservation.check\_in\_stateDetails about the check-in state of the reservation.Data type: Object 
"check_in_state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.check\_in\_state.​display\_valueDisplay value for the current check-in state of the reservation, such as In progress or complete.Data type: String
result.reservation.check\_in\_state.valueInternal value for the current check-in state of the reservation, such as 2.Data type: String
result.reservation.edit\_restrictionDescription of the user edit restrictions for the reservation, such as no\_restrictions, service\_only, or fully\_restricted.Data type: Object 
"edit_restriction": {
  "display_value": "String",
  "value": "String"
}
result.reservation.edit\_restriction.display\_​valueDisplay value for the edit restrictions for the reservation, such as `No restriction`.Data type: String
result.reservation.edit\_restriction.valueInternal value for the edit restrictions for the reservation, such as `no_restriction`.Data type: String
result.reservation.endReservation end date and time.Data type: String Format: UTC: yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z
result.reservation.external\_icalUnique external iCalendar identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String
result.reservation.external\_idUnique external identification of the reservation. Use this value to identify the reservation when this is a calendar sync related reservation.Data type: String
result.reservation.is\_parentFlag that indicates whether this reservation is a parent reservation.Possible values: - true: Parent reservation. - false: Not a parent reservation. Data type: Boolean
result.reservation.is\_privateFlag that indicates whether the reservation is private. If private, the reservation doesn't appear to anyone except the owner.For additional information on these privacy settings, see Location privacy settings and impact. Valid values: - true: Reservation is private. - false: Reservation isn't private. Data type: Boolean Default: Value set for privacy in the system properties.
result.reservation.last\_updated\_sub\_sourceDetails 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 
"last_updated_sub_source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.last\_updated\_sub\_source.​display\_valueDisplay 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
result.reservation.last\_updated\_sub\_source.​valueInternal 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
result.reservation.locationDetails about the location associated with the reservation.Data type: Object 
"location": {
  "active": Boolean,
  "area": {Object},
  "building": {Object},
  "campus": {Object},
  "capacity": Number,
  "description": "String",
  "display_value": "String",
  "email": "String",
  "floor": {Object},
  "label_value": "String",
  "name": "String",
  "number_of_attendees": Number,
  "region": {Object},
  "reservable_module": {Object},
  "reservation": {Object},
  "site": {Object},
  "state": {Object},
  "sys_id": "String"
}
result.reservation.location.areaDetails about the area associated with the location.Data type: Object 
"area": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.area.activeFlag that indicates whether the area is active.Valid values: - true: Area is active. - false: Area is inactive. Data type: Boolean
result.reservation.location.area.display\_valueDisplay value of the area to which this location belongs, such as Desk A2.Data type: String
result.reservation.location.area.sys\_idSys\_id of the area to which this location belongs.Data type: String Table: Area \[sn\_wsd\_core\_area\]
result.reservation.location.buildingDetails about the building associated with the location.Data type: Object 
"building": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String",
  "timezone": {Object}
}
result.reservation.location.building.activeFlag that indicates whether the building is active.Valid values: - true: Building is active. - false: Building is inactive. Data type: Boolean
result.reservation.location.building.​display\_valueDisplay value of the building to which this location belongs, such as AMS - Bld1.Data type: String
result.reservation.location.building.sys\_idSys\_id of the building to which this location belongs.Data type: String Table: Building \[sn\_wsd\_core\_building\]
result.reservation.location.building.timezoneDetails about the time zone associated with the location.Data type: Object 
"timezone": {
  "displayValue": "String",
  "value": "String"
}
result.reservation.location.building.timezone.​display\_valueDisplay value for the time zone to which this location belongs.Data type: String
result.reservation.location.building.timezone.​valueInternal value for the time zone to which this location belongs.Data type: String
result.reservation.location.campusDetails about the campus associated with the location.Data type: Object 
"campus": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.campus.activeFlag that indicates whether the campus is active.Valid values: - true: Campus is active. - false: Campus is inactive. Data type: Boolean
result.reservation.location.campus.​display\_valueDisplay value of the campus to which this location belongs, such as Amsterdam Campus.Data type: String
result.reservation.location.campus.sys\_idSys\_id of the campus to which this location belongs.Data type: String Table: Campus \[sn\_wsd\_core\_campus\]
result.reservation.location.capacityMaximum number of occupants for the location.Data type: Number
result.reservation.location.descriptionBrief description of the location.Data type: String
result.reservation.location.display\_valueValue to display in the UI for this location.Data type: String
result.reservation.location.emailEmail address for the location.Data type: String
result.reservation.location.floorDetails about the floor associated with the location.Data type: Object 
"floor": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.floor.activeFlag that indicates whether the floor is active.Valid values: - true: Floor is active. - false: Floor is inactive. Data type: Boolean
result.reservation.location.floor.display\_valueDisplay value of the floor to which this location belongs, such as First floor.Data type: String
result.reservation.location.floor.sys\_idSys\_id of the floor to which this location belongs.Data type: String Table: Floor \[sn\_wsd\_core\_floor\]
result.reservation.location.label\_valueType of value specified in the name parameter, such as Room name.Data type: String
result.reservation.location.nameName of the location.Data type: String
result.reservation.location.numberReservation number.Data type: String
result.reservation.location.number\_of\_​attendeesNumber of attendees for the reservation.Data type: Number
result.reservation.location.regionDetails about the region associated with the location.Data type: Object 
"region": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.location.region.activeFlag that indicates whether the region is active.Valid values: - true: Region is active. - false: Region is inactive. Data type: Boolean
result.reservation.location.region.​display\_valueDisplay value of the region to which this location belongs, such as Europe.Data type: String
result.reservation.location.region.sys\_idSys\_id of the region to which this location belongs.Data type: String Table: Region \[sn\_wsd\_core\_region\]
result.reservation.location.requested\_forDetails about the person for whom the reservation was requested on behalf of.Data type: Object 
"requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
result.reservation.location.requested\_for.​nameName of the user for whom the reservation was requested for.Data type: String
result.reservation.location.requested\_for.​sys\_idSys\_id of the user for whom the reservation is being requested.Data type: String Table: User \[sys\_user\]
result.reservation.location.requested\_for.​user\_nameUser name of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservationDetails about the reservation associated with the location.Data type: Object 
"reservation": {
  "active": Boolean,
  "number": "String",
  "number_of_attendees": Number,
  "requested_for": {Object},
  "state": {Object},
  "sys_id": "String"
}
result.reservation.location.reservation.activeFlag that indicates whether the reservation is active.Valid values: - true: Reservation is active. - false: Reservation is inactive. Data type: Boolean
result.reservation.location.reservation.numberReservation number.Data type: String
result.reservation.location.reservation.​number\_of\_attendeesNumber of attendees of the reservation.Data type: Number
result.reservation.location.reservation.​requested\_forDetails about the person for whom the reservation was requested on behalf of.Data type: Object 
"requested_for": {
  "name": "String",
  "sys_id": "String",
  "user_name": "String"
}
result.reservation.location.reservation.​requested\_for.nameName of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservation.​requested\_for.sys\_idSys\_id of the requested for user.Data type: String Table: User \[sys\_user\]
result.reservation.location.reservation.​requested\_for.user\_nameUser name of the user for whom the reservation was requested for.Data type: String
result.reservation.location.reservable\_moduleDetails about the reservable module associated with the reservation.Data type: Object 
"reservable_module": {
  "inline_title": "String",
  "name": "String",
  "sys_id": "String",
  "title": "String"
}
result.reservation.location.reservable\_module.​inline\_titleInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String
result.reservation.location.reservable\_module.​nameName of the reservable module.Data type: String
result.reservation.location.reservable\_module.​sys\_idSys\_id of the reservable module.Data type: String
result.reservation.location.reservable\_module.​titleTitle of the reservable module.Data type: String
result.reservation.location.siteSite to which the location belongs.Data type: Object 
"site": {
  "active": Boolean,
  "display_value": "String",
  "sys_id": "String"
}
Table: Site \[sn\_wsd\_core\_site\]
result.reservation.location.site.activeFlag that indicates whether the site is active.Valid values: - true: Site is active. - false: Site is inactive. Data type: Boolean
result.reservation.location.site.display\_valueDisplay value of the site to which this location belongs, such as Western Europe.Data type: String
result.reservation.location.site.sys\_idSys\_id of the site to which this location belongs.Data type: String Table: Site \[sn\_wsd\_core\_site\]
result.reservation.location.stateDetails about the state of the reservation for the location.Data type: Object 
"state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.location.state.display\_valueDisplay value for the current state of the reservation, such as confirmed.Data type: String
result.reservation.location.state.valueInternal value for the current state of the reservation, such as 2.Data type: String
result.reservation.location.sys\_idSys\_id of the associated location record.Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
result.reservation.notification\_custom\_​messageCustom message for the notification sent to the recipients listed in reservation.notification_recipients.Data type: String
result.reservation.notification\_recipientsList of recipients that receive notification about the reservation.Data type: Array of Objects 
"notification_recipients":[
  {
    "name": "String",
    "sys_id": "String",
    "user_name": "String"
  }
]
result.reservation.notification\_recipients.nameName of the recipient.Data type: String
result.reservation.notification\_recipients.sys\_idSys\_id of the recipient.Data type: String Table: User \[sys\_user\]
result.reservation.notification\_recipients.​user\_nameUser name of the recipient.Data type: String
result.reservation.numberUnique number of the reservation record. You can use this value to query the reservation.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
result.reservation.opened\_byDetails about the user that created the reservation.Data type: Object 
"opened_by": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
result.reservation.opened\_by.avatarAvatar for the user that opened the reservation.Data type: String
result.reservation.opened\_by.displayValueDisplay value of the opened by user.Data type: String
result.reservation.opened\_by.display\_valueDisplay value of the opened by user.Data type: String
result.reservation.opened\_by.emailEmail address for the user that opened the reservation.Data type: String
result.reservation.opened\_by.initialsInitials of the user that opened the reservation.Data type: String
result.reservation.opened\_by.labelLabel for the user that opened the reservation. This is a combination of the title and department of the user.Data type: String
result.reservation.opened\_by.nameName of the user that opened the reservation.Data type: String
result.rservation.opened\_by.sys\_idSys\_id\_of the user that opened the reservation.Data type: String Table: User \[sys\_user\]
result.rservation.opened\_by.tableTable that contains the user record.Data type: String
result.reservation.opened\_by.user\_nameUser name of the user that opened the reservation.Data type: String
result.reservation.opened\_by.valueInternal value of the user that opened the reservation.Data type: String
result.reservation.numberReservation number.Data type: String
result.reservation.number\_of\_attendeesNumber of attendees in this reservation.Data type: Number
result.reservation.recording\_detailsDetails about the recordings associated with the reservation \(meeting\).Data type: Array of Objects 
"recording_details": [
  "recording_url": "String"
]
result.reservation.recording\_details.​recording\_urlURL of the recordings associated with the reservation.Data type: String
result.reservation.requested\_forDetails about the user that the reservation was made on behalf of.Data type: Object 
"requested_for": {
  "avatar": "String",
  "displayValue": "String",
  "display_value": "String",
  "email": "String",
  "initials": "String",
  "label": "String",
  "name": "String",
  "sys_id": "String",
  "table": "String",
  "user_name": "String",
  "value": "String"
}
result.reservation.requested\_for.avatarAvatar for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.displayValueDisplay value of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.display\_valueDisplay value of the user that the reservation was made on behalf of. Same as displayValue.Data type: String
result.reservation.requested\_for.emailEmail address for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.initialsInitials of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.labelLabel for the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.nameName of the user that the reservation was made on behalf of.Data type: String
result.rservation.requested\_for.sys\_idSys\_id\_of the user that the reservation was made on behalf of.Data type: String Table: User \[sys\_user\]
result.rservation.requested\_for.tableTable that contains the user record.Data type: String
result.reservation.requested\_for.user\_nameUser name of the user that the reservation was made on behalf of.Data type: String
result.reservation.requested\_for.valueInternal value of the user that the reservation was made on behalf of.Data type: String
result.reservation.reservable\_moduleDetails for the requested reservable module.Data type: Object 
"reservable_module": {
  "allow_invitees": Boolean,
  "allow_whole_day": Boolean,
  "apply_to_shift": Boolean,
  "browse_by_area_enabled": Boolean,
  "browse_near_a_person_enabled": Boolean,
  "buildingSysIds": [Array],
  "checkin_before_minutes": Number,
  "display_number_of_attendees": Boolean,
  "display_on_behalf_of": Boolean,
  "display_sensitivity": Boolean,
  "display_value": "String",
  "enable_browse_by_area": Boolean,
  "enable_browse_near_a_person": Boolean,
  "enable_facet_filter": Boolean,
  "enable_group_reservations": Boolean,
  "enable_ical_generation": Boolean,
  "font_awesome_icon": "String",
  "inline_title": "String",      
  "layout_mapping": {Object},
  "max_days_in_future": Number,
  "max_occurrences": Number,
  "name": "String",
  "override_approval_policy": "String",
  "require_cancel_notes": Boolean,
  "require_cc_dept_check": Boolean,
  "require_subject": Boolean,
  "reservable_columns": [Array],
  "reservable_container_field": "String",
  "reservable_filter": "String",
  "reservable_quantity_field": "String",
  "reservable_table": "String",
  "reservable_type": "String",
  "reservable_views": [Array],
  "reservation_paths": [Array],
  "search_limit": Number,
  "selection_type": "String",
  "short_description": "String",
  "show_map_view": Boolean,
  "sys_id": "String",
  "timeSlots": [Array],
  "title": "String",
  "virtual_meeting_provider": {Object}
}
result.reservation.reservable\_module.​allow\_inviteesFlag that indicates whether employees are able to add invitees to the reservation. Valid values: - true: Allow employees to add invitees to the reservation. - false: Don't allow employees to add invitees to the reservation. Data type: Boolean
result.reservation.reservable\_module.​allow\_whole\_dayFlag that indicates whether users can reserve the reservable for the entire day. Valid values: - true: Allow users to reserve for the entire day. - false: Don't allow users to reserve for the entire day. Data type: Boolean
result.reservation.reservable\_module.​apply\_to\_shiftFlag that indicates whether shift-based reservations are enabled for the reservable module. Valid values: - true: Allow shift-based reservations. - false: Don't allow shift-based reservations. Data type: Boolean
result.reservation.reservable\_module.​browse\_by\_area\_enabledFlag that indicates whether users are able to search for reservable modules by area.Valid values: - true: Allow users to browse reservable modules by area. - false: Don't allow users to browse reservable modules by area. Data type: Boolean
result.reservation.reservable\_module.​browse\_near\_a\_person\_enabledFlag that indicates whether users are able to search for reservable modules located by a specified person.Valid values: - true: Allow users to browse reservable modules near a person. - false: Don't allow users to browse reservable modules near a person. Data type: Boolean
result.reservation.reservable\_module.​buildingSysIdsList of sys\_ids of the buildings associated with the reservable module.Data type: Array of Strings
result.reservation.reservable\_module.​checkin\_before\_minutesAmount of time before a reservation starts that a user can check into their reservation.Unit: Minutes Data type: Number
result.reservation.reservable\_module.​display\_number\_of\_attendeesFlag that indicates whether users can specify the number of attendees in the reservation. Valid values: - true: Users can specify the number of attendees. - false: Users can't specify the display number of attendees. Data type: Boolean
result.reservation.reservable\_module.​display\_on\_behalf\_ofFlag that indicates whether reservations can be made on behalf of someone else. Valid values: - true: On behalf of supported. - false: On behalf of not supported. Data type: Boolean
result.reservation.reservable\_module.​display\_sensitivityFlag that indicates whether users can set the sensitivity of the reservation, such as normal or private.Valid values: - true: Able to set sensitivity. - false: Not able to set sensitivity. Defaults to normal. Data type: Boolean
result.reservation.reservable\_module.​display\_valueDisplay value of the reservable module.Data type: String
result.reservation.reservable\_module.​enable\_browse\_by\_area

Flag that indicates whether users are able to search for reservable modules by area. Same as browse_by_area_enabled.Valid values:

  • true: Allow users to browse reservable modules by area.
  • false: Don't allow users to browse reservable modules by area.

Data type: Boolean

result.reservation.reservable\_module.​enable\_browse\_near\_a\_person

Flag that indicates whether users are able to search for reservable modules located by a specified person. Same asbrowse_near_a_person_enabled.Valid values:

  • true: Allow users to browse reservable modules near a person.
  • false: Don't allow users to browse reservable modules near a person.

Data type: Boolean

result.reservation.reservable\_module.​enable\_facet\_filterFlag 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: - true: Facet filters are enabled. - false: Facet filters aren't enabled. Data type: Boolean
result.reservation.reservable\_module.​enable\_group\_reservationsFlag that indicates whether users can make a group reservation.Valid values: - true: Able to make group reservations. - false: Not able to make group reservations. Data type: Boolean
result.reservation.reservable\_module.​enable\_ical\_generationFlag that indicates whether users can generate an iCalendar for the reservation.Valid values: - true: iCalendar generation allowed. - false: iCalendar generation isn't allowed. Data type: Boolean
result.reservation.reservable\_module.​font\_awesome\_iconName of the font icon attached to the reservable module.Data type: String
result.reservation.reservable\_module.​inline\_titleInline title of the reservable module. The title appears in line with the descriptive text on the Workplace service portal.Data type: String
result.reservation.reservable\_module.​layout\_mappingDetails about the structure of the layout mapping of locations. Use this data to lay out the information in the UI. Data type: Object 
"layout_mapping": {
  "body": [Array],
  "description": [Array],
  "image": "String",
  "subtitle": [Array],
  "subtitle_asc": [Array],
  "title": [Array]
}
result.reservation.reservable\_module.​layout\_mapping.bodyPlaceholder for mapping the front-end UI data.Data type: Array of Objects 
"body": [
  {
    "field": "String",
    "field_to_display": "String",
    "icon": "String",
    "label": "String"
  }
]
result.reservation.reservable\_module.​layout\_mapping.body.fieldPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.field\_to\_displayPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.iconPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.body.labelPlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.descriptionPlaceholder for mapping the front-end UI data. Description of the layout mapping.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.imagePlaceholder for mapping the front-end UI data.Data type: String
result.reservation.reservable\_module.​layout\_mapping.subtitlePlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.subtitle\_ascPlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​layout\_mapping.titlePlaceholder for mapping the front-end UI data.Data type: Array
result.reservation.reservable\_module.​max\_days\_in\_futureMaximum number of the days in the future that a user can reserve the reservable module.Data type: Number
result.reservation.reservable\_module.​max\_occurrencesMaximum number of recurring reservation occurrences if recurring reservations are available for the reservable module.Data type: Number
result.reservation.reservable\_module.nameName of the reservable module.Data type: String
result.reservation.reservable\_module.​override\_approval\_policy

Option to specify how to implement the approval policy. Choices:

  • No override: The approval policy is implemented as set in the Requires approval field of a workplace space or room.
  • Always require approval: The approval policy is required regardless of what is set in the Requires approval field of a workplace space or room.
  • Never require approval: The approval policy is removed regardless of what is set in the Requires approvall field of a workplace space or room.

Data type: String

result.reservation.reservable\_module.​require\_cancel\_notesFlag that indicates whether users must enter a cancellation note before cancelling a reservable module.Valid values: - true: Cancellation note required. - false: Cancellation note not required. Data type: Boolean
result.reservation.reservable\_module.​require\_cc\_dept\_checkFlag 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: - true: Check for a mismatch. - false: Don't check for a mismatch. Data type: Boolean
result.reservation.reservable\_module.​require\_subjectFlag that indicates whether the user must enter a subject when making the reservation.Valid values: - true: Subject required. - false: Subject isn't required. Data type: Boolean
result.reservation.reservable\_module.​reservable\_columnsList of the columns of a reservable.Data type: Array Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
result.reservation.reservable\_module.​reservable\_container\_fieldLevel of the container, such as a group of desks in a specific area.Data type: String
result.reservation.reservable\_module.​reservable\_filterFilter 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
result.reservation.reservable\_module.​reservable\_quantity\_fieldReservable 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.Data type: String
result.reservation.reservable\_module.​reservable\_tableTable that contains the reservable workplace items.Data type: String
result.reservation.reservable\_module.​reservable\_typeType of the reservable item, such as location.Data type: String
result.reservation.reservable\_module.​reservable\_viewsDetails about the different views associated with the reservable module, such as card view or schedule view.Data type: Object 
"reservable_views": {
  "iconClass": "String",
  "isDefault": Boolean,
  "label": "String",
  "order": Number,
  "type": "String"
}
Table: Reservable View \[sn\_wsd\_rsv\_reservable\_view\]
result.reservation.reservable\_module.​reservable\_views.iconClassIcon class of the reservable view.Data type: String
result.reservation.reservable\_module.​reservable\_views.isDefaultFlag that indicates whether to make this reservable view the default for reservable modules. Valid values: - true: Make default. - false: Don't make default. Data type: Boolean
result.reservation.reservable\_module.​reservable\_views.labelName of the reservable view.Data type: String
result.reservation.reservable\_module.​reservable\_views.orderOrder 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
result.reservation.reservable\_module.​reservable\_views.typeBackend name of the reservable view. Used for internal processing.Data type: String
result.reservation.reservable\_module.​reservation\_pathsReservation paths associated with the reservable modules such as Browse all, Browse near a person.Data type: Array of Objects 
"reservation_paths": [
  {
    "displayValue": "String",
    "value": "String"
  }
]
result.reservation.reservable\_module.​reservation\_paths.display\_valueDisplay value for the reservation path, such as "Browse near a person".Data type: String
result.reservation.reservable\_module.​reservation\_paths.valueInternal value for the reservation path, such as "browse\_near\_a\_person".Data type: String
result.reservation.reservable\_module.​search\_limitMaximum number of search results to return when a user searches for a workplace location.Data type: Number
result.reservation.reservable\_module.​selection\_typeType of selection to display in the search results. Can be one of the following options: - Specific unit: The search result displays every workplace item. - Container: The search result displays the parent or container of the workplace items. Data type: String
result.reservation.reservable\_module.​short\_descriptionBrief description of the reservable module.Data type: String
result.reservation.reservable\_module.​show\_map\_viewFlag that indicates whether to enable the map view for reservable modules. Valid values: - true: Enable map view. - false: Don't enable map view. Data type: Boolean
result.reservation.reservable\_module.sys\_idSys\_id of the reservable module.Data type: String
result.reservation.reservable\_module.timeSlotsDetails about the time slots associated for a reservable module.Data type: Array of Objects 
[
  {
    "name": "String",
    "short_description": "String",
    "slot_end": "String",
    "slot_start": "String",
    "sys_id": "String"
  }
]
result.reservation.reservable\_module.​timeSlots.nameName of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.short\_descriptionBrief description of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.slot\_endEnd time of the time slot.Data type: String
result.reservation.reservable\_module.​timeSlots.slot\_startStart time of the slot.Data type: String
result.reservation.reservable\_module.​timeSlots.sys\_idSys\_id of the time slot record.Data type: String Table: Time Slot \[sn\_wsd\_rsv\_time\_slot\]
result.reservation.reservable\_module.titleTitle of the reservable module.Data type: String
result.reservation.reservable\_module.​virtual\_meeting\_providerDetails about the virtual provider associated with the reservable module.Data type: Object 
"virtual_meeting_provider": {
  "display_value": "String",
  "sys_id": "String"
}
result.reservation.reservable\_module.​virtual\_meeting\_provider.display\_valueDisplay value of the virtual meeting provider.Data type: String
result.reservation.reservable\_module.​virtual\_meeting\_provider.sys\_idSys\_id of the virtual meeting provider.Data type: String
result.reservation.reservationAclDetails of the user access control levels \(ACL\) checks set on the associated reservation.Data type: Object 
"reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
result.reservation.reservationAcl.readFlag that indicates whether to check if the user can read this reservation.Valid values: - true: Check if user can read the reservation. - false: Don't check if user can read the reservation. Data type: Boolean
result.reservation.reservationAcl.writeDetails about the user's write capabilities for the associated reservation.Data type: Object 
"write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
result.reservation.reservationAcl.write.allFields

Flag 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:

  • true: Check if user can write to all fields specified in the reservationACL.write.fields object.
  • false: Don't check if user can write to all fields specified in the reservationACL.write.fields object

Data type: Boolean

result.reservation.reservationAcl.write.fieldsDetails of the access controls on various fields of the reservation.Data type: Object 
"fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
result.reservation.reservationAcl.write.fields.​locationFlag that indicates whether to check if the user can write to the location fields in this reservation.Valid values: - true: Check if user can write to the location fields. - false: Don't check if user can write to the location fields. Data type: Boolean
result.reservation.reservationAcl.write.fields.​number\_of\_attendeesFlag that indicates whether to check if the user can write to the number of attendees fields in this reservation.Valid values: - true: Check if user can write to the number of attendees field. - false: Don't check if user can write to the number of attendees field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​requested\_forFlag that indicates whether to check if the user can write to the requested for fields in this reservation.Valid values: - true: Check if user can write to the requested for field. - false: Don't check if user can write to the requested for field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​sensitivityFlag that indicates whether to check if the user can write to the sensitivity fields in this reservation.Valid values: - true: Check if user can write to the sensitivity field. - false: Don't check if user can write to the sensitivity field. Data type: Boolean
result.reservation.reservationAcl.write.fields.​subjectFlag that indicates whether to check if the user can write to the subject fields in this reservation.Valid values: - true: Check if user can write to the subject field. - false: Don't check if user can write to the subject fields. Data type: Boolean
result.reservation.reservationAcl.write.recordFlag that indicates whether to check if the user can write to the entire reservation record.Valid values: - true: Check if user can write to the entire reservation record. - false: Don't check if user can write to the entire reservation record. Data type: Boolean
result.reservation.reservation\_purposeDetails about the purpose of the reservation.Data type: Object 
"reservation_purpose": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_purpose.​display\_valueDisplay value for the purpose of the reservation, such as Company meeting.Data type: String
result.reservation.reservation\_purpose.valueInternal value for the purpose of the reservation, such as company\_meeting.Data type: String
result.reservation.reservation\_typeDetails about the type of the reservation.Data type: Object 
"reservation_type": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_type.​display\_valueDisplay value for the type of the reservation, such as Space.Data type: String
result.reservation.reservation\_type.valueInternal value for the type of the reservation, such as space.Data type: String
result.reservation.reservation\_subtypeDetails 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 
"reservation_subtype": {
  "display_value": "String",
  "value": "String"
}
result.reservation.reservation\_subtype.​display\_valueDisplay value for the subtype of the reservation, such as Single.Data type: String
result.reservation.reservation\_subtype.valueInternal value for the subtype of the reservation, such as single.Data type: String
result.reservation.sensitivityDetails about the sensitivity of the reservation.Data type: Object 
"sensitivity": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sensitivity.display\_valueDisplay value for the sensitivity of the reservation, such as high or low.Data type: String
result.reservation.sensitivity.valueInternal value for the sensitivity of the reservation, such as 1 or 3.Data type: String
result.reservation.shiftDetails about the shift applied to the reservation.Data type: Object 
"shift": {
  "display_value": "String",
  "name": "String",
  "shiftDetails": "String",
  "sys_id": "String"
}
result.reservation.shift.display\_valueDisplay value of the shift.Data type: String
result.reservation.shift.nameName of the shift. Same as display_value.Data type: String
Result.reservation.shift.shiftDetailsDetails of shift.Data type: String
result.reservation.shift.sys\_idSys\_id of the shift record.Data type: String Table: Shift \[sn\_wsd\_core\_shift\]
result.reservation.sourceDetails about the source for the reservation, such as Workplace Services or Google Mail..Data type: Object 
"source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.source.display\_valueDisplay value for the reservation source, such as Workplace Services.Data type: String
result.reservation.source.valueInternal value for the reservation source, such as servicenow.Data type: String
result.reservation.source\_iconDetails about the source of the icon used in the reservation. This icon is used in the UI.Data type: Object 
"source_icon": {
  "classNames": "String",
  "imgSrc": "String",
  "tooltip": "String"
}
result.reservation.source\_icon.classNamesComma-separated class names for the source icon.Data type: String
result.reservation.source\_icon.imgSrcName of the image source for source icon. This icon is stored in the Images \[db\_image\] table.Data type: String
result.reservation.source\_icon.tooltipTooltip associated with the source icon.Data type: String
result.reservation.source\_reservationSource reservation of the current reservation.For example, in the case of multiple reservations, the parent reservation is the source of the child reservation. Data type: String
result.reservation.startReservation start date and time.Data type: String Format: UTC - yyyy-mm-ddThh:mm:ssZ, such as 2021-02-05T18:00:00Z
result.reservation.subjectReservation's subject.Data type: String
result.reservation.sub\_sourceDetails 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 
"sub_source": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sub\_source.display\_valueDisplay value for the sub-source of the reservation, such as Google Calendar.Data type: String
result.reservation.sub\_source.valueInternal value of the sub-source field of the reservation, such as google\_calendar.Data type: String
result.reservation.sync\_stateDetails about the synchronization state of a reservation from another service, such as "sync\_enqueued" or "synchronized".Data type: Object 
"sync_state": {
  "display_value": "String",
  "value": "String"
}
result.reservation.sync\_state.display\_valueDisplay value for the current sync state of the reservation, such as synchronized.Data type: String
result.reservation.sync\_state.valueInternal value of the current sync state of the reservation, such as synchronized.Data type: String
result.reservation.sys\_created\_onDate and time when the reservation was created.Data type: String
result.reservation.sys\_idRequired. Sys\_id of the reservation record. Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
Result.reservation.sys\_updated\_onDate and time when the reservation was last updated. Data type: String
result.reservation.virtual\_meetingURL of the virtual meeting link.Data type: String
result.reservationAclDetails of the user access control levels \(ACL\) checks set on the associated reservation.Data type: Object 
"reservationAcl": {
  "read": Boolean,
  "write": {Object}
}
result.reservationAcl.readFlag that indicates whether to check if the user can read this reservation.Valid values: - true: Check if user can read the reservation. - false: Don't check if user can read the reservation. Data type: Boolean
result.reservationAcl.writeDetails about the user's write capabilities for the associated reservation.Data type: Object 
"write": {
  "allFields": Boolean,
  "fields": {Object},
  "record": Boolean
}
result.reservationAcl.write.allFields

Flag 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:

  • true: Check if user can write to all fields specified in the reservationACL.write.fields object.
  • false: Don't check if user can write to all fields specified in the reservationACL.write.fields object

Data type: Boolean

result.reservationAcl.write.fieldsDetails of the access controls on various fields of the reservation.Data type: Object 
"fields": {
  "location": Boolean,
  "number_of_attendees": Boolean,
  "requested_for": Boolean,
  "sensitivity": Boolean,
  "subject": Boolean
}
result.reservationAcl.write.fields.locationFlag that indicates whether to check if the user can write to the location fields in this reservation.Valid values: - true: Check if user can write to the location fields. - false: Don't check if user can write to the location fields. Data type: Boolean
result.reservationAcl.write.fields.​number\_of\_attendeesFlag that indicates whether to check if the user can write to the number of attendees fields in this reservation.Valid values: - true: Check if user can write to the number of attendees field. - false: Don't check if user can write to the number of attendees field. Data type: Boolean
result.reservationAcl.write.fields.requested\_forFlag that indicates whether to check if the user can write to the requested for fields in this reservation.Valid values: - true: Check if user can write to the requested for field. - false: Don't check if user can write to the requested for field. Data type: Boolean
result.reservationAcl.write.fields.sensitivityFlag that indicates whether to check if the user can write to the sensitivity fields in this reservation.Valid values: - true: Check if user can write to the sensitivity field. - false: Don't check if user can write to the sensitivity field. Data type: Boolean
result.reservationAcl.write.fields.subjectFlag that indicates whether to check if the user can write to the subject fields in this reservation.Valid values: - true: Check if user can write to the subject field. - false: Don't check if user can write to the subject fields. Data type: Boolean
result.reservationAcl.recordFlag that indicates whether to check if the user can write to the entire reservation record.Valid values: - true: Check if user can write to the entire reservation record. - false: Don't check if user can write to the entire reservation record. Data type: Boolean
result.standard\_services

Only populated if the include_standard_services parameter is set to true. Associated standard services, such as flip chart, projector screen, and whiteboard and markers.

Data type: Array of Objects

"standard_services": [
  {
    "font_awesome_icon": "String",
    "name": "String",
    "short_description": "String",
    "sys_id": "String"
  }
]
result.standard\_services.font\_awesome\_iconName of the thumbnail icon associated with the standard service.Data type: String
result.standard\_services.nameName of the standard service.Data type: String
result.standard\_services.short\_descriptionBrief description of the standard service.Data type: String
result.standard\_services.sys\_idSys\_id of the standard service record.Data type: String Table: Standard Service \[sn\_wsd\_rsv\_standard\_service\]

cURL request

This code example shows how to call this endpoint to retrieve a list of reservations associated with the specified user.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/list" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Return results:

{
  "result": {
    "reservations": [
      {
      "sys_id": "12e2da5e87c701106342b846dabb354d",
      "number": "WRES0001010",
      "location": {
        "sys_id": "02000d4edb7650106c731dcd13961914",
        "name": "Eureka",
        "description": "A comfortable meeting room with leather chairs and a wooden table. Client meeting room.",
        "display_value": "Eureka",
        "capacity": 12,
        "label_value": "Room name",
        "email": "eureka@example.com",
        "reservable_module": {
          "sys_id": "c31241cedb7650106c731dcd13961917",
          "name": "Meeting rooms",
          "title": "Meeting rooms",
          "inline_title": "meeting room"
        },
        "region": {
          "sys_id": "2d626c4edb3650106c731dcd1396194b",
          "display_value": "Europe",
          "active": true
        },
        "site": {
          "sys_id": "b17220cedb3650106c731dcd1396197a",
          "display_value": "Western Europe",
          "active": true
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus",
          "active": true
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1",
          "active": true,
          "timezone": {
            "value": "Europe/Amsterdam",
            "displayValue": "Europe/Amsterdam"
          }
        },
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3",
          "active": true
        },
        "area": {
          "sys_id": "",
          "display_value": "",
          "active": false
        },
        "reservation": {
          "sys_id": "12e2da5e87c701106342b846dabb354d",
          "number_of_attendees": 1,
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User",
            "user_name": "workplace_user"
          },
          "number": "WRES0001010",
          "active": true
        },
        "number_of_attendees": 1,
        "state": {
          "value": "confirmed",
          "display_value": "Confirmed"
        },
        "number": "WRES0001010",
        "requested_for": {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "name": "Workplace User",
          "user_name": "workplace_user"
        }
      },
      "start": "2022-05-15T16:00:00Z",
      "end": "2022-05-15T17:00:00Z",
      "sys_created_on": "2022-04-26T09:19:37Z",
      "sys_updated_on": "2022-04-26T09:20:04Z",
      "source_reservation": null,
      "check_in_state": {
        "value": "not_required",
        "display_value": "Not required"
      },
      "external_id": null,
      "external_ical": null,
      "active": true,
      "state": {
        "value": "confirmed",
        "display_value": "Confirmed"
      },
      "sensitivity": {
        "value": "normal",
        "display_value": "Normal"
      },
      "reservation_type": {
        "value": "space",
        "display_value": "Space"
      },
      "reservation_subtype": {
        "value": "single",
        "display_value": "Single"
      },
      "reservation_purpose": {
        "value": "meeting",
        "display_value": "Meeting"
      },
      "attendees": [
        {
          "sys_id": "2de07e1887cb89106342b846dabb35fe",
          "value": "2de07e1887cb89106342b846dabb35fe",
          "displayValue": "Workplace User",
          "display_value": "Workplace User",
          "name": "Workplace User",
          "user_name": "workplace_user",
          "table": "sys_user",
          "avatar": "eb513744c3222010ae17dd981840dd97",
          "initials": "WU",
          "email": "workplace_user@example.com",
          "label": ""
        }
      ],
      "number_of_attendees": 1,
      "is_parent": false,
      "subject": "Add rsv_1",
      "virtual_meeting": "https://samplemeetingurl.com",
      "recording_details": [
        {
          "recording_url": "https://samplerecordingurl.com"
        }
      ],
      "sync_state": {
        "value": "not_required",
        "display_value": "Synchronization not required"
      },
      "sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "last_updated_sub_source": {
        "value": "servicenow_workplace_service_delivery",
        "display_value": "ServiceNow Workplace Service Delivery"
      },
      "reservable_module": {
        "sys_id": "c31241cedb7650106c731dcd13961917",
        "name": "Meeting rooms",
        "title": "Meeting rooms",
        "inline_title": "meeting room",
        "font_awesome_icon": "fa-building",
        "reservable_table": "sn_wsd_core_room",
        "reservable_filter": "active=true^is_reservable=true^building!=6c0364cedb3650106c731dcd13961927^building.is_reservable=true^floor.is_reservable=true^EQ",
        "short_description": "Reserve a meeting room",
        "reservable_type": "location",
        "require_subject": "1",
        "require_cancel_notes": true,
        "virtual_meeting_provider": {
          "sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
          "display_value": "Template"
        },
        "allow_invitees": "1",
        "display_number_of_attendees": "1",
        "display_on_behalf_of": "1",
        "display_sensitivity": "1",
        "max_days_in_future": "180",
        "allow_whole_day": "1",
        "selection_type": "unit",
        "reservable_container_field": null,
        "reservable_quantity_field": null,
        "apply_to_shift": null,
        "max_occurrences": "180",
        "enable_facet_filter": false,
        "search_limit": 10000,
        "enable_ical_generation": null,
        "enable_group_reservations": null,
        "enable_browse_near_a_person": "1",
        "enable_browse_by_area": "1",
        "display_value": "Meeting rooms",
        "browse_near_a_person_enabled": true,
        "browse_by_area_enabled": true,
        "reservable_columns": [
          "sys_id",
          "external_id",
          "email",
          "name",
          "title",
          "description",
          "image",
          "number",
          "site",
          "campus",
          "building",
          "floor",
          "area",
          "capacity",
          "reservable_quantity",
          "location_type",
          "order",
          "requires_check_in",
          "is_reservable"
        ],
        "layout_mapping": {
          "title": [
            "name"
          ],
          "description": [
            "description"
          ],
          "subtitle": [
            "campus",
            "building",
            "floor",
            "area"
          ],
          "subtitle_asc": [
            "area",
            "floor",
            "building",
            "campus"
          ],
          "image": "image",
          "body": [
            {
              "label": "Capacity",
              "icon": "fa-users",
              "field": "capacity",
              "field_to_display": ""
            },
            {
              "label": "Standard services",
              "icon": "fa-check",
              "field": "standard_services",
              "field_to_display": "name"
            },
            {
              "label": "Reservable purposes",
              "icon": "fa-tags",
              "field": "reservable_purposes",
              "field_to_display": "name"
            }
          ]
        },
        "timeSlots": [
          {
            "sys_id": "d5331cf2dbb5f01038e42b24ca961906",
            "name": "All day",
            "short_description": "8am - 6pm",
            "slot_start": "08:00",
            "slot_end": "18:00"
          }
        ],
        "buildingSysIds": [
          "4703a4cedb3650106c731dcd13961945",
          "6c0364cedb3650106c731dcd13961927",
          "94e264cedb3650106c731dcd13961919",
          "9e0364cedb3650106c731dcd1396192b"
        ],
        "reservable_views": [
          {
            "type": "card",
            "label": "Card view",
            "iconClass": "fa-th-large",
            "isDefault": true,
            "order": "1"
          },
          {
            "type": "schedule",
            "label": "Schedule view",
            "iconClass": "fa-calendar-o",
            "isDefault": false,
            "order": "2"
          }
        ],
        "checkin_before_minutes": 30,
        "reservation_paths": [
          {
            "value": "browse_all",
            "displayValue": "Browse all"
          },
          {
            "value": "browse_near_a_person",
            "displayValue": "Browse near a person"
          },
          {
            "value": "browse_by_area",
            "displayValue": "Browse by area"
          }
        ],
        "override_approval_policy": "never_required"
      },
      "notification_recipients": [
        {
          "sys_id": "7016f79cc0a8016401c5a33be04be441",
          "name": "workplace user",
          "user_name": "workplace.user"
        }
      ],
      "notification_custom_message": "Demo notification message",
      "opened_by": {
        "sys_id": "6816f79cc0a8016401c5a33be04be441",
        "value": "6816f79cc0a8016401c5a33be04be441",
        "displayValue": "System Administrator",
        "display_value": "System Administrator",
        "name": "System Administrator",
        "user_name": "admin",
        "table": "sys_user",
        "avatar": "eb513744c3222010ae17dd981840dd97",
        "initials": "SA",
        "email": "admin@example.com",
        "label": "System Administrator"
      },
      "requested_for": {
        "sys_id": "2de07e1887cb89106342b846dabb35fe",
        "value": "2de07e1887cb89106342b846dabb35fe",
        "displayValue": "Workplace User",
        "display_value": "Workplace User",
        "name": "Workplace User",
        "user_name": "workplace_user",
        "table": "sys_user",
        "avatar": "d3513744c3222010ae17dd981840dd97",
        "initials": "WU",
        "email": "workplace_user@example.com",
        "label": ""
      },
      "edit_restriction": {
        "value": "no_restriction",
        "display_value": "No restriction"
      },
      "source": {
        "value": "servicenow",
        "display_value": "Workplace Services"
      },
      "source_icon": {
        "classNames": "fa fa-calendar-check-o",
        "tooltip": "Reservation is confirmed",
        "imgSrc": ""
      },
      "shift": {
        "sys_id": "e5d23acfdb42a01097acc9003996193a",
        "name": "Test shift AMS-B1",
        "display_value": "Test shift AMS-B1",
        "shiftDetails": "8-5 weekdays excluding holidays\n  - Monday-Friday 8-5"
      },
      "reservationAcl": {
        "write": {
          "record": true,
          "fields": {
            "subject": true,
            "sensitivity": true,
            "requested_for": true,
            "number_of_attendees": true,
            "location": true
          },
          "allFields": true
        },
        "read": true
      }
      }
     ]
   }
}

WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/cancel/{sys_id}

Cancels a specified workplace reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/cancel/{sys_id}

Default URL: /api/sn_wsd_rsv/reservation/cancel/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
sys\_idSys\_id of the reservation to cancel.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
NameDescription
None 
NameDescription
cancel\_notesReason for cancelling the reservation.Data type: String

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
Content-TypeData format of the request body. Only supports application/json.
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
sys\_idSys\_id of the cancelled reservation record.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]

cURL request

The following code example shows how to cancel a reservation using this endpoint.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/cancel/12e2da5e87c701106342b846dabb354d" \
--request PATCH \
--header "Accept:application/json" \
--user ‘username’:’password’

Return results:

"result": {
  "sys_id": "73c316d2474b0150003a4587746d4337"
}

WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/share_details/{sys_id}

Updates and shares the reservation details with a specified list of recipients through an email notification. Optionally you can send a specified message along with the reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/share_details/{sys_id}

Default URL: /api/sn_wsd_rsv/reservation/share_details/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
sys\_idSys\_id of the reservation to share.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
NameDescription
None 
NameDescription
notification\_custom\_messageMessage to send to the specified recipients.Data Type: String
notification\_recipientsRequired. List of sys\_ids of the users to send the email notification to.Data Type: Array Table: User \[sys\_user\]
notification\_typeType of notification to send.Valid types: - reservation\_cancelled - reservation\_created - reservation\_updated Data Type: String

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
Content-TypeData format of the request body. Only supports application/json.
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
sys\_idSys\_id of the reservation record that was shared.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]

cURL request

The following code example shows how to use this endpoint to share a reservation.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/share_details/60d26a0f47578910003a4587746d4331" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"notification_recipients\": [\"5dfb9fcf47d78910003a4587746d4367\"],
\"notification_type\":\"reservation_updated\",
\"notification_custom_message\": \"Please join our design brainstorming meeting!\"
}" \
--user "username":"password"

Return results:

"result": {
  "sys_id": "60d26a0f47578910003a4587746d4331"
}

WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/update/{sys_id}

Updates a specified workplace reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/update/{sys_id}

Default URL: /api/sn_wsd_rsv/reservation/update/{sys_id}

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
sys\_idSys\_id of the reservation to modify.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
NameDescription
ignore\_same\_day\_validationFlag that indicates whether the reservation search ignores the change of the date validation between the start and end parameters.Valid values: - true: Ignore the change date validation. - false: Don't ignore the change date validation. Data type: Boolean Default: false
NameDescription
end

Required if the shift parameter isn't passed in. Requested end time of the reservation.Data type: String

Format: UTC or local time (yyyy-mm-dd hh:mm:ss)

is\_privateFlag that indicates whether the reservation is private. If private, the reservation doesn't appear to anyone except the owner.For additional information on these privacy settings, see Location privacy settings and impact. Valid values: - true: Reservation is private. - false: Reservation isn't private. Data type: Boolean Default: Value set for privacy in the system properties.
locationRequired. Sys\_id of the location to reserve. Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
requested\_forSys\_id or email address of the user for which the reservation is being made.Data type: String Table: User \[sys\_user\]
shift

Sys_id of the shift to associate with the reservation. If this parameter is passed in, the end parameter isn't required.

For additional information on shift-based reservations, see Enable shift-based reservation.

Data type: String

Table: Shift [sn_wsd_core_shift]

startRequired. Requested start time of the reservation.Data type: String Format: UTC or local time \(yyyy-mm-dd hh:mm:ss\)
subjectRequired. Subject of the meeting associated with the reservation. Data type: String

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
Content-TypeData format of the request body. Only supports application/json.
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters (JSON or XML)

NameDescription
resultDetails of the updated reservation.Data type: Object 
"result": {
  "location_id": "String",
  "sys_id": "String",
  "type_of_change": "String"
}
result.location\_idSys\_id of the reservation location record.Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
result.sys\_idSys\_id of the modified reservation record.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]
result.type\_of\_changeType of information updated in the reservation.Data type: String

cURL request

The following code example shows how to update a reservation using this endpoint.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/update/b537abc947db4510003a4587746d4351" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"subject\": \"Rsv Update_1\",
\"start\": \"2022-07-21 14:00:00\",
\"end\": \"2022-07-21 15:00:00\",
\"requested_for\": \"workplace_user@example.com\",
\"workplace_location\": \"fe1f744edb7650106c731dcd139619ca\",
\"is_private\": \false\
}" \
--user "username":"password"

Return results:

{
  "result": {
    "sys_id": "b537abc947db4510003a4587746d4351",
    "location_id": "fe1f744edb7650106c731dcd139619ca",
    "type_of_change": "location"
  }
}

WSD Reservation - POST /api/sn_wsd_rsv/reservation/add

Creates a new workplace reservation.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/add

Default URL: /api/sn_wsd_rsv/reservation/add

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
NameDescription
ignore\_same\_day\_validationFlag that indicates whether the reservation search ignores the change of the date validation between the start and end parameters.Valid values: - true: Ignore the change date validation. - false: Don't ignore the change date validation. Data type: Boolean Default: false
timezonePreferred time zone for performing the request validations. For example: Europe/Amsterdam. This validation checks whether the start and end time fall on the same day. Data type: String Default: User time zone
NameDescription
end

Required if the shift parameter isn't passed in. Requested end time of the reservation.Data type: String

Format: UTC or local time (yyyy-mm-dd hh:mm:ss)

is\_privateFlag that indicates whether the reservation is private. If private, the reservation doesn't appear to anyone except the owner.For additional information on these privacy settings, see Location privacy settings and impact. Valid values: - true: Reservation is private. - false: Reservation isn't private. Data type: Boolean Default: Value set for privacy in the system properties.
locationRequired. Sys\_id of the location to reserve. Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
requested\_forSys\_id or email address of the user for which the reservation is being made.Data type: String Table: User \[sys\_user\]
reservable\_moduleRequired only for April 2026 store and earlier releases. Not required with May 2026 store and later releases. Sys\_id of the reservable module to associate with the reservation. A reservable module defines the workplace items needed for a reservation. Data type: String Table: Reservable Module \[sn\_wsd\_rsv\_reservable\_module\]
shift

Sys_id of the shift to associate with the reservation. If this parameter is passed in, the end parameter isn't required.

For additional information on shift-based reservations, see Enable shift-based reservation.

Data type: String

Table: Shift [sn_wsd_core_shift]

startRequired. Requested start time of the reservation.Data type: String Format: UTC or local time \(yyyy-mm-dd hh:mm:ss\)
subjectRequired. Subject of the meeting associated with the reservation. Data type: String

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
Content-TypeData format of the request body. Only supports application/json.
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
sys\_idSys\_id of the created reservation record.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]

cURL request

The following code example shows how to use this endpoint to create a reservation.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
  \"subject\": \"Test-123\",
  \"reservation_purpose\": \"meeting\",
  \"timezone\": \"US/Pacific\",
  \"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
  \"location\": \"5eafb44edb7650106c731dcd13961943\",
  \"is_private\": false,
  \"start\": \"2023-01-12T11:00:00Z\",
  \"end\": \"2023-01-12T12:00:00Z\"
}" \
--user "username":"password"

Return results:

"result": {
  "sys_id": "4b036a9e474b0150003a4587746d43b1"
}

WSD Reservation - POST /api/sn_wsd_rsv/reservation/quick_reserve

Creates a new workplace reservation using quick reserve.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservation/quick_reserve

Default URL: /api/sn_wsd_rsv/reservation/quick_reserve

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

NameDescription
api\_versionOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String
NameDescription
None 
NameDescription
end

Required if the shift parameter isn't passed in. Requested end time of the reservation.Data type: String

Format: UTC or local time (yyyy-mm-dd hh:mm:ss)

ignore\_same\_day\_validation

Required. Flag that indicates whether the endpoint ignores the validation of the change of date between the start and end parameters. Valid values:

  • true: Ignore the change date validation. Set this to true when the start and end dates are the same.
  • false: Do not ignore the change date validation.

Data type: Boolean

reference\_location\_idRequired. Sys\_id of the location, near to which, the user wants to reserve a location.Data type: String Table: Workplace Location \[sn\_wsd\_core\_workplace\_location\]
reservable\_moduleRequired only for April 2026 store and earlier releases. Not required with May 2026 store and later releases. Sys\_id of the reservable module to associate with the reservation. A reservable module defines the workplace items needed for a reservation. Data type: String Table: Reservable Module \[sn\_wsd\_rsv\_reservable\_module\]
shift

Sys_id of the shift to associate with the reservation. If this parameter is passed in, the end parameter isn't required.

For additional information on shift-based reservations, see Enable shift-based reservation.

Data type: String

Table: Shift [sn_wsd_core_shift]

startRequired. Requested start time of the reservation.Data type: String Format: UTC or local time \(yyyy-mm-dd hh:mm:ss\)

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

HeaderDescription
AcceptData format of the request body. Supported types: application/json, application/xml or, text/xml. Default: application/json
Content-TypeData format of the request body. Only supports application/json.
HeaderDescription
None 

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Status codeDescription
200Successful. The request was successfully processed.
401Unauthorized. The user credentials are incorrect or have not been passed.
404Not found. The requested item wasn't found.
500Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
sys\_idSys\_id of the created reservation record.Data type: String Table: Workplace Reservation \[sn\_wsd\_rsv\_reservation\]

cURL request

The following code example shows how to use the quick reserve endpoint to create a reservation.

curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/quick_reserve" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"start\":\"2022-05-23 16:00:00\",
  \"end\": \"2022-05-23 17:00:00\",
  \"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
  \"reference_location_id\": \"05f5290edb7210106c731dcd13961951\",
  \"ignore_same_day_validation\": \"true\"
}" \
--user "username":"password"

Return results:

"result": {
  "sys_id": "4b036a9e474b0150003a4587746d43b1"
}