|
result
|
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"
}
]
}
```
|
|
result.allow\_invitees
|
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
|
|
result.area
|
Area where the reservable is located. Data type: Object
```
"area": {
"display_value": "String",
"sys_id": "String"
}
```
Table: Area \[sn\_wsd\_core\_area\]
|
|
result.area.display\_value
|
Display value for the area.Data type: String
|
|
result.area.sys\_id
|
Sys\_id of the associated area record.Data type: String
|
|
result.building
|
Building where the reservable is located.Data type: Object
```
"building": {
"display_value": "String",
"sys_id": "String",
"timezone": {Object}
}
```
Table: Building \[sn\_wsd\_core\_building\]
|
|
result.building.display\_value
|
Display value for the building.Data type: String
|
|
result.building.sys\_id
|
Sys\_id of the associated building record.Data type: String
|
|
result.building.timezone
|
Details of the time zone for the building.Data type: Object
```
"timezone": {
"displayValue": "String",
"value": "String"
}
```
|
|
result.building.timezone.display\_value
|
Display value of the time zone in which the associated building resides.Data type: String
|
|
result.building.timezone.value
|
Internal value of the time zone in which the associated building resides.Data type: String
|
|
result.campus
|
Campus where the reservable is located.Data type: Object
```
"campus": {
"display_value": "String",
"sys_id": "String"
}
```
Table: Campus \[sn\_wsd\_core\_campus\]
|
|
result.campus.display\_value
|
Display value for the campus.Data type: String
|
|
result.campus.sys\_id
|
Sys\_id of the associated campus record.Data type: String
|
|
result.capacity
|
Number of people that the reservable can accommodate.Data type: Number
|
|
result.description
|
Description of the reservable.Data type: String
|
|
result.display\_number\_of\_attendees
|
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
|
|
result.display\_on\_behalf\_of
|
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
|
|
result.display\_sensitivity
|
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
|
|
result.email
|
Email address associated with the reservable.Data type: String
|
|
result.employee\_override\_privacy
|
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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/employee-service-management/location-privacy-settings-and-impact.md).
Valid values:
- true: Users can override the privacy setting for the associated reservable.
- false: Users cannot override the privacy setting for the associated reservable.
|
|
result.enable\_group\_reservations
|
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
|
|
result.enable\_reservation\_privacy
|
Flag that indicates the default setting for reservation privacy.
For additional information on these privacy settings, see [Location privacy settings and impact](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/employee-service-management/location-privacy-settings-and-impact.md).
Possible values:
- true: Reservations are private by default.
- false: Reservations are not private by default.
Data type: Boolean
|
|
result.external\_id
|
External ID of the reservable.Data type: String
|
|
result.flexible\_services
|
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\]
|
|
result.flexible\_services.additional\_text
|
Text to prompt user to select additional flexible services. Data type: String
|
|
result.flexible\_services.allow\_only\_single\_service\_item\_selection
|
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
|
|
result.flexible\_services.category
|
Category of the flexible services.Data type: String
|
|
result.flexible\_services.currency\_code
|
Currency code used to calculate the amount of currency when ordering flexible services.Data type: String
|
|
result.flexible\_services.flexible\_service
|
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\]
|
|
result.flexible\_services.flexible\_service.flexible\_service
|
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}
}
]
```
|
|
result.flexible\_services.flexible\_service.flexible\_service.additional\_text
|
Text used to prompt a user to select additional flexible services.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.capacity\_enabled
|
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
|
|
result.flexible\_services.flexible\_service.flexible\_service.category
|
Category of the flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.category\_label
|
Category label of flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.cleanup\_duration
|
Amount of time it takes to clean up or remove the service added to the reservable.Data type: Number
Unit: Milliseconds
|
|
result.flexible\_services.flexible\_service.flexible\_service.image
|
Link to the image of the flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.max\_capacity
|
Maximum number of occupants that the reservable can accommodate.Data type: Number
|
|
result.flexible\_services.flexible\_service.flexible\_service.name
|
Name of flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.preparation\_duration
|
Amount of time it takes to add the service to the reservable.Data type: String
Unit: Milliseconds
|
|
result.flexible\_services.flexible\_service.flexible\_service.price\_per\_unit
|
Details of the cost of adding the flexible service to the reservable.Data type: Object
```
"price_per_unit": {
"code": "String",
"value": "String"
}
```
|
|
result.flexible\_services.flexible\_service.flexible\_service.price\_per\_unit.code
|
Currency code to use when calculating the cost, such as GBP or USD.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.price\_per\_unit.value
|
Cost for each unit of the flexible service in the currency defined in the code parameter.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.quantity\_enabled
|
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
|
|
result.flexible\_services.flexible\_service.flexible\_service.quantity\_required
|
Flag that indicates whether the quantity is required.Valid values:
- true: Quantity is required.
- false: Quantity is not required.
Data type: Boolean
|
|
result.flexible\_services.flexible\_service.flexible\_service.short\_description
|
Brief description of the flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.sub\_category
|
Sub-category name of the flexible service, such as chair\_layout.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.sub\_category\_label
|
Sub-category label of the flexible service, such as Chair layout.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.sub\_title
|
Sub-title name of the child flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.sys\_id
|
Sys\_id of flexible service. Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.text
|
Text used to prompt a user to select flexible services.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.title
|
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"
}
```
|
|
result.flexible\_services.flexible\_service.flexible\_service.title.add
|
Title used when adding a child flexible service in the UI.Data type: String
|
|
result.flexible\_services.flexible\_service.flexible\_service.title.edit
|
Title used when editing a child flexible service in the UI.Data type: String
|
|
result.flexible\_services.flexible\_service.label
|
Flexible service label.Data type: String
|
|
result.flexible\_services.flexible\_service.sub\_category
|
Sub-category of the parent flexible services, such as additional chair.Data type: String
|
|
result.flexible\_services.flexible\_service.sub\_title
|
Sub-title name of the parent flexible service.Data type: String
|
|
result.flexible\_services.flexible\_service.text
|
Text used to prompt a user to select a parent flexible services.Data type: String
|
|
result.flexible\_services.flexible\_service.title
|
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"
}
```
|
|
result.flexible\_services.flexible\_service.title.add
|
Title used when adding a parent flexible service in the UI.Data type: String
|
|
result.flexible\_services.flexible\_service.title.edit
|
Title used when editing a parent flexible service in the UI.Data type: String
|
|
result.floor
|
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\]
|
|
result.floor.display\_value
|
Display number of the floor on which the reservable resides, such as 12.Data type: String
|
|
result.floor.sys\_id
|
Sys\_id of the associated record.Data type: String
Table: Floor \[sn\_wsd\_core\_floor\]
|
|
result.image
|
Details about an image that represents the associated reservable.Data type: Object
```
"image": {
"link": "String",
"sys_id": "String"
}
```
Table: Images \[db\_image\]
|
|
result.image.link
|
Link to an image that represents the reservable.Data type: String
|
|
result.image.sys\_id
|
Sys\_id of the associated image record.Data type: String
Table: Images \[db\_image\]
|
|
result.is\_reservable
|
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
|
|
results.layouts
|
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"
}
]
```
|
|
result.layouts.capacity
|
Number of people that will attend the meeting.Data type: Number
|
|
result.layouts.cleanup\_duration
|
Amount of time it takes to clean the reservable for this layout.Data type: Number
Unit: Milliseconds
|
|
result.layouts.image
|
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\]
|
|
result.layouts.image.link
|
Link to an image that represents the layout for this reservable.Data type: String
Table: Images \[db\_image\]
|
|
result.layouts.image.sys\_id
|
Sys\_id of the associated image record.Data type: String
|
|
result.layouts.is\_default
|
Flag that indicates whether the associated layout is the default for the reservable. Valid values:
- true: Default.
- false: Not default.
Data type: Boolean
|
|
result.layouts.max\_capacity
|
Maximum number of people that the layout associated with the reservable can accommodate.Data type: Number
|
|
result.layouts.name
|
Name of the location layout. Data type: String
|
|
result.layouts.preparation\_duration
|
Amount of time it takes to prepare the associated location layout.Data type: Number
Unit: Milliseconds
|
|
result.layouts.short\_description
|
Brief description of the location layout.Data type: String
|
|
result.layouts.sys\_id
|
Sys\_id of the location layout.Data type: String
Table: Layout \[sn\_wsd\_rsv\_layout\]
|
|
result.location\_type
|
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\]
|
|
result.location\_type.display\_value
|
Display value of the location type.Data type: String
|
|
result.location\_type.sys\_id
|
Sys\_id of the associated record.Data type: String
Table: Space Type \[sn\_wsd\_core\_space\_type\]
|
|
result.meetingProviders
|
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\]
|
|
result.meetingProviders.display\_value
|
Display value of the virtual provider's name.Data type: String
|
|
result.meetingProviders.value
|
Actual value for the virtual provider's name in the record.Data type: String
|
|
result.moduleType
|
Reservable module associated with the reservable, such as desks or meeting room.Data type: String
|
|
result.name
|
Name of the reservable.Data type: String
|
|
result.number
|
Unique identifier of the reservable. This value is more human readable than the sys\_id.Data type: String
|
|
result.order
|
Order number for the reservable.Data type: Number
|
|
result.require\_approval
|
Flag that indicates whether reserving the reservable requires an approval.Possible values:
- true: Approval required.
- false: Approval isn't required.
Data type: Boolean
|
|
result.requires\_check\_in
|
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
|
|
result.require\_subject
|
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
|
|
result.reservable\_quantity
|
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
|
|
result.site
|
Details about the site where the reservable resides.Data type: Object
```
"site": {
"display_value": "String",
"sys_id": "String"
}
```
Table: Site \[sn\_wsd\_core\_site\]
|
|
result.site.display\_value
|
Display value of the site.Data type: String
|
|
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\_icon
|
Name of the thumbnail icon associated with the standard service.Data type: String
|
|
result.standard\_services.name
|
Name of the standard service.Data type: String
|
|
result.standard\_services.short\_description
|
Brief description of the standard service.Data type: String
|
|
result.standard\_services.sys\_id
|
Sys\_id of the standard service record.Data type: String
Table: Standard Service \[sn\_wsd\_rsv\_standard\_service\]
|
|
result.site.sys\_id
|
Sys\_id of the associated site record.Data type: String
Table: Site \[sn\_wsd\_core\_site\]
|
|
result.tableName
|
Name of the table in which the reservable record resides. Data type: String
|
|
result.title
|
Title of the reservable.Data type: String
|
|
result.type
|
Type of a reservable, such as location.Data type: String
|