The Workplace Service Delivery (WSD) Reservable API provides endpoints to retrieve details of a reservable, an entity that can be reserved, such as a workplace location, from a ServiceNow instance.

Note: A newer version of this API, WSD Reservable V2 API, is available for use. The new version allows you to include all reservables in a POST request to avoid character limitations of the sys_Id parameter.

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.

WSD Reservable - GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}

Returns the details for one or more specified reservables.

URL format

Versioned URL: /api/sn_wsd_rsv/{api_version}/reservable/list_reservables/{sys_ids}

Default URL: /api/sn_wsd_rsv/reservable/list_reservables/{sys_ids}

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

Table 1. Path parameters
Name Description
api_version Optional. 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_ids Sys_ids of the reservables whose details to return.

If specifying multiple reservables, comma separate the sys_ids.

Data type: String

Table: Workplace Location [sn_wsd_core_workplace_location]
Table 3. Request body parameters
Name Description
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.

Table 4. Request headers
Header Description
Accept Data format of the response body. Supported types: application/json or application/xml.

Default: application/json
Table 5. Response headers
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.

Response body parameters

Example: cURL request

The following code example shows how to call this endpoint.

curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable/list_reservables/dad3df5977220110b3d7be377b5a99ce,3ed3139977220110b3d7be377b5a99d1?include_flexible_services=true&include_layouts=false&include_reservable_purposes=true&include_standard_services=true&reservable_module_sys_id=c31241cedb7650106c731dcd13961917" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Return results:

{
  "result": [
    {
      "sys_id": "3e41e94adb7210106c731dcd1396198c",
      "external_id": null,
      "wsd_email": null,
      "name": "A1-02-04",
      "title": "A1-02-04",
      "description": "General desk available for reservation.",
      "image": null,
      "number": "SPCE0009004",
      "site": {
        "sys_id": "628eec06db7650106c731dcd139619dd",
        "display_value": "North America"
      },
      "campus": {
        "sys_id": "82b2a0cedb3650106c731dcd139619e9",
        "display_value": "California Campus"
      },
      "building": {
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "timezone": {
          "value": "US/Pacific",
          "displayValue": "US/Pacific"
        }
      },
      "floor": {
        "sys_id": "fc7368cedb3650106c731dcd13961902",
        "display_value": "Floor 1"
      },
      "area": null,
      "capacity": "1",
      "reservable_quantity": null,
      "location_type": {
        "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
        "display_value": "Workspace/Desk"
      },
      "order": null,
      "requires_check_in": null,
      "is_reservable": "1",
      "type": "location",
      "moduleType": "Desks",
      "meetingProviders": [],
      "require_subject": false,
      "allow_invitees": true,
      "display_number_of_attendees": false,
      "display_on_behalf_of": true,
      "display_sensitivity": false,
      "enable_group_reservations": false,
      "enable_reservation_privacy": true,
      "employee_override_privacy": true,
      "tableName": "sn_wsd_core_space",
      "require_approval": false
    },
    {
      "sys_id": "fd41a94adb7210106c731dcd1396195a",
      "external_id": null,
      "wsd_email": null,
      "name": "A1-02-03",
      "title": "A1-02-03",
      "description": "General desk available for reservation.",
      "image": null,
      "number": "SPCE0009003",
      "site": {
        "sys_id": "628eec06db7650106c731dcd139619dd",
        "display_value": "North America"
      },
      "campus": {
        "sys_id": "82b2a0cedb3650106c731dcd139619e9",
        "display_value": "California Campus"
      },
      "building": {
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "timezone": {
          "value": "US/Pacific",
          "displayValue": "US/Pacific"
        }
      },
      "floor": {
        "sys_id": "fc7368cedb3650106c731dcd13961902",
        "display_value": "Floor 1"
      },
      "area": null,
      "capacity": "1",
      "reservable_quantity": null,
      "location_type": {
        "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
        "display_value": "Workspace/Desk"
      },
      "order": null,
      "requires_check_in": null,
      "is_reservable": "1",
      "type": "location",
      "moduleType": "Desks",
      "meetingProviders": [],
      "require_subject": false,
      "allow_invitees": true,
      "display_number_of_attendees": false,
      "display_on_behalf_of": true,
      "display_sensitivity": false,
      "enable_group_reservations": false,
      "enable_reservation_privacy": true,
      "employee_override_privacy": true,
      "tableName": "sn_wsd_core_space",
      "require_approval": false
    }
  ]
}