WSD Reservable V2 API
On this page
WSD Reservable V2 API
The Workplace Service Delivery (WSD) Reservable V2 API provides endpoints to retrieve details of a reservable, an entity that can be reserved, such as a workplace location, from a ServiceNow instance.
The WSD Reservable V2 API is a new version of the WSD Reservable API. The WSD Reservable V2 API fetches details of all reservable space(s) on the WSD Portal that you select while making a reservation. The original WSD Reservable API version used a GET call but limited the sys_ID path parameter to 35 characters. The new WSD Reservable V2 API version is a POST call and takes all the sys_ids in the request body to avoid character limitations.
To access this API, the caller must have the sn_wsd_core.workplace_user role.
This API runs in the sn_wsd_rsv namespace. To access this API, the Workplace Reservation Management (sn_wsd_rsv) plugin must be activated.
For additional information on Workplace Reservation Management, see Workplace Reservation Management.
Parent Topic:REST API reference
WSD Reservable V2 API - POST /sn_wsd_rsv/v2/reservable/list_reservables
Returns the details for one or more specified reservables.
URL format
Default URL: POST api/sn_wsd_rsv/v2/reservable/list_reservables
Supported request parameters
<table class=“rest_api_path_parameters”><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
api_version
</td><td>
Required. Version of the endpoint to access. Specify v2 to employ this API, otherwise using v1 employs the default version of the WSD Reservable API.Data type: String
</td></tr></tbody> </table>|Name|Description| |—-|———–| |None| |
<table class=“rest_api_request_body”><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
include_flexible_services
</td><td>
Flag that indicates whether to return the flexible services associated with the reservable in to the response.A flexible service is an additional provision available with a reservable workplace item when a reservation is made. For example, Classroom style - Rows of tables arranged with all participants facing towards the front of the room. For additional information on flexible services, see Create a flexible service.
Valid values:
-
true: Return the flexible service information.
-
false: Do not return the flexible service information.
Data type: Boolean
Default: false
</td></tr><tr><td>
include_standard_services
</td><td id=“include_standard_services-reserv-entry”>
Flag 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
</td></tr><tr><td>
include_reservable_purposes
</td><td>
Optional. Flag that indicates whether to return the purpose associated with the reservable.Valid values:
-
true: Return the purpose of the reservable.
-
false: Do not return the purpose of the reservable.
Data type: Boolean
Default: false
</td></tr><tr><td>
include_layouts
</td><td>
Flag that indicates whether to return the location layout information in the response.Location layout information include such things as capacity, max capacity, preparation, and clean up duration.
Valid values:
-
true: Return the location layout information.
-
false: Don’t return the location layout information.
Data type: Boolean
Default: false
Table: Location Layout [sn_wsd_rsv_m2m_location_layout]
</td></tr><tr><td>
reservable_module_sys_id
</td><td>
Required. Sys_id of the reservable module, for example: desk, meeting room, etc.A reservable module groups similar types of workplace items.
For additional information on reservable modules, see Configure a reservable module.
Data type: String
Default: Empty value
Table: Reservable Module [sn_wsd_rsv_reservable_module]
</td></tr><tr><td>
reservation_start_time
</td><td id=“reservation_ids-reserv-start-entry”>
Reservation start time to validate the lead time of extra services.Format: UTC format, yyyy-MM-dd HH:mm:ss
Data type: String
</td></tr><tr><td>
space_sys_ids
</td><td>
Required. Comma-separated sys_ids of selected spaces.Data type: String
Default: Empty value
</td></tr></tbody> </table>### 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.
<table class=“rest_api_request_headers”><thead><tr><th>
Header
</th><th>
Description
</th></tr></thead><tbody><tr><td>
Accept
</td><td id=“accept-entry-RESTAPI”>
Data format of the response body. Supported types: application/json or application/xml. Default: application/json
</td></tr><tr><td>
Content-Type
</td><td>
Data format of the response body. Only supports application/json.
</td></tr></tbody> </table>|Header|Description| |——|———–| |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.
<table><thead><tr><th>
Status code
</th><th>
Description
</th></tr></thead><tbody><tr><td>
200
</td><td id=“entry-200-status-code”>
Successful. The request was successfully processed.
</td></tr><tr><td>
404
</td><td>
Could not find reservables.Look for the WSD Core Spaces [sn_wsd_core_spaces] table and verify the space record is present.
</td></tr><tr><td>
500
</td><td>
Error occurred! Unable to retrieve reservables. This is a server error. Contact system administration.
</td></tr></tbody> </table>### Response body parameters
<table id=“table_hw2_mvy_yzb”><thead><tr><th>
Name
</th><th>
Description
</th></tr></thead><tbody><tr><td>
result
</td><td>
Details on each matching reservable.Data type: Array of Objects
{
"result": [
{
"allow_invitees": Boolean,
"area": {Object},
"building": {Object},
"campus": {Object},
"capacity": Number,
"description": "String",
"display_number_of_attendees": Boolean,
"display_on_behalf_of": Boolean,
"display_sensitivity": Boolean,
"email": "String",
"employee_override_privacy": Boolean
"enable_group_reservations": Boolean,
"enable_reservation_privacy": Boolean,
"external_id": "String",
"flexible_services": [Array],
"floor": {Object},
"image": {Object},
"is_reservable": Boolean,
"layouts": [Array],
"location_type": {Object},
"meetingProviders": [Array],
"moduleType": "String",
"name": "String",
"number": "String",
"order": Number,
"require_approval": Boolean,
"requires_check_in": Boolean,
"require_subject": Boolean,
"reservable_quantity": Number,
"site": {Object},
"standard_services": [Array],
"sys_id": "String",
"title": "String",
"type": "String",
"tableName": "String"
}
]
}
</td></tr><tr><td>
result.allow_invitees
</td><td id=“allow_invitees-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.area
</td><td>
Area where the reservable is located. Data type: Object
"area": {
"display_value": "String",
"sys_id": "String"
}
Table: Area [sn_wsd_core_area]
</td></tr><tr><td>
result.area.display_value
</td><td>
Display value for the area.Data type: String
</td></tr><tr><td>
result.area.sys_id
</td><td>
Sys_id of the associated area record.Data type: String
</td></tr><tr><td>
result.building
</td><td id=“building-reserv-entry”>
Building where the reservable is located.Data type: Object
"building": {
"display_value": "String",
"sys_id": "String",
"timezone": {Object}
}
Table: Building [sn_wsd_core_building]
</td></tr><tr><td>
result.building.display_value
</td><td id=“building_display_value-reserv-entry”>
Display value for the building.Data type: String
</td></tr><tr><td>
result.building.sys_id
</td><td id=“building_sys_id-reserv-entry”>
Sys_id of the associated building record.Data type: String
</td></tr><tr><td>
result.building.timezone
</td><td id=“building_timezone-reserv-entry”>
Details of the time zone for the building.Data type: Object
"timezone": {
"displayValue": "String",
"value": "String"
}
</td></tr><tr><td>
result.building.timezone.display_value
</td><td id=“building_timezone_display_value-reserv-entry”>
Display value of the time zone in which the associated building resides.Data type: String
</td></tr><tr><td>
result.building.timezone.value
</td><td id=“building_timezone_value-reserv-entry”>
Internal value of the time zone in which the associated building resides.Data type: String
</td></tr><tr><td>
result.campus
</td><td>
Campus where the reservable is located.Data type: Object
"campus": {
"display_value": "String",
"sys_id": "String"
}
Table: Campus [sn_wsd_core_campus]
</td></tr><tr><td>
result.campus.display_value
</td><td>
Display value for the campus.Data type: String
</td></tr><tr><td>
result.campus.sys_id
</td><td>
Sys_id of the associated campus record.Data type: String
</td></tr><tr><td>
result.capacity
</td><td>
Number of people that the reservable can accommodate.Data type: Number
</td></tr><tr><td>
result.description
</td><td>
Description of the reservable.Data type: String
</td></tr><tr><td>
result.display_number_of_attendees
</td><td id=“display_number_of_attendees-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.display_on_behalf_of
</td><td id=“display_on_behalf_of-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.display_sensitivity
</td><td id=“display_sensitivity-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.email
</td><td>
Email address associated with the reservable.Data type: String
</td></tr><tr><td>
result.employee_override_privacy
</td><td>
Flag that indicates whether users can override the privacy setting for the associated reservable.For additional information on these privacy settings, see Location privacy settings and impact.
Valid values:
-
true: Users can override the privacy setting for the associated reservable.
-
false: Users cannot override the privacy setting for the associated reservable.
</td></tr><tr><td>
result.enable_group_reservations
</td><td id=“enable_group_reservations-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.enable_reservation_privacy
</td><td>
Flag that indicates the default setting for reservation privacy.
For additional information on these privacy settings, see Location privacy settings and impact.
Possible values:
-
true: Reservations are private by default.
-
false: Reservations are not private by default.
Data type: Boolean
</td></tr><tr><td>
result.external_id
</td><td>
External ID of the reservable.Data type: String
</td></tr><tr><td>
result.flexible_services
</td><td>
Populated only if the include_flexible_services parameter is set to true and the workplace case management plugin is installed. Description of the flexible services associated with the reservables. There can be a parent flexible service, and several child flexible services.Data type: Array of Objects
flexible_services": [
{
"additional_text": "String",
"allow_only_single_service_item_selection": Boolean,
"category": "String",
"currency_code": "String",
"flexible_service": [Array],
"label": "String",
"sub_category": "String",
"sub_title": "String",
"text": "String",
"title": {Object}
}
]
Table: Workplace Service Item [sn_wsd_case_workplace_service_item]
</td></tr><tr><td>
result.flexible_services.additional_text
</td><td>
Text to prompt user to select additional flexible services. Data type: String
</td></tr><tr><td>
result.flexible_services.allow_only_single_service_item_selection
</td><td>
Flag that indicates whether users can select only one service item among the group of flexible services within a reservation.Valid values:
-
true: Only able to make a single selection.
-
false: Able to make multiple selections.
Data type: Boolean
</td></tr><tr><td>
result.flexible_services.category
</td><td>
Category of the flexible services.Data type: String
</td></tr><tr><td>
result.flexible_services.currency_code
</td><td>
Currency code used to calculate the amount of currency when ordering flexible services.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service
</td><td>
Flexible services corresponding to a parent flexible service.Data type: Array of Objects
"flexible_service": [
{
"flexible_service": [Array],
"label": "String",
"sub_category": "String"
}
]
Table: Workplace Service Item [sn_wsd_case_workplace_service_item]
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service
</td><td>
Details of each flexible service corresponding to a parent flexible service.Data type: Array of Objects
"flexible_service": [
{
"additional_text": "String",
"capacity_enabled": Boolean,
"category": "String",
"category_label": "String",
"cleanup_duration": "String",
"image": "String",
"max_capacity": Number,
"name": "String",
"preparation_duration": "String",
"price_per_unit": {Object},
"quantity_enabled": Boolean,
"quantity_required": Boolean,
"short_description": "String",
"sub_category": "String",
"sub_category_label": "String",
"sub_title": "String",
"sys_id": "String",
"text": "String",
"title": {Object}
}
]
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.additional_text
</td><td>
Text used to prompt a user to select additional flexible services.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.capacity_enabled
</td><td>
Flag that indicates whether the capacity of the room should appear in the reservation. If this is set to true, quantity_enabled will always be false.Valid values:
-
true: Capacity should appear.
-
false: Capacity should not appear.
Data type: Boolean
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.category
</td><td>
Category of the flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.category_label
</td><td>
Category label of flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.cleanup_duration
</td><td>
Amount of time it takes to clean up or remove the service added to the reservable.Data type: Number
Unit: Milliseconds
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.image
</td><td>
Link to the image of the flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.max_capacity
</td><td>
Maximum number of occupants that the reservable can accommodate.Data type: Number
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.name
</td><td>
Name of flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.preparation_duration
</td><td>
Amount of time it takes to add the service to the reservable.Data type: String
Unit: Milliseconds
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.price_per_unit
</td><td>
Details of the cost of adding the flexible service to the reservable.Data type: Object
"price_per_unit": { "code": "String", "value": "String" }
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.price_per_unit.code
</td><td>
Currency code to use when calculating the cost, such as GBP or USD.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.price_per_unit.value
</td><td>
Cost for each unit of the flexible service in the currency defined in the code parameter.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.quantity_enabled
</td><td>
Flag that indicates whether the quantity field should appear in the reservation. If this is set to true, capacity_enabled will always be false.Valid values:
-
true: Quantity should appear.
-
false: Quantity should not appear.
Data type: Boolean
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.quantity_required
</td><td>
Flag that indicates whether the quantity is required.Valid values:
-
true: Quantity is required.
-
false: Quantity is not required.
Data type: Boolean
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.short_description
</td><td>
Brief description of the flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.sub_category
</td><td>
Sub-category name of the flexible service, such as chair_layout.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.sub_category_label
</td><td>
Sub-category label of the flexible service, such as Chair layout.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.sub_title
</td><td>
Sub-title name of the child flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.sys_id
</td><td>
Sys_id of flexible service. Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.text
</td><td>
Text used to prompt a user to select flexible services.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.title
</td><td>
Details for the titles to use when adding and editing the child flexible service in the UI.Data type: Object
"title": { "add": "String", "edit": "String" }
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.title.add
</td><td>
Title used when adding a child flexible service in the UI.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.flexible_service.title.edit
</td><td>
Title used when editing a child flexible service in the UI.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.label
</td><td>
Flexible service label.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.sub_category
</td><td>
Sub-category of the parent flexible services, such as additional chair.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.sub_title
</td><td>
Sub-title name of the parent flexible service.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.text
</td><td>
Text used to prompt a user to select a parent flexible services.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.title
</td><td>
Details for the titles to use when adding and editing the parent flexible service in the UI.Data type: Object
"title": { "add": "String", "edit": "String" }
</td></tr><tr><td>
result.flexible_services.flexible_service.title.add
</td><td>
Title used when adding a parent flexible service in the UI.Data type: String
</td></tr><tr><td>
result.flexible_services.flexible_service.title.edit
</td><td>
Title used when editing a parent flexible service in the UI.Data type: String
</td></tr><tr><td>
result.floor
</td><td>
Details about the floor on which the reservable is located.Data type: Object
"floor": {
"display_value": "String",
"sys_id": "String"
}
Table: Floor [sn_wsd_core_floor]
</td></tr><tr><td>
result.floor.display_value
</td><td id=“floor_display_value-reserv-entry”>
Display number of the floor on which the reservable resides, such as 12.Data type: String
</td></tr><tr><td>
result.floor.sys_id
</td><td>
Sys_id of the associated record.Data type: String
Table: Floor [sn_wsd_core_floor]
</td></tr><tr><td>
result.image
</td><td>
Details about an image that represents the associated reservable.Data type: Object
"image": {
"link": "String",
"sys_id": "String"
}
Table: Images [db_image]
</td></tr><tr><td>
result.image.link
</td><td>
Link to an image that represents the reservable.Data type: String
</td></tr><tr><td>
result.image.sys_id
</td><td>
Sys_id of the associated image record.Data type: String
Table: Images [db_image]
</td></tr><tr><td>
result.is_reservable
</td><td>
Flag that indicates whether the flexible service can be reserved.Valid values:
-
true: Flexible service can be reserved.
-
false: Flexible service can’t be reserved.
Data type: Boolean
</td></tr><tr><td>
results.layouts
</td><td id=“layouts-reserv-entry”>
Only populated if the include_layouts parameter is set to true.List of the layouts associated with the reservable.
Data type: Array of Objects
"layouts": [
{
"capacity": Number,
"cleanup_duration": "String",
"image": {Object},
"is_default": Boolean,
"max_capacity": Number,
"name": "String",
"preparation_duration": "String",
"short_description": "String",
"sys_id": "String"
}
]
</td></tr><tr><td>
result.layouts.capacity
</td><td id=“layouts_capacity-reserv-entry”>
Number of people that will attend the meeting.Data type: Number
</td></tr><tr><td>
result.layouts.cleanup_duration
</td><td id=“layouts_cleanup_duration-reserv-entry”>
Amount of time it takes to clean the reservable for this layout.Data type: Number
Unit: Milliseconds
</td></tr><tr><td>
result.layouts.image
</td><td id=“layouts_image-reserv-entry”>
Details about an image that represents the layout for the associated reservable.Data type: Object
"image": {
"link": "String",
"sys_id": "String"
}
Table: Images [db_image]
</td></tr><tr><td>
result.layouts.image.link
</td><td id=“layouts_image_link-reserv-entry”>
Link to an image that represents the layout for this reservable.Data type: String
Table: Images [db_image]
</td></tr><tr><td>
result.layouts.image.sys_id
</td><td id=“layouts_image_sys_id-reserv-entry”>
Sys_id of the associated image record.Data type: String
</td></tr><tr><td>
result.layouts.is_default
</td><td id=“layouts_is_default-reserv-entry”>
Flag that indicates whether the associated layout is the default for the reservable. Valid values:
-
true: Default.
-
false: Not default.
Data type: Boolean
</td></tr><tr><td>
result.layouts.max_capacity
</td><td id=“layouts_max_capacity-reserv-entry”>
Maximum number of people that the layout associated with the reservable can accommodate.Data type: Number
</td></tr><tr><td>
result.layouts.name
</td><td id=“layouts_name-reserv-entry”>
Name of the location layout. Data type: String
</td></tr><tr><td>
result.layouts.preparation_duration
</td><td id=“layouts_preparation_duration-reserv-entry”>
Amount of time it takes to prepare the associated location layout.Data type: Number
Unit: Milliseconds
</td></tr><tr><td>
result.layouts.short_description
</td><td id=“layouts_short_description-reserv-entry”>
Brief description of the location layout.Data type: String
</td></tr><tr><td>
result.layouts.sys_id
</td><td id=“layouts_sys_id-reserv-entry”>
Sys_id of the location layout.Data type: String
Table: Layout [sn_wsd_rsv_layout]
</td></tr><tr><td>
result.location_type
</td><td id=“location_type-reserv-entry”>
Details about the type of location of the reservable, such as workplace/desk, cafe, or gym.Data type: Object
"location_type": {
"display_value": "String",
"sys_id": "String"
}
Table: Space Type [sn_wsd_core_space_type]
</td></tr><tr><td>
result.location_type.display_value
</td><td id=“location_type_display_value-reserv-entry”>
Display value of the location type.Data type: String
</td></tr><tr><td>
result.location_type.sys_id
</td><td id=“location_type_sys_id-reserv-entry”>
Sys_id of the associated record.Data type: String
Table: Space Type [sn_wsd_core_space_type]
</td></tr><tr><td>
result.meetingProviders
</td><td>
Details about the virtual meeting providers associated with the reservable. Data type: Array of Objects
"meetingProviders": [
{
"display_value": "String",
"value": "String"
}
]
Table: Virtual Meeting Provider [sn_wsd_rsv_virtual_meeting_provider]
</td></tr><tr><td>
result.meetingProviders.display_value
</td><td>
Display value of the virtual provider’s name.Data type: String
</td></tr><tr><td>
result.meetingProviders.value
</td><td>
Actual value for the virtual provider’s name in the record.Data type: String
</td></tr><tr><td>
result.moduleType
</td><td>
Reservable module associated with the reservable, such as desks or meeting room.Data type: String
</td></tr><tr><td>
result.name
</td><td id=“name-reserv-entry”>
Name of the reservable.Data type: String
</td></tr><tr><td>
result.number
</td><td id=“number-reserv-entry”>
Unique identifier of the reservable. This value is more human readable than the sys_id.Data type: String
</td></tr><tr><td>
result.order
</td><td id=“order-reserv-entry”>
Order number for the reservable.Data type: Number
</td></tr><tr><td>
result.require_approval
</td><td id=“require_approval-reserv-entry”>
Flag that indicates whether reserving the reservable requires an approval.Possible values:
-
true: Approval required.
-
false: Approval isn’t required.
Data type: Boolean
</td></tr><tr><td>
result.requires_check_in
</td><td id=“requires_check_in-reserv-entry”>
Flag that indicates whether the reservable requires the user to check in.Valid values:
-
true: Check in required.
-
false: Check in isn’t required.
Data type: Boolean
</td></tr><tr><td>
result.require_subject
</td><td id=“require_subject-reserv_mod-entry”>
Flag 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
</td></tr><tr><td>
result.reservable_quantity
</td><td id=“reservable_quantity-reserv-entry”>
Maximum number of times the associated reservable can be reserved for the same time. This value is used when assigning neighborhood spaces to an area.Data type: Integer
</td></tr><tr><td>
result.site
</td><td id=“site-reserv-entry”>
Details about the site where the reservable resides.Data type: Object
"site": {
"display_value": "String",
"sys_id": "String"
}
Table: Site [sn_wsd_core_site]
</td></tr><tr><td>
result.site.display_value
</td><td id=“site_display_value-reserv-entry”>
Display value of the site.Data type: String
</td></tr><tr><td>
result.standard_services
</td><td id=“std_serv-reserv-entry”>
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"
}
]
</td></tr><tr><td>
result.standard_services.font_awesome_icon
</td><td id=“std_serv_font-awesome_icon-reserv-entry”>
Name of the thumbnail icon associated with the standard service.Data type: String
</td></tr><tr><td>
result.standard_services.name
</td><td id=“std_serv_name-reserv-entry”>
Name of the standard service.Data type: String
</td></tr><tr><td>
result.standard_services.short_description
</td><td id=“std_serv_short_description-reserv-entry”>
Brief description of the standard service.Data type: String
</td></tr><tr><td>
result.standard_services.sys_id
</td><td id=“std_serv_sys_id-reserv-entry”>
Sys_id of the standard service record.Data type: String
Table: Standard Service [sn_wsd_rsv_standard_service]
</td></tr><tr><td>
result.site.sys_id
</td><td id=“site_sys_id-reserv-entry”>
Sys_id of the associated site record.Data type: String
Table: Site [sn_wsd_core_site]
</td></tr><tr><td>
result.tableName
</td><td id=“tableName-reserv-entry”>
Name of the table in which the reservable record resides. Data type: String
</td></tr><tr><td>
result.title
</td><td id=“title-reserv-entry”>
Title of the reservable.Data type: String
</td></tr><tr><td>
result.type
</td><td id=“type-reserv-entry”>
Type of a reservable, such as location.Data type: String
</td></tr></tbody> </table>### cURL request
The following code example shows how to call this endpoint to return details about the specified reservables.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/v2/reservable/list_reservables" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"space_sys_ids\":\"3ed3139977220110b3d7be377b5a99d1\",\"reservable_module_sys_id\":\"c31241cedb7650106c731dcd13961917\",\"include_flexible_services\":true,\"include_standard_services\":true,\"include_reservable_purposes\":true,\"include_layouts\":false}" \
--user 'username:'password'
Response body. This example returns details about all the reservables listed in the request body.
{
"result": [
{
"sys_id": "3ed3139977220110b3d7be377b5a99d1",
"external_id": "447b9dfb475a011064062782846d4382",
"wsd_email": null,
"name": "A263",
"title": "A263",
"description": null,
"image": null,
"number": "ROOM0000181",
"site": {
"sys_id": "b35f47ffdba05010f342a0da4b961998",
"display_value": "Italy"
},
"campus": {
"sys_id": "87831b1977220110b3d7be377b5a9946",
"display_value": ""
},
"building": {
"sys_id": "dea39b1977220110b3d7be377b5a9955",
"display_value": "",
"timezone": {
"value": "",
"displayValue": ""
}
},
"floor": {
"sys_id": "68d31f5977220110b3d7be377b5a991b",
"display_value": ""
},
"area": null,
"capacity": "17",
"reservable_quantity": "1",
"location_type": {
"sys_id": "20713b83eb512010b89bfdfc9c522899",
"display_value": "Room"
},
"order": null,
"requires_check_in": null,
"is_reservable": "1",
"type": "location",
"moduleType": "Meeting rooms",
"meetingProviders": [],
"require_subject": true,
"allow_invitees": false,
"display_number_of_attendees": false,
"display_on_behalf_of": true,
"display_sensitivity": true,
"enable_group_reservations": false,
"allow_reservation_message": false,
"warn_employee_for_duplicate_reservation": false,
"enable_reservation_privacy": false,
"employee_override_privacy": false,
"tableName": "sn_wsd_core_room",
"require_approval": false,
"flexible_services": [
{
"allow_only_single_service_item_selection": true,
"category": "50723fbf07100110c9b36b6e0ad300b4",
"label": "Space arrangement",
"description": "This is a service to request a different space configuration as part of a reservation.",
"sub_category": "chair_layout",
"title": {
"edit": "Update Space arrangement for A263",
"add": "Add Space arrangement for A263"
},
"sub_title": "Add a space arrangement item to get started",
"text": "Select space arrangement item",
"additional_text": "Select another space arrangement item",
"currency_code": "GBP",
"flexible_service": [
{
"sub_category": "chair_layout",
"label": "Chair layout",
"flexible_service": [
{
"sys_id": "e2ecf7b307500110c9b36b6e0ad30033",
"name": "Classroom Style",
"short_description": "Rows of tables arranged with all participants facing towards the front of the room",
"category": "50723fbf07100110c9b36b6e0ad300b4",
"category_label": "Space arrangement",
"sub_category": "chair_layout",
"sub_category_label": "Chair layout",
"image": "08d6ff68d5122110fa9b1500c1d696c5.iix",
"quantity_enabled": false,
"quantity_required": false,
"capacity_enabled": true,
"max_capacity": "",
"preparation_duration": "1970-01-01 00:15:00",
"cleanup_duration": "1970-01-01 00:15:00",
"price_per_unit": {
"value": 0,
"code": "GBP"
},
"title": {
"edit": "Update Space arrangement for A263",
"add": "Add Space arrangement for A263"
},
"sub_title": "Add a space arrangement item to get started",
"text": "Select space arrangement item",
"additional_text": "Select another space arrangement item"
},
{
"sys_id": "1cf33fff07100110c9b36b6e0ad30077",
"name": "Banquet Rounds",
"short_description": "Round tables arranged throughout the room. Participants are seated around the entire perimeter of each table",
"category": "50723fbf07100110c9b36b6e0ad300b4",
"category_label": "Space arrangement",
"sub_category": "chair_layout",
"sub_category_label": "Chair layout",
"image": "cdc67720d5522110fa9b1500c1d69636.iix",
"quantity_enabled": false,
"quantity_required": false,
"capacity_enabled": true,
"max_capacity": "",
"preparation_duration": "1970-01-01 00:15:00",
"cleanup_duration": "1970-01-01 00:15:00",
"price_per_unit": {
"value": 0,
"code": "GBP"
},
"title": {
"edit": "Update Space arrangement for A263",
"add": "Add Space arrangement for A263"
},
"sub_title": "Add a space arrangement item to get started",
"text": "Select space arrangement item",
"additional_text": "Select another space arrangement item"
},
{
"sys_id": "21e2c08407600110c9b36b6e0ad3007c",
"name": "Theater Style",
"short_description": "Rows of chairs (no tables) arranged with all participants facing towards the front of the room",
"category": "50723fbf07100110c9b36b6e0ad300b4",
"category_label": "Space arrangement",
"sub_category": "chair_layout",
"sub_category_label": "Chair layout",
"image": "f3d67fa4d5122110fa9b1500c1d6968b.iix",
"quantity_enabled": false,
"quantity_required": false,
"capacity_enabled": true,
"max_capacity": "",
"preparation_duration": "1970-01-01 00:15:00",
"cleanup_duration": "1970-01-01 00:15:00",
"price_per_unit": {
"value": 0,
"code": "GBP"
},
"title": {
"edit": "Update Space arrangement for A263",
"add": "Add Space arrangement for A263"
},
"sub_title": "Add a space arrangement item to get started",
"text": "Select space arrangement item",
"additional_text": "Select another space arrangement item"
}
]
}
]
},
{
"allow_only_single_service_item_selection": false,
"category": "c9ab1c89c3500110547e3810a840dd41",
"label": "Catering",
"description": "This is a service to request catering as part of a reservation.",
"sub_category": "drinks",
"title": {
"edit": "Update Catering for A263",
"add": "Add Catering for A263"
},
"sub_title": "Add a catering item to get started",
"text": "Select catering item",
"additional_text": "Select another catering item",
"currency_code": "GBP",
"flexible_service": [
{
"sub_category": "drinks",
"label": "Drinks",
"flexible_service": [
{
"sys_id": "48d72985c3900110547e3810a840dd7d",
"name": "Champagne",
"short_description": "",
"category": "c9ab1c89c3500110547e3810a840dd41",
"category_label": "Catering",
"sub_category": "drinks",
"sub_category_label": "Drinks",
"image": "",
"quantity_enabled": true,
"quantity_required": false,
"capacity_enabled": false,
"max_capacity": "",
"preparation_duration": 0,
"cleanup_duration": 0,
"price_per_unit": {
"value": 0,
"code": "GBP"
},
"title": {
"edit": "Update Catering for A263",
"add": "Add Catering for A263"
},
"sub_title": "Add a catering item to get started",
"text": "Select catering item",
"additional_text": "Select another catering item"
}
]
}
]
}
],
"standard_services": [],
"reservable_purposes": []
}
]
}
Keep exploring.
Find another answer, or bring this documentation into your own tools.