WSD 検索 API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：116分

ワークプレイスサービスデリバリ (WSD) 検索 API は、予約可能な場所と職場アイテム (予約可能なもの、予約可能なモジュール、利用可能なシフトなど) を検索するためのエンドポイントを提供します。

この API にアクセスするには、発信者に sn_wsd_core.workplace_user ロールが必要であり、ワークプレイス安全管理 (sn_wsd_core) プラグインとワークプレイス予約管理 (sn_wsd_rsv) プラグインがアクティブ化されている必要があります。

この API は sn_wsd_rsv 名前空間で実行されます。

ワークプレイス予約管理の詳細については、「ワークプレイス予約管理」を参照してください。

WSD 検索:GET /api/sn_wsd_rsv/search/availability

指定された予約が指定された時間使用可能かどうかを確認します。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/availability

デフォルト URL: /api/sn_wsd_rsv/search/availability

注:

使用可能なバージョンは、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
終了	必須です。利用可能な予約可能モジュールの検索に使用する終了時間。この値は、 start パラメーターで指定した値よりも後でなければなりません。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
include_reservations_within_days	終日予約可能な各応答で、利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。有効な値： true:すべての空きスロットを返します。 false:すべての空きスロットを返しません。データタイプ：ブーリアンデフォルト値：false
reservable_ids	必須です。可用性を評価するための予約可能なsys_idsのカンマ区切りリスト。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
reservation_ids	既存の予約sys_idsのカンマ区切りリスト。関連する予約を編集する場合は、このパラメーターを渡します。対応する予約のこれらのsys_idsにブロックされた時間は、利用可能として扱われます。データタイプ：文字列デフォルト：なしテーブル:職場予約 [sn_wsd_rsv_reservation]
reservable_module	必須です。検索に含める予約可能モジュールのSys_id。予約可能なモジュールは、類似するタイプの職場アイテムをグループ化します。データタイプ：文字列テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module]
schedule_view_obj	返されるスケジュールビューの詳細。1 日を超える予約の 24 時間の可用性データが必要な場合は、このオブジェクトを渡します。返される結果には、指定された日付の利用可能な時間と予約のみが含まれます。この機能を正しく機能させるには、パラメーター ignore_same_day_validation と include_reservations_within_days を `true` に設定する必要があります。データタイプ: オブジェクト `"schedule_view_obj": { "schedule_view_date": "String", "timezone": "String" }`
schedule_view_obj.schedule_view_date	予約可用性の戻りを開始する日付。この日付は、 schedule_view_obj.timezone パラメーターで指定されたタイムゾーンである必要があります。データタイプ：文字列形式：YYYY-MM-DD
schedule_view_obj.timezone	返す予約可用性データを決定するために使用する建物のタイムゾーン。例:US/Pacific。データタイプ：文字列
シフト	指定された予約可能モジュールがシフトに基づいている場合は必須です。予約に関連付けるシフトのSys_id。このパラメーターが渡される場合、 end パラメーターは必須ではありません。シフトベースの予約の詳細については、「シフトベースの予約を有効にする」を参照してください。データタイプ：文字列テーブル:シフト [sn_wsd_core_shift]
開始	必須です。利用可能な予約可能モジュールの検索に使用する開始時間。この値は、 end パラメーターで指定された値より前にする必要があります。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)

表 : 3. 要求本文のパラメーター
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	要求本文のデータ形式。サポートされているタイプ: application/json、 application/xml 、または text/xml。デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	指定された期間に利用可能なすべての再開可能のリスト。データタイプ：オブジェクトのアレイ `"result": [ { "availableTimes": [Array], "building": {Object}, "campus": {Object}, "email": "String", "floor": {Object}, "is_available": Boolean, "name": "String", "reservations": [Array], "sys_id": "String" } ]`
result.availableTimes	関連する予約が利用可能な日時のリスト。データタイプ：アレイ
result.building	予約可能に関連付けられている建物の詳細。データタイプ: オブジェクト `"building": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.building.display_value	建物の表示値。データタイプ：文字列
result.building.name	建物の名前。データタイプ：文字列
result.building.sys_id	関連付けられた建物レコードのSys_id。データタイプ：文字列
result.campus	予約に関連付けられた敷地の詳細。データタイプ: オブジェクト `"campus": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.campus.display_value	予約可能項目が存在する敷地の表示番号 (イーストベイなど)。データタイプ：文字列
result.campus.name	敷地の名前。データタイプ：文字列
result.campus.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:敷地 [sn_wsd_core_campus]
result.email	関連する予約可能ファイルのメールアドレス。データタイプ：文字列
result.floor	予約可能に関連付けられたフロアの詳細。データタイプ: オブジェクト `"floor": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.floor.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.floor.name	予約可能ファイルが存在するフロアの名前。データタイプ：文字列
result.floor.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.is_available	予約可能が予約可能かどうかを示すフラグ。有効な値： true:予約可能。 false:予約できません。データタイプ：ブーリアン
result.name	予約可能の名前。データタイプ：文字列
result.reservations	関連する予約の詳細。データタイプ：オブジェクトのアレイ `"reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ]`
result.reservations.configuration_item	予約に対応する構成アイテム。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
result.reservations.end	予約の終了日時。データタイプ：文字列形式:UTC:yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservations.is_collided	予約が検索の開始時間と終了時間と競合するかどうかを示すフラグ。これは、関連付けられた予約可能な場所が、指定された検索タイムスパンにわたって既に予約されていることを示します。可能な値： true:衝突。 false:衝突はありません。データタイプ：ブーリアン
result.reservations.location	予約の場所に関する詳細。データタイプ: オブジェクト `"location": { "location": "String", "timezone": {Object} }`
result.reservations.location.location	関連付けられた場所レコードのSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservations.location.timezone	場所に関連付けられたタイムゾーンの詳細。データタイプ: オブジェクト `"timezone": { "displayValue": "String", "value": "String" }`
result.reservations.location.timezone.displayValue	この場所が属するタイムゾーンの表示値。データタイプ：文字列
result.reservations.location.timezone.value	この場所が属するタイムゾーンの内部値。データタイプ：文字列
result.reservations.number	予約番号。データタイプ：文字列
result.reservations.requested_for	代理で予約を要求されたユーザーの詳細。データタイプ: オブジェクト `"requested_for": { "name": "String", "sys_id": "String" }`
result.reservations.requested_for.name	予約が要求されたユーザーの名前。データタイプ：文字列
result.reservations.requested_for.sys_id	予約を要求されているユーザーのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
result.reservations.reservation_purpose	予約の目的に関する詳細。データタイプ: オブジェクト `"reservation_purpose": { "display_value": "String", "value": "String" }`
result.reservations.reservation_purpose。display_value	会社の会議など、予約の目的に応じた表示値。データタイプ：文字列
result.reservations.reservation_purpose.value	company_meeting などの予約目的の内部値。データタイプ：文字列
result.reservations.start	予約の開始日時。データタイプ：文字列形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservations.state	場所の予約状況に関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
result.reservations.state.display_value	予約の現在のステータスの表示値 (確認済みなど)。データタイプ：文字列
result.reservations.state.value	予約の現在のステータスの内部値 (2 など)。データタイプ：文字列
result.reservations.subject	予約の件名。データタイプ：文字列
result.reservations.sys_id	必須です。予約レコードのSys_id。データタイプ：文字列テーブル:職場予約 [sn_wsd_rsv_reservation]

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。注意:読みやすくするために、クエリパラメーターに改行が追加されました。

curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability?
reservable_module=5db44502dbb650106c731dcd13961937&
start=2023-10-12T11:00:00Z&
end=2023-10-15T12:00:00Z&
reservable_ids=adb35f1977220110b3d7be377b5a99fc&
reservation_ids=undefined&
shift=undefined&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
timezone=Europe/Paris&
include_reservations_within_days=true&
ignore_same_day_validation=true&
include_unavailable_items=true"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

結果を返します:

{
  "result": [
    {
      "sys_id": "fe1f744edb7650106c731dcd139619ca",
      "email": null,
      "name": "Aspen",
      "is_available": true,
      "availableTimes": [
        [
          "2022-04-23 07:00:00",
          "2022-04-23 08:30:00"
        ],
        [
          "2022-04-23 09:30:00",
          "2022-04-23 23:00:00"
        ],
        [
          "2022-04-24 00:00:00",
          "2022-04-24 06:59:59"
        ]
      ],
      "floor": {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "name": "Floor 2"
      },
      "building": {
        "sys_id": "94e264cedb3650106c731dcd13961919",
        "display_value": "CAL-B1",
        "name": "CAL-B1"
      },
      "campus": {
        "sys_id": "82b2a0cedb3650106c731dcd139619e9",
        "display_value": "California Campus",
        "name": "California Campus"
      },
      "reservations": [
        {
          "sys_id": "5fe65830874bc9106342b846dabb352b",
          "number": "WRES0001001",
          "location": {
            "location": "fe1f744edb7650106c731dcd139619ca",
            "timezone": {
              "value": "US/Pacific",
              "displayValue": "US/Pacific"
            }
          },
          "configuration_item": null,
          "start": "2022-04-23T08:30:00Z",
          "end": "2022-04-23T09:30:00Z",
          "subject": null,
          "reservation_purpose": {
            "value": "meeting",
            "display_value": "Meeting"
          },
          "state": {
            "value": "confirmed",
            "display_value": "Confirmed"
          },
          "is_collided": false,
          "requested_for": {
            "sys_id": "2de07e1887cb89106342b846dabb35fe",
            "name": "Workplace User"
          }
        }
      ]
    }
  ]
}

WSD 検索:GET /api/sn_wsd_rsv/search/best_match

指定された検索条件に基づいて、最適な予約可能アイテムを検索します。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/best_match

デフォルト URL: /api/sn_wsd_rsv/search/best_match

注:

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
best_match_count	返すベストマッチ予約の数。データタイプ：数値デフォルト値：1
終了	必須です。利用可能な予約可能モジュールの検索に使用する終了時間。この値は、 start パラメーターで指定した値よりも後でなければなりません。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
include_reservable_purposes	返される結果の予約可能項目ごとに職場の場所を予約する目的を返すかどうかを示すフラグ。有効な値： true:予約可能な目的を返します。 false:予約可能な目的を返しません。データタイプ：ブーリアンデフォルト値：false テーブル:予約可能な目的 [sn_wsd_rsv_reservable_purpose]
include_reservations_within_days	終日予約可能な各応答で、利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。有効な値： true:すべての空きスロットを返します。 false:すべての空きスロットを返しません。データタイプ：ブーリアンデフォルト値：false
include_standard_services	応答で標準サービス情報を返すかどうかを示すフラグ。この情報は、標準サービス [sn_wsd_rsv_standard_service] テーブルにあります。標準サービスでは、ホワイトボード、追加のモニター、および類似のサービスなど、予約時に予約可能な職場アイテムで使用できる基本的な規定について説明します。標準サービスの詳細については、「標準サービス」を参照してください。有効な値： true:標準サービス情報を返します。 false:標準サービス情報を返しません。データタイプ：ブーリアンデフォルト値：false
q	必須です。検索リターン結果をフィルタリングするために使用するエンコードされたクエリ。このクエリーでは、建物のsys_idを指定する必要があり、フロア、エリア、キャパシティ、標準サービス、reservable_purposesなどのパラメーターを指定できます。渡されたパラメーターはすべてsys_idsである必要がありますが、キャパシティは数値です。例：`q=building=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacity>=1^standard_services=55c0818edb7650106c731dcd13961904^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81` この情報は、次の表で確認できます。エリア:sn_wsd_core_area 建物:sn_wsd_core_building フロア:sn_wsd_core_floor 予約可能な目的:sn_wsd_rsv_reservable_purpose 標準サービス:sn_wsd_rsv_standard_service データタイプ：文字列
reservable_module	必須です。検索に含める予約可能モジュールのSys_id。予約可能なモジュールは、類似するタイプの職場アイテムをグループ化します。データタイプ：文字列テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module]
開始	必須です。利用可能な予約可能モジュールの検索に使用する開始時間。この値は、 end パラメーターで指定された値より前にする必要があります。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
time_slot	最も一致する予約可能を探すタイムスロットレコードのSys_id。データタイプ：文字列デフォルト：なしテーブル:タイムスロット [sn_wsd_rsv_time_slot]
タイムゾーン	優先タイムゾーン (Europe/Amsterdam など)。データタイプ：文字列デフォルト：なし

表 : 9. 要求本文のパラメーター
ヘッダー	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	予約可能な最適な一致の結果を返します。データタイプ: オブジェクト `"result": { "floorsOfSelectedBuilding": [Array], "hasMore": Boolean, "nextItemIndex": Number, "reservableContainers": [Array], "reservableUnits": [Array] }`
result.floorsOfSelectedBuilding	予約可能ファイルが配置されているフロアの詳細。データタイプ：オブジェクトのアレイ `"floorsOfSelectedBuilding": [ { "display_value": "String", "external_id": "String", "name": "String", "sys_id": "String" } ]`
result.floorsOfSelectedBuilding.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.floorsOfSelectedBuilding.external_id	フロアの外部識別子。データタイプ：文字列
result.floorsOfSelectedBuilding.name	予約可能ファイルが存在するフロアの名前。データタイプ：文字列
result.floorsOfSelectedBuilding.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.hasMore	返される結果にさらに予約可能があるかどうかを示すフラグ。可能な値： true:利用可能な予約が増えます。 false:利用可能な予約はこれ以上ありません。データタイプ：ブーリアン
result.nextItemIndex	次にフェッチする予約可能なレコードのインデックス。予約可能レコードをページネーションするときにこの値を使用します。データタイプ：数値
result.reservableContainers	selection_typeフィールドが `コンテナ`に設定されている予約可能なモジュールに対してのみ返されます。コンテナは、デスクのグループなど、類似したアイテムをグループ化したものです。データタイプ：オブジェクトのアレイ `"reservableContainers": [ { "building": {Object}, "campus": {Object}, "capacity": Number, "display_value": "String", "floor": {Object}, "image": {Object} "sys_id": "String" } ]`
result.reservableContainers.building	予約可能コンテナに関連付けられている建物の詳細。データタイプ: オブジェクト `"building": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.reservableContainers.building.display_value	建物の表示値。データタイプ：文字列
result.reservableContainers.building.name	建物の名前。データタイプ：文字列
result.reservableContainers.building.sys_id	関連付けられた建物レコードのSys_id。データタイプ：文字列
result.reservableContainers.campus	予約可能項目がある敷地の詳細。データタイプ: オブジェクト `"campus": { "display_value": "String", "name": "String", "sys_id": "String" }` テーブル:敷地 [sn_wsd_core_campus]
result.reservableContainers.campus.display_value	予約可能項目が存在する敷地の表示番号 (イーストベイなど)。データタイプ：文字列
result.reservableContainers.campus.name	敷地の名前。データタイプ：文字列
result.reservableContainers.campus.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:敷地 [sn_wsd_core_campus]
result.reservableContainers.capacity	予約可能な施設の最大入室者数。データタイプ：数値
result.reservableContainers.display_value	予約可能コンテナの表示値。データタイプ：文字列
result.reservableContainers.floor	予約可能コンテナに関連付けられているフロアの詳細。データタイプ: オブジェクト `"floor": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.reservableContainers.floor.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.reservableContainers.floor.name	予約可能ファイルが存在するフロアの名前。データタイプ：文字列
result.reservableContainers.floor.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.reservableContainers.image	関連する予約可能項目のレイアウトを表す画像の詳細。データタイプ: オブジェクト `"image": { "link": "String", "sys_id": "String" }` テーブル:イメージ [db_image]
result.reservableContainers.image.link	この予約可能なレイアウトを表す画像へのリンク。データタイプ：文字列テーブル:イメージ [db_image]
result.reservableContainers.image.sys_id	関連付けられたイメージレコードのSys_id。データタイプ：文字列
result.reservableContainers.sys_id	関連付けられたコンテナーレコードのSys_id。データタイプ：文字列テーブル:これが存在するテーブルは、任意のコンテナタイプに対して構成できます。デフォルトでは、エリア [sn_wsd_core_area] テーブルにあります。
result.reservableUnits	指定された検索条件に一致する予約可能単位の詳細。予約可能ユニットは、机や椅子などの単一の予約可能なアイテムです。データタイプ：オブジェクトのアレイ "reservableUnits": [ { "area": "String", "availableTimes": [Array], "building": {Object}, "campus": {Object}, "capacity": "String", "defaultPrivacyValue": Boolean, "description": "String", "email": "String", "external_id": "String", "floor": {Object}, "image": {Object}, "includedInResult": Boolean, "is_available": Boolean, "is_favorite": Boolean, "is_reservable": "String", "is_reserved": Boolean, "is_selected": Boolean, "location_type": {Object}, "name": "String", "number": "String", "order": "String", "require_approval": Boolean, "requires_check_in": Boolean, "reservable_quantity": "String", "showPrivacyOption": Boolean, "site": {Object}, "standard_services": [Array], "tableName": "String", "title": "String", “reservable_purposes”: [Array], "reservations": [Array], "sys_id": "String" } ]
result.reservableUnits.area	予約可能なモジュールが配置されているエリアに関する詳細。データタイプ: オブジェクト `"area": { "display_value": "String", "sys_id": "String" }` テーブル:エリア [sn_wsd_core_area]
result.reservableUnits.area.display_value	予約可能モジュール領域の表示値。データタイプ：文字列
result.reservableUnits.area.sys_id	予約に関連付けられたエリアレコードのSys_id。データタイプ：文字列
result.reservableUnits.availableTimes	関連する予約が利用可能な日時のリスト。データタイプ：アレイ
result.reservableUnits.building	予約可能項目が配置されている建物の詳細。データタイプ: オブジェクト `"building": { "display_value": "String", "sys_id": "String" }` テーブル:建物 [sn_wsd_core_building]
result.reservableUnits.building.display_value	建物の表示値。データタイプ：文字列
result.reservableUnits.building.sys_id	関連付けられた建物レコードのSys_id。データタイプ：文字列
result.reservableUnits.campus	予約可能項目がある敷地の詳細。データタイプ: オブジェクト `"campus": { "display_value": "String", "sys_id": "String" }` テーブル:敷地 [sn_wsd_core_campus]
result.reservableUnits.campus.display_value	予約可能項目が存在する敷地の表示番号 (イーストベイなど)。データタイプ：文字列
result.reservableUnits.campus.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:敷地 [sn_wsd_core_campus]
result.reservableUnits.capacity	予約可能な施設の最大入室者数。データタイプ：数値
result.reservableUnits.defaultPrivacyValue	予約可能なデフォルトのプライバシー設定を示すフラグ。これらのプライバシー設定の詳細については、「場所のプライバシー設定と影響」を参照してください。可能な値： true:予約可能な場合のプライバシー設定を上書きできます。 false:予約可能な場合のプライバシー設定は上書きできません。データタイプ：ブーリアン
result.reservableUnits.description	予約の簡単な説明。データタイプ：文字列
result.reservableUnits.email	予約可能ファイルのメールアドレス。データタイプ：文字列
result.reservableUnits.external_id	CMS でマッピングされたスペースの同期に使用される予約可能項目の外部 ID。この値は、この場所に関連付けられたマップがある場合にのみ設定されます。データタイプ：文字列
result.reservableUnits.floor	予約可能ファイルが配置されているフロアの詳細。データタイプ: オブジェクト `"floor": { "display_value": "String", "sys_id": "String" }` テーブル:フロア [sn_wsd_core_floor]
result.reservableUnits.floor.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.reservableUnits.floor.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.reservableUnits.image	関連する予約可能項目のレイアウトを表す画像の詳細。データタイプ: オブジェクト `"image": { "link": "String", "sys_id": "String" }` テーブル:イメージ [db_image]
result.reservableUnits.image.link	この予約可能なレイアウトを表す画像へのリンク。データタイプ：文字列テーブル:イメージ [db_image]
result.reservableUnits.image.sys_id	関連付けられたイメージレコードのSys_id。データタイプ：文字列
result.reservableUnits.includedInResult	現在の予約が返される結果に含まれるかどうかを示すフラグ。有効な値： true:返される結果に含まれます。 false:返される結果に含まれません。データタイプ：ブーリアン
result.reservableUnits.is_available	予約可能が予約可能かどうかを示すフラグ。有効な値： true:予約可能。 false:予約できません。データタイプ：ブーリアン
result.reservableUnits.is_favorite	予約可能が関連付けられたユーザーのお気に入りの 1 つとしてフラグが付けられているかどうかを示すフラグ。有効な値： true:お気に入り。 false:お気に入りではありません。データタイプ：ブーリアン
result.reservableUnits.is_reservable	この予約可能を予約できるかどうかを示すフラグ。注: include_unavailable_itemsクエリパラメーターが true に設定されている場合は、利用できない場所も返されます。この場合、場所が既に予約されている場合、 is_available パラメーターは false ですが、 is_reservable は true です。有効な値： true:予約可能。 false:予約できません。データタイプ：ブーリアン
result.reservableUnits.is_reserved	予約可能が既に予約されているかどうかを示すフラグ。有効な値： true:予約可能。 false:予約済みです。データタイプ：ブーリアン
result.reservableUnits.is_selected	予約可能が既に予約されているかどうかを示すフラグ。有効な値： true:予約可能。 false:予約済みです。データタイプ：ブーリアン
result.reservableUnits.location_type	職場/デスク、カフェ、ジムなど、予約可能な場所のタイプに関する詳細。データタイプ: オブジェクト `"location_type": { "display_value": "String", "name": "String", "sys_id": "String" }` テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.location_type。display_value	場所タイプの表示値。データタイプ：文字列
result.reservableUnits.location_type.name	地下室やストレージなどの場所タイプの名前。表示値と同じです。データタイプ：文字列
result.reservableUnits.location_type.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:スペースタイプ [sn_wsd_core_space_type]
result.reservableUnits.name	予約可能の名前。データタイプ：文字列
result.reservableUnits.number	予約可能ファイルの一意の識別子。この値は、sys_idよりも人間が判読しやすくなります。データタイプ：文字列
result.reservableUnits.order	予約の順序番号。データタイプ：数値
result.reservableUnits.require_approval	予約可能を予約するには承認が必要かどうかを示すフラグ。可能な値： true:承認が必要です。 false:承認は必要ありません。データタイプ：ブーリアン
result.reservableUnits.requires_check_in	予約可能でユーザーにチェックインが必要かどうかを示すフラグ。有効な値： true:チェックインが必要です。 false:チェックインは必要ありません。データタイプ：ブーリアン
result.reservableUnits.reservable_purposes	関連する予約可能項目を予約する目的の詳細。データタイプ：オブジェクトのアレイ `"reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.reservableUnits.reservable_purposes。名前	予約可能の名前。データタイプ：文字列
result.reservableUnits.reservable_purposes。short_description	予約の簡単な説明。データタイプ：文字列
result.reservableUnits.reservable_purposes。sys_id	予約可能な目的レコードのSys_id。データタイプ：文字列テーブル:予約可能な目的 [sn_wsd_rsv_reservable_purpose]
result.reservableUnits.reservations	予約に関連付けられた予約に関する詳細。include_reservations_within_daysクエリパラメーターが true で、reservation_ids パラメーターに予約 ID が含まれている場合のみ設定されます。つまり、この予約可能項目には予約が既に存在します。データタイプ：オブジェクトのアレイ `"reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ]`
result.reservableUnits.reservations.configuration_item	予約に対応する構成アイテム。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
result.reservableUnits.reservations.end	予約の終了日時。データタイプ：文字列形式:UTC:yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservableUnits.reservations.is_collided	予約が検索の開始時間と終了時間と競合するかどうかを示すフラグ。これは、関連付けられた予約可能な場所が、指定された検索タイムスパンにわたって既に予約されていることを示します。可能な値： true:衝突。 false:衝突はありません。データタイプ：ブーリアン
result.reservableUnits.reservations.location	予約の場所に関する詳細。データタイプ: オブジェクト `"location": { "location": "String", "timezone": {Object} }`
result.reservableUnits.reservations.location.location	関連付けられた場所レコードのSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.reservations.location.timezone	場所に関連付けられたタイムゾーンの詳細。データタイプ: オブジェクト `"timezone": { "displayValue": "String", "value": "String" }`
result.reservableUnits.reservations.location.timezone.displayValue	この場所が属するタイムゾーンの表示値。データタイプ：文字列
result.reservableUnits.reservations.location.timezone.value	この場所が属するタイムゾーンの内部値。データタイプ：文字列
result.reservableUnits.reservations.number	予約可能ファイルの一意の識別子。この値は、sys_idよりも人間が判読しやすくなります。データタイプ：文字列
result.reservableUnits.reservations.requested_for	代理で予約を要求されたユーザーの詳細。データタイプ: オブジェクト `"requested_for": { "name": "String", "sys_id": "String" }`
result.reservableUnits.reservations.requested_for.name	予約が要求されたユーザーの名前。データタイプ：文字列
result.reservableUnits.reservations.requested_for.sys_id	予約を要求されているユーザーのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
result.reservableUnits.reservations.reservation_purpose	予約の目的に関する詳細。データタイプ: オブジェクト `"reservation_purpose": { "display_value": "String", "value": "String" }`
result.reservableUnits.reservations.reservation_purpose.display_value	会社の会議など、予約の目的に応じた表示値。データタイプ：文字列
result.reservableUnits.reservations.reservation_purpose.value	company_meeting などの予約目的の内部値。データタイプ：文字列
result.reservableUnits.reservations.start	予約の開始日時。データタイプ：文字列形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservableUnits.reservations.state	場所の予約状況に関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
result.reservableUnits.reservations.state.display_value	予約の現在のステータスの表示値 (確認済みなど)。データタイプ：文字列
result.reservableUnits.reservations.state.value	予約の現在のステータスの内部値 (2 など)。データタイプ：文字列
result.reservableUnits.reservations.subject	予約の件名。データタイプ：文字列
result.reservableUnits.reservations.sys_id	必須です。予約レコードのSys_id。データタイプ：文字列テーブル:職場予約 [sn_wsd_rsv_reservation]
result.reservableUnits.reservable_quantity	関連する予約可能項目を同時に予約できる最大回数。この値は、エリアに近隣スペースをアサインするときに使用されます。データタイプ：整数
result.reservableUnits.showPrivacyOption	従業員が関連する予約可能項目のプライバシー設定を上書きできるかどうかを示すフラグ。これらのプライバシー設定の詳細については、「場所のプライバシー設定と影響」を参照してください。有効な値： true:プライバシー設定を上書きできます。 false:プライバシー設定は上書きできません。データタイプ：ブーリアン
result.reservableUnits.site	予約可能ファイルが存在するサイトに関する詳細。データタイプ: オブジェクト `"site": { "display_value": "String", "sys_id": "String" }` テーブル:サイト [sn_wsd_core_site]
result.reservableUnits.site.display_value	サイトの表示値。データタイプ：文字列
result.reservableUnits.site.sys_id	関連付けられたサイトレコードのSys_id。データタイプ：文字列テーブル:サイト [sn_wsd_core_site]
result.reservableUnits.standard_services	関連する標準サービス (フリップチャート、プロジェクタースクリーン、ホワイトボードとマーカーなど)。データタイプ：オブジェクトのアレイ `"standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.reservableUnits.standard_services。font_awesome_icon	標準サービスに関連付けられたサムネイルアイコンの名前。データタイプ：文字列
result.reservableUnits.standard_services.name	標準サービスに関連付けられたサムネイルアイコンの名前。データタイプ：文字列
result.reservableUnits.standard_services。short_description	標準サービスの簡単な説明。データタイプ：文字列
result.reservableUnits.standard_services.sys_id	標準サービスレコードのSys_id。データタイプ：文字列テーブル:標準サービス [sn_wsd_rsv_standard_service]
result.reservableUnits.sys_id	予約可能なレコードのSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.tableName	予約可能なレコードが存在するテーブルの名前。データタイプ：文字列
result.reservableUnits.title	予約可能なタイトル。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/best_match?q=building%3D9e0364cedb3650106c731dcd1396192b&start=2023-01-04T07%3A00%3A00Z&time_slot=d5331cf2dbb5f01038e42b24ca961906&end=2023-01-04T17%3A00%3A00Z&best_match_count=1&reservable_module=2b636b7e1b4e60103523ff751a4bcbe2&timezone=Europe%2FAmsterdam" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

結果を返します:

{
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "abd0c18edb7650106c731dcd13961965",
            "name": "Projector screen",
            "short_description": "Connect laptop to screen (HDMI and DVI)",
            "font_awesome_icon": "fa-caret-square-o-right"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          },
          {
            "sys_id": "af075c30874bc9106342b846dabb3572",
            "number": "WRES0001002",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T23:00:00Z",
            "end": "2022-04-24T00:00:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ],
          [
            "2022-04-24 00:00:00",
            "2022-04-24 06:59:59"
          ]
        ],
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "2f554296dbba10106c731dcd139619ed",
        "display_value": "Floor 2",
        "external_id": null,
        "name": "Floor 2"
      }
    ]
  }
}{
  "result": {
    "hasMore": false,
    "reservableUnits": [
      {
        "sys_id": "32f2a98adb7210106c731dcd13961972",
        "external_id": null,
        "wsd_email": null,
        "name": "B1-03-04",
        "title": "B1-03-04",
        "description": "Desk reserved for the Team-C. After 10am, free to reserve for everyone.",
        "image": {
          "sys_id": "57b42dcadb7210106c731dcd13961945",
          "link": "57b42dcadb7210106c731dcd13961945.iix"
        },
        "number": "SPCE0009018",
        "site": {
          "sys_id": "b17220cedb3650106c731dcd1396197a",
          "display_value": "Western Europe"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1"
        },
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3"
        },
        "area": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1"
        },
        "capacity": "1",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "5f017383eb512010b89bfdfc9c5228c8",
          "display_value": "Workspace/Desk",
          "name": "Workspace/Desk"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_space",
        "require_approval": false,
        "is_available": true,
        "reservations": [],
        "availableTimes": [
          [
            "2023-01-04 07:00:00",
            "2023-01-04 17:00:00"
          ]
        ],
        "showPrivacyOption": false,
        "defaultPrivacyValue": false,
        "container": {
          "sys_id": "410ff04edb7650106c731dcd13961973",
          "display_value": "Desks C1",
          "floor": {
            "sys_id": "5373a8cedb3650106c731dcd1396198a",
            "display_value": "Floor 3",
            "name": "Floor 3"
          },
          "building": {
            "sys_id": "9e0364cedb3650106c731dcd1396192b",
            "display_value": "AMS-B1",
            "name": "AMS-B1"
          },
          "campus": {
            "sys_id": "44d2e0cedb3650106c731dcd13961988",
            "display_value": "Amsterdam Campus",
            "name": "Amsterdam Campus"
          },
          "capacity": 6,
          "image": {
            "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
            "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
          }
        },
        "includedInResult": true,
        "is_favorite": true
      }
    ],
    "reservableContainers": [
      {
        "sys_id": "410ff04edb7650106c731dcd13961973",
        "display_value": "Desks C1",
        "floor": {
          "sys_id": "5373a8cedb3650106c731dcd1396198a",
          "display_value": "Floor 3",
          "name": "Floor 3"
        },
        "building": {
          "sys_id": "9e0364cedb3650106c731dcd1396192b",
          "display_value": "AMS-B1",
          "name": "AMS-B1"
        },
        "campus": {
          "sys_id": "44d2e0cedb3650106c731dcd13961988",
          "display_value": "Amsterdam Campus",
          "name": "Amsterdam Campus"
        },
        "capacity": 6,
        "image": {
          "sys_id": "d52c27b21b8e60103523ff751a4bcb49",
          "link": "d52c27b21b8e60103523ff751a4bcb49.iix"
        }
      }
    ],
    "nextItemIndex": -1,
    "floorsOfSelectedBuilding": [
      {
        "sys_id": "5373a8cedb3650106c731dcd1396198a",
        "display_value": "Floor 3",
        "external_id": null,
        "name": "Floor 3"
      }
    ]
  }

WSD 検索:GET /api/sn_wsd_rsv/search/overlapping_reservation

渡されたパラメーターに基づいて、重複予約が存在するかどうかを判断します。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/overlapping_reservation

デフォルト URL: /api/sn_wsd_rsv/search/overlapping_reservation

注:

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 14. クエリパラメーター
名前	説明
終了	必須です。予約の重複を確認するために使用する終了時間。データタイプ：文字列形式:YYYY-MM-DDTHH:MM:SSZ
recurring_pattern	予約の繰り返しパターンに関する詳細。データタイプ: オブジェクト `"recurring_pattern": { "duration": Number, "options": {Object}, "repeats": "String", "startDate":"String" }`
recurring_pattern.duration	チェックする時間の長さ。データタイプ：数値単位：秒
recurring_pattern.options	繰り返し予約に関連付けられたオプションの詳細。データタイプ: オブジェクト `"options": { "count": Number, "daysOfWeek": "String", "every": Number }`
recurring_pattern.options.count	パターンが繰り返される回数。データタイプ：数値
recurring_pattern.options.daysOfWeek	重複を確認する曜日。有効な値： 1 = 月曜日 2 = 火曜日 3 = 水曜日 4 = 木曜日 5 = 金曜日 6 = 土曜日 7 = 日曜日たとえば、火曜日、木曜日、金曜日を指定するには、245 (区切り文字なし) を渡します。データタイプ：文字列
recurring_pattern.options.every	チェックするパターン繰り返し間隔。たとえば、この値が `2` の場合、隔日や隔週など、 repeats パラメーターの選択に基づいて繰り返しパターンをチェックします。データタイプ：数値
recurring_pattern.options.repeats	予約重複チェックの繰り返しパターン。可能な値:(大文字と小文字を区別) 日次月次週次年次データタイプ：文字列
reservable_id	予約が重複していないかチェックする予約可能モジュールのSys_id。データタイプ：文字列テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module]
reservation_id	重複を確認する予約のSys_id。この値は、複数/グループの親の編集フローで必要です。データタイプ：文字列テーブル:職場予約 [sn_wsd_rsv_reservation]
shift_info_object	重複を確認するシフトの詳細。シフトベースの予約の詳細については、「シフトベースの予約を有効にする」を参照してください。データタイプ: オブジェクト `"shift_info_object": { "applyToShift": Boolean, "shift": "String", "timezone": "String" }`
shift_info_object.applyToShift	予約可能なモジュールに対してシフトベースの予約が有効になっているかどうかを示すフラグ。有効な値： true:シフトベースの予約を許可します。 false:シフトベースの予約を許可しません。データタイプ：ブーリアン
shift_info_object.shift	予約に関連付けるシフトのSys_id。このパラメーターが渡される場合、 end パラメーターは必須ではありません。データタイプ：文字列テーブル:Shift [sn_wsd_core_shift]
shift_info_object.timezone	重複を確認するシフトのタイムゾーン。データタイプ：文字列
開始	必須です。予約の重複を確認するために使用する開始時間。データタイプ：文字列形式:YYY-MM-DDTHH:MM:SSZ
user_id	必須です。予約の重複を確認するユーザーのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]

表 : 15. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター (JSON または XML)


名前	説明
results	重複チェックの結果の詳細。データタイプ: オブジェクト `"results": { "isOverlapped": Boolean, "reservableId": "String" }`
results.isOverlapped	重複予約が存在するかどうかを示すフラグ。有効な値： true:重複する予約が存在します。 false:重複予約は存在しません。データタイプ：ブーリアン
results.reservableId	グループ予約の場合、重複が発生する予約のsys_id。データタイプ：文字列

cURL 要求

次のコード例は、特定のユーザーと、 start パラメーターと end パラメーターで示される特定の期間の予約の重複を確認する方法を示しています。

curl "http://instance.servicenow.com/api/sn_wsd_rsv/search/overlapping_reservation?user_id=2e617fecc3d365101e38b23bb00131ec&end=2023-06-19T8:00:00Z&start=2023-06-19T07:00:00Z" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

結果を返します:

{
"results": {
  "isOverlapped": True,
  "reservableId": ""
  }
}

WSD 検索:GET /api/sn_wsd_rsv/search/reservable

指定された予約可能モデル構成を使用して、利用可能な予約可能アイテムを検索します。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/reservable

デフォルト URL: /api/sn_wsd_rsv/search/reservable

注:

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 20. クエリパラメーター
名前	説明
終了	必須です。利用可能な予約可能モジュールの検索に使用する終了時間。この値は、 start パラメーターで指定した値よりも後でなければなりません。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
exclude_reservables	検索結果から除外する 1 つ以上の予約sys_idsのリスト。データタイプ:文字列またはアレイテーブル:これらのsys_idsが配置されるテーブルは、予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルの [reservable_table] フィールドで指定されます。スペース [sn_wsd_core_space] またはルーム [sn_wsd_core_room] テーブルのいずれかです。
ignore_same_day_validation	予約検索で開始パラメーターと終了パラメーターの間の日付検証の変更を無視するかどうかを示すフラグ。有効な値： true:変更日の検証を無視します。 false:変更日の検証を無視しません。データタイプ：ブーリアンデフォルト値：false
include_reservable_purposes	返される結果の予約可能項目ごとに職場の場所を予約する目的を返すかどうかを示すフラグ。有効な値： true:予約可能な目的を返します。 false:予約可能な目的を返しません。データタイプ：ブーリアンデフォルト値：false テーブル:予約可能な目的 [sn_wsd_rsv_reservable_purpose]
include_reservations_within_days	終日予約可能な各応答で、利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。有効な値： true:すべての空きスロットを返します。 false:すべての空きスロットを返しません。データタイプ：ブーリアンデフォルト値：false
include_standard_services	応答で標準サービス情報を返すかどうかを示すフラグ。この情報は、標準サービス [sn_wsd_rsv_standard_service] テーブルにあります。標準サービスでは、ホワイトボード、追加のモニター、および類似のサービスなど、予約時に予約可能な職場アイテムで使用できる基本的な規定について説明します。標準サービスの詳細については、「標準サービス」を参照してください。有効な値： true:標準サービス情報を返します。 false:標準サービス情報を返しません。データタイプ：ブーリアンデフォルト値：false
near_by_location_id	rsv_pathパラメーターが `browse_near_a_person` に設定されている場合は必須です。エンコードされたクエリで使用する場所のSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
近隣	`rsv_path`パラメーターが `browse_by_neighborhood` に設定されている場合は必須です。スペース管理 (sn_wsd_spc_mgmt_neighborhood) プラグインがアクティブ化されている場合にのみ使用できます。エンコードされたクエリで使用する近隣レコードのSys_id。近隣スペースの予約の詳細については、「 Create neighborhood reservations」を参照してください。データタイプ：文字列テーブル:近隣 [sn_wsd_spcmgmt_neighborhood]
next_item_index	次に取得するアイテムのインデックス。返される結果をページネーションするときに、このパラメーターを渡します。データタイプ：数値デフォルト：0
page_size	返される結果で返すレコードの最大数。データタイプ：数値デフォルト値:6
q	必須です。検索リターン結果をフィルタリングするために使用するエンコードされたクエリ。このクエリーでは、建物のsys_idを指定する必要があり、フロア、エリア、キャパシティ、標準サービス、reservable_purposesなどのパラメーターを指定できます。渡されたパラメーターはすべてsys_idsである必要がありますが、キャパシティは数値です。例：`q=building=94e264cedb3650106c731dcd13961919^floorINfc7368cedb3650106c731dcd13961902^capacity>=1^standard_services=55c0818edb7650106c731dcd13961904^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81` この情報は、次の表で確認できます。エリア:sn_wsd_core_area 建物:sn_wsd_core_building フロア:sn_wsd_core_floor 予約可能な目的:sn_wsd_rsv_reservable_purpose 標準サービス:sn_wsd_rsv_standard_service データタイプ：文字列
reservable_module	必須です。検索に含める予約可能モジュールのSys_id。予約可能なモジュールは、類似するタイプの職場アイテムをグループ化します。データタイプ：文字列テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module]
reservation_ids	既存の予約sys_idsのカンマ区切りリスト。関連する予約を編集する場合は、このパラメーターを渡します。対応する予約のこれらのsys_idsにブロックされた時間は、利用可能として扱われます。データタイプ：文字列デフォルト：なしテーブル:職場予約 [sn_wsd_rsv_reservation]
rsv_path	検索に適用する予約パス。有効な値： browse_all:すべての予約を検索します。 browse_by_area:特定の場所の近くの予約を検索します。エンコードされたクエリー (q パラメーター) でエリア識別子を渡す必要があります。 browse_by_neighborhood: neighborhood パラメーターで指定された近隣の近くの予約可能施設を検索します。 browse_near_a_person: near_by_location_id パラメーターで指定されたユーザーのワークプレイスの場所の近くの予約を検索します。データタイプ：文字列デフォルト値:browse_all
schedule_view_obj	返されるスケジュールビューの詳細。1 日を超える予約の 24 時間の可用性データが必要な場合は、このオブジェクトを渡します。返される結果には、指定された日付の利用可能な時間と予約のみが含まれます。この機能を正しく機能させるには、パラメーター ignore_same_day_validation と include_reservations_within_days を `true` に設定する必要があります。データタイプ: オブジェクト `"schedule_view_obj": { "schedule_view_date": "String", "timezone": "String" }`
schedule_view_obj.schedule_view_date	予約可用性の戻りを開始する日付。この日付は、 schedule_view_obj.timezone パラメーターで指定されたタイムゾーンである必要があります。データタイプ：文字列形式：YYYY-MM-DD
schedule_view_obj.timezone	返す予約可用性データを決定するために使用する建物のタイムゾーン。例:US/Pacific。データタイプ：文字列
開始	必須です。利用可能な予約可能モジュールの検索に使用する開始時間。この値は、 end パラメーターで指定された値より前にする必要があります。データタイプ：文字列形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
シフト	予約に関連付けるシフトのSys_id。このパラメーターが渡される場合、 end パラメーターは必須ではありません。シフトベースの予約の詳細については、「シフトベースの予約を有効にする」を参照してください。データタイプ：文字列テーブル:シフト [sn_wsd_core_shift]
sort_by	返却された予約可能アイテムの希望するソート順。有効な値： a_z:昇順のソート順。 favorites_first:ユーザーのお気に入りの職場の予約可能項目から順にソートされ、残りは昇順でソートされます。 z_a:降順のソート順。データタイプ：文字列デフォルト:a_z
タイムゾーン	優先タイムゾーン (Europe/Amsterdam など)。データタイプ：文字列デフォルト：なし

表 : 21. 要求本文のパラメーター
名前	説明
なし

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	要求本文のデータ形式。サポートされているタイプ: application/json、 application/xml 、または text/xml。デフォルト： application/json

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	指定された検索結果を返します。データタイプ: オブジェクト `"result": { "filter": {Object}, "hasMore": Boolean, "nextFavIndex": Number, "nextItemIndex": Number, "reservableContainers": [Array], "reservableUnits": [Array], "totalProcessed": Number }`
result.filter	フロア、標準サービス、および予約可能な予約可能な目的に関する詳細。include_standard_services パラメーターまたは include_reservable_purposes パラメーターが false に設定されている場合、standard_services と reservable_purposes は空のアレイです。データタイプ: オブジェクト `"filter": { "floors": [Array], "reservable_purposes": [Array], "standard_services": [Array] }`
result.filter.floors	予約可能ファイルが配置されているフロアの詳細。データタイプ: オブジェクト `"floors": [ { "display_value": "String", "sys_id": "String" } ]`
result.filter.floors.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.filter.floors.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.filter.standard_services	include_standard_servicesパラメーターが true に設定されている場合にのみ設定されます。関連する標準サービス (フリップチャート、プロジェクタースクリーン、ホワイトボードとマーカーなど)。データタイプ：オブジェクトのアレイ `"standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.filter.standard_services。font_awesome_icon	標準サービスに関連付けられたサムネイルアイコンの名前。データタイプ：文字列
result.filter.standard_services.name	標準サービスの名前。データタイプ：文字列
result.filter.standard_services.short_description	標準サービスの簡単な説明。データタイプ：文字列
result.filter.standard_services.sys_id	標準サービスレコードのSys_id。データタイプ：文字列テーブル:標準サービス [sn_wsd_rsv_standard_service]
result.filter.reservable_purposes	関連する予約可能項目を予約する目的の詳細。データタイプ：オブジェクトのアレイ `"reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.filter.reservable_purposes.name	予約可能の名前。データタイプ：文字列
result.filter.reservable_purposes。short_description	予約の簡単な説明。データタイプ：文字列
result.filter.reservable_purposes.sys_id	予約可能な目的レコードのSys_id。データタイプ：文字列テーブル:予約可能な目的 [sn_wsd_rsv_reservable_purpose]
result.hasMore	返される結果にさらに予約可能があるかどうかを示すフラグ。可能な値： true:利用可能な予約が増えます。 false:利用可能な予約はこれ以上ありません。データタイプ：ブーリアン
result.nextFavIndex	ユーザーが予約可能な次のお気に入りのインデックス。ユーザーのお気に入りの予約をページネーションするときに、この値を使用します。データタイプ：数値
result.nextItemIndex	次にフェッチする予約可能なレコードのインデックス。予約可能レコードをページネーションするときにこの値を使用します。データタイプ：数値
result.reservableContainers	selection_typeフィールドが `コンテナ`に設定されている予約可能なモジュールに対してのみ返されます。コンテナは、デスクのグループなど、類似したアイテムをグループ化したものです。データタイプ：オブジェクトのアレイ `"reservableContainers": [ { "building": {Object}, "campus": {Object}, "capacity": Number, "display_value": "String", "floor": {Object}, "image": {Object} "sys_id": "String" } ]`
result.reservableContainers.building	予約可能コンテナに関連付けられている建物の詳細。データタイプ: オブジェクト `"building": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.reservableContainers.building.display_value	建物の表示値。データタイプ：文字列
result.reservableContainers.building.name	建物の名前。データタイプ：文字列
result.reservableContainers.building.sys_id	関連付けられた建物レコードのSys_id。データタイプ：文字列
result.reservableContainers.campus	予約可能項目がある敷地の詳細。データタイプ: オブジェクト `"campus": { "display_value": "String", "name": "String", "sys_id": "String" }` テーブル:敷地 [sn_wsd_core_campus]
result.reservableContainers.campus.display_value	予約可能項目が存在する敷地の表示番号 (イーストベイなど)。データタイプ：文字列
result.reservableContainers.campus.name	敷地の名前。データタイプ：文字列
result.reservableContainers.campus.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:敷地 [sn_wsd_core_campus]
result.reservableContainers.capacity	予約可能な施設の最大入室者数。データタイプ：数値
result.reservableContainers.display_value	予約可能コンテナの表示値。データタイプ：文字列
result.reservableContainers.floor	予約可能コンテナに関連付けられているフロアの詳細。データタイプ: オブジェクト `"floor": { "display_value": "String", "name": "String", "sys_id": "String" }`
result.reservableContainers.floor.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.reservableContainers.floor.name	予約可能ファイルが存在するフロアの名前。データタイプ：文字列
result.reservableContainers.floor.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.reservableContainers.image	この予約可能なレイアウトを表す画像へのリンク。データタイプ：文字列テーブル:イメージ [db_image]
result.reservableContainers.image.link	この予約可能なレイアウトを表す画像へのリンク。データタイプ：文字列テーブル:イメージ [db_image]
result.reservableContainers.image.sys_id	関連付けられたイメージレコードのSys_id。データタイプ：文字列
result.reservableContainers.sys_id	関連付けられたコンテナーレコードのSys_id。データタイプ：文字列テーブル:これが存在するテーブルは、任意のコンテナタイプに対して構成できます。デフォルトでは、エリア [sn_wsd_core_area] テーブルにあります。
result.reservableUnits	指定された検索条件に一致する予約可能単位の詳細。予約可能ユニットは、机や椅子などの単一の予約可能なアイテムです。データタイプ：オブジェクトのアレイ "reservableUnits": [ { "area": "String", "availableTimes": [Array], "building": {Object}, "campus": {Object}, "capacity": "String", "defaultPrivacyValue": Boolean, "description": "String", "email": "String", "external_id": "String", "floor": {Object}, "image": {Object}, "includedInResult": Boolean, "is_available": Boolean, "is_favorite": Boolean, "is_reservable": "String", "is_reserved": Boolean, "is_selected": Boolean, "location_type": {Object}, "name": "String", "number": "String", "order": "String", "require_approval": Boolean, "requires_check_in": Boolean, "reservable_quantity": "String", "showPrivacyOption": Boolean, "site": {Object}, "standard_services": [Array], "tableName": "String", "title": "String", “reservable_purposes”: [Array], "reservations": [Array], "sys_id": "String" } ]
result.reservableUnits.area	予約可能なモジュールが配置されているエリアに関する詳細。データタイプ: オブジェクト `"area": { "display_value": "String", "sys_id": "String" }` テーブル:エリア [sn_wsd_core_area]
result.reservableUnits.area.display_value	予約可能モジュール領域の表示値。データタイプ：文字列
result.reservableUnits.area.sys_id	予約に関連付けられたエリアレコードのSys_id。データタイプ：文字列
result.reservableUnits.availableTimes	関連する予約が利用可能な日時のリスト。データタイプ：アレイ
result.reservableUnits.building	予約可能項目が配置されている建物の詳細。データタイプ: オブジェクト `"building": { "display_value": "String", "sys_id": "String" }` テーブル:建物 [sn_wsd_core_building]
result.reservableUnits.building.display_value	建物の表示値。データタイプ：文字列
result.reservableUnits.building.sys_id	関連付けられた建物レコードのSys_id。データタイプ：文字列
result.reservableUnits.campus	予約可能項目がある敷地の詳細。データタイプ: オブジェクト `"campus": { "display_value": "String", "sys_id": "String" }` テーブル:敷地 [sn_wsd_core_campus]
result.reservableUnits.campus.display_value	予約可能項目が存在する敷地の表示番号 (イーストベイなど)。データタイプ：文字列
result.reservableUnits.campus.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:敷地 [sn_wsd_core_campus]
result.reservableUnits.capacity	予約可能な施設の最大入室者数。データタイプ：数値
result.reservableUnits.description	予約の簡単な説明。データタイプ：文字列
result.reservableUnits.email	予約可能ファイルのメールアドレス。データタイプ：文字列
result.reservableUnits.external_id	CMS でマッピングされたスペースの同期に使用される予約可能項目の外部 ID。この値は、この場所に関連付けられたマップがある場合にのみ設定されます。データタイプ：文字列
result.reservableUnits.floor	予約可能ファイルが配置されているフロアの詳細。データタイプ: オブジェクト `"floor": { "display_value": "String", "sys_id": "String" }` テーブル:フロア [sn_wsd_core_floor]
result.reservableUnits.floor.display_value	予約可能ファイルが存在するフロアの表示番号 (12 など)。データタイプ：文字列
result.reservableUnits.floor.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:フロア [sn_wsd_core_floor]
result.reservableUnits.image	関連する予約可能項目のレイアウトを表す画像の詳細。データタイプ: オブジェクト `"image": { "link": "String", "sys_id": "String" }` テーブル:イメージ [db_image]
result.reservableUnits.image.link	この予約可能なレイアウトを表す画像へのリンク。データタイプ：文字列テーブル:イメージ [db_image]
result.reservableUnits.image.sys_id	関連付けられたイメージレコードのSys_id。データタイプ：文字列
result.reservableUnits.includedInResult	現在の予約が返される結果に含まれるかどうかを示すフラグ。有効な値： true:返される結果に含まれます。 false:返される結果に含まれません。データタイプ：ブーリアン
result.reservableUnits.is_available	予約可能が予約可能かどうかを示すフラグ。有効な値： true:予約可能。 false:予約できません。データタイプ：ブーリアン
result.reservableUnits.is_favorite	予約可能が関連付けられたユーザーのお気に入りの 1 つとしてフラグが付けられているかどうかを示すフラグ。有効な値： true:お気に入り。 false:お気に入りではありません。データタイプ：ブーリアン
result.reservableUnits.is_reservable	この予約可能を予約できるかどうかを示すフラグ。注: include_unavailable_itemsクエリパラメーターが true に設定されている場合は、利用できない場所も返されます。この場合、場所が既に予約されている場合、 is_available パラメーターは false ですが、 is_reservable は true です。有効な値： true:予約可能。 false:予約できません。データタイプ：ブーリアン
result.reservableUnits.is_reserved	予約可能が既に予約されているかどうかを示すフラグ。有効な値： true:予約可能。 false:予約済みです。データタイプ：ブーリアン
result.reservableUnits.is_selected	予約可能が既に予約されているかどうかを示すフラグ。有効な値： true:予約可能。 false:予約済みです。データタイプ：ブーリアン
result.reservableUnits.location_type	職場/デスク、カフェ、ジムなど、予約可能な場所のタイプに関する詳細。データタイプ: オブジェクト `"location_type": { "display_value": "String", "name": "String", "sys_id": "String" }` テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.location_type。display_value	場所タイプの表示値。データタイプ：文字列
result.reservableUnits.location_type.name	地下室やストレージなどの場所タイプの名前。表示値と同じです。データタイプ：文字列
result.reservableUnits.location_type.sys_id	関連レコードのSys_id。データタイプ：文字列テーブル:スペースタイプ [sn_wsd_core_space_type]
result.reservableUnits.name	予約可能の名前。データタイプ：文字列
result.reservableUnits.number	予約可能ファイルの一意の識別子。この値は、sys_idよりも人間が判読しやすくなります。データタイプ：文字列
result.reservableUnits.order	予約の順序番号。データタイプ：数値
result.reservableUnits.require_approval	予約可能を予約するには承認が必要かどうかを示すフラグ。可能な値： true:承認が必要です。 false:承認は必要ありません。データタイプ：ブーリアン
result.reservableUnits.requires_check_in	予約可能でユーザーにチェックインが必要かどうかを示すフラグ。有効な値： true:チェックインが必要です。 false:チェックインは必要ありません。データタイプ：ブーリアン
result.reservableUnits.reservable_purposes	関連する予約可能項目を予約する目的の詳細。データタイプ：オブジェクトのアレイ `"reservable_purposes": [ { "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.reservableUnits.reservable_purposes。名前	予約可能の名前。データタイプ：文字列
result.reservableUnits.reservable_purposes。short_description	予約の簡単な説明。データタイプ：文字列
result.reservableUnits.reservable_purposes。sys_id	予約可能な目的レコードのSys_id。データタイプ：文字列テーブル:予約可能な目的 [sn_wsd_rsv_reservable_purpose]
result.reservableUnits.reservations	予約に関連付けられた予約に関する詳細。include_reservations_within_daysクエリパラメーターが true で、reservation_ids パラメーターに予約 ID が含まれている場合のみ設定されます。つまり、この予約可能項目には予約が既に存在します。データタイプ：オブジェクトのアレイ `"reservations": [ { "configuration_item": "String", "end": "String", "is_collided": Boolean, "location": {Object}, "number": "String", "requested_for": {Object}, "reservation_purpose": {Object}, "start": "String", "state": {Object}, "subject": "String", "sys_id": "String" } ]`
result.reservableUnits.reservations.configuration_item	予約に対応する構成アイテム。データタイプ：文字列テーブル:構成アイテム [cmdb_ci]
result.reservableUnits.reservations.end	予約の終了日時。データタイプ：文字列形式:UTC:yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservableUnits.reservations.is_collided	予約が検索の開始時間と終了時間と競合するかどうかを示すフラグ。これは、関連付けられた予約可能な場所が、指定された検索タイムスパンにわたって既に予約されていることを示します。可能な値： true:衝突。 false:衝突はありません。データタイプ：ブーリアン
result.reservableUnits.reservations.location	予約の場所に関する詳細。データタイプ: オブジェクト `"location": { "location": "String", "timezone": {Object} }`
result.reservableUnits.reservations.location.location	関連付けられた場所レコードのSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.reservations.location.timezone	場所に関連付けられたタイムゾーンの詳細。データタイプ: オブジェクト `"timezone": { "displayValue": "String", "value": "String" }`
result.reservableUnits.reservations.location.timezone.displayValue	この場所が属するタイムゾーンの表示値。データタイプ：文字列
result.reservableUnits.reservations.location.timezone.value	この場所が属するタイムゾーンの内部値。データタイプ：文字列
result.reservableUnits.reservations.number	予約可能ファイルの一意の識別子。この値は、sys_idよりも人間が判読しやすくなります。データタイプ：文字列
result.reservableUnits.reservations.requested_for	代理で予約を要求されたユーザーの詳細。データタイプ: オブジェクト `"requested_for": { "name": "String", "sys_id": "String" }`
result.reservableUnits.reservations.requested_for.name	予約が要求されたユーザーの名前。データタイプ：文字列
result.reservableUnits.reservations.requested_for.sys_id	予約を要求されているユーザーのSys_id。データタイプ：文字列テーブル：ユーザー [sys_user]
result.reservableUnits.reservations.reservation_purpose	予約の目的に関する詳細。データタイプ: オブジェクト `"reservation_purpose": { "display_value": "String", "value": "String" }`
result.reservableUnits.reservations.reservation_purpose.display_value	会社の会議など、予約の目的に応じた表示値。データタイプ：文字列
result.reservableUnits.reservations.reservation_purpose.value	company_meeting などの予約目的の内部値。データタイプ：文字列
result.reservableUnits.reservations.start	予約の開始日時。データタイプ：文字列形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z)
result.reservableUnits.reservations.state	場所の予約状況に関する詳細。データタイプ: オブジェクト `"state": { "display_value": "String", "value": "String" }`
result.reservableUnits.reservations.state.display_value	予約の現在のステータスの表示値 (確認済みなど)。データタイプ：文字列
result.reservableUnits.reservations.state.value	予約の現在のステータスの内部値 (2 など)。データタイプ：文字列
result.reservableUnits.reservations.subject	予約の件名。データタイプ：文字列
result.reservableUnits.reservations.sys_id	必須です。予約レコードのSys_id。データタイプ：文字列テーブル:職場予約 [sn_wsd_rsv_reservation]
result.reservableUnits.reservable_quantity	関連する予約可能項目を同時に予約できる最大回数。この値は、エリアに近隣スペースをアサインするときに使用されます。データタイプ：整数
result.reservableUnits.site	予約可能ファイルが存在するサイトに関する詳細。データタイプ: オブジェクト `"site": { "display_value": "String", "sys_id": "String" }` テーブル:サイト [sn_wsd_core_site]
result.reservableUnits.site.display_value	サイトの表示値。データタイプ：文字列
result.reservableUnits.site.sys_id	関連付けられたサイトレコードのSys_id。データタイプ：文字列テーブル:サイト [sn_wsd_core_site]
result.reservableUnits.standard_services	関連する標準サービス (フリップチャート、プロジェクタースクリーン、ホワイトボードとマーカーなど)。データタイプ：オブジェクトのアレイ `"standard_services": [ { "font_awesome_icon": "String", "name": "String", "short_description": "String", "sys_id": "String" } ]`
result.reservableUnits.standard_services。font_awesome_icon	標準サービスに関連付けられたサムネイルアイコンの名前。データタイプ：文字列
result.reservableUnits.standard_services.name	標準サービスに関連付けられたサムネイルアイコンの名前。データタイプ：文字列
result.reservableUnits.standard_services。short_description	標準サービスの簡単な説明。データタイプ：文字列
result.reservableUnits.standard_services.sys_id	標準サービスレコードのSys_id。データタイプ：文字列テーブル:標準サービス [sn_wsd_rsv_standard_service]
result.reservableUnits.sys_id	予約可能なレコードのSys_id。データタイプ：文字列テーブル:職場の場所 [sn_wsd_core_workplace_location]
result.reservableUnits.tableName	予約可能なレコードが存在するテーブルの名前。データタイプ：文字列
result.reservableUnits.title	予約可能なタイトル。データタイプ：文字列
result.totalProcessed	処理されたレコードの合計数。データタイプ：数値

cURL 要求

この例では、このエンドポイントを使用して予約を検索する方法を示します。注意:読みやすくするために、クエリパラメーターに改行が追加されました。

curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/reservable?
reservable_module=d9864189c3653910977396cb05013100&
start=2023-10-12T10:30:00Z&
end=2023-10-13T11:30:00Z&
include_standard_services=true&
include_reservable_purposes=true&
include_reservations_within_days=true&
include_unavailable_items=true&
near_by_location_id=undefined&
timezone=Europe/Paris&
page_size=6&
sort_by=a_z&
view=schedule&
rsv_path=browse_all&
ignore_same_day_validation=true&
schedule_view_obj={"schedule_view_date":"2023-10-12","timezone":"Europe/Paris"}&
q=building=dea39b1977220110b3d7be377b5a9955\
--request GET \
--header "Accept:application/json" 
--user "username":"password"

結果を返します:

{
  "result": {
    "hasMore": true,
    "reservableUnits": [
      {
        "sys_id": "fe1f744edb7650106c731dcd139619ca",
        "external_id": null,
        "email": null,
        "name": "Aspen",
        "title": "Aspen",
        "description": "A room with large windows, dark leather seats and a large wooden table.",
        "image": {
          "sys_id": "41c74902dbb650106c731dcd13961944",
          "link": "41c74902dbb650106c731dcd13961944.iix"
        },
        "number": "ROOM0000903",
        "site": {
          "sys_id": "628eec06db7650106c731dcd139619dd",
          "display_value": "North America"
        },
        "campus": {
          "sys_id": "82b2a0cedb3650106c731dcd139619e9",
          "display_value": "California Campus"
        },
        "building": {
          "sys_id": "94e264cedb3650106c731dcd13961919",
          "display_value": "CAL-B1"
        },
        "floor": {
          "sys_id": "2f554296dbba10106c731dcd139619ed",
          "display_value": "Floor 2"
        },
        "area": null,
        "capacity": "16",
        "reservable_quantity": null,
        "location_type": {
          "sys_id": "20713b83eb512010b89bfdfc9c522899",
          "display_value": "Room",
          "name": "Room"
        },
        "order": null,
        "requires_check_in": null,
        "is_reservable": "1",
        "tableName": "sn_wsd_core_room",
        "require_approval": false,
        "standard_services": [
          {
            "sys_id": "9b01458edb7650106c731dcd13961945",
            "name": "Flip chart",
            "short_description": "Flip chart with paper sheets",
            "font_awesome_icon": "fa-calendar-o"
          }
        ],
        "reservable_purposes": [
          {
            "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
            "name": "Board room",
            "short_description": null
          }
        ],
        "is_available": true,
        "reservations": [
          {
            "sys_id": "5fe65830874bc9106342b846dabb352b",
            "number": "WRES0001001",
            "location": {
              "location": "fe1f744edb7650106c731dcd139619ca",
              "timezone": {
                "value": "US/Pacific",
                "displayValue": "US/Pacific"
              }
            },
            "configuration_item": null,
            "start": "2022-04-23T08:30:00Z",
            "end": "2022-04-23T09:30:00Z",
            "subject": null,
            "reservation_purpose": {
              "value": "meeting",
              "display_value": "Meeting"
            },
            "state": {
              "value": "confirmed",
              "display_value": "Confirmed"
            },
            "is_collided": false,
            "requested_for": {
              "sys_id": "2de07e1887cb89106342b846dabb35fe",
              "name": "Workplace User"
            }
          }
        ],
        "availableTimes": [
          [
            "2022-04-23 07:00:00",
            "2022-04-23 08:30:00"
          ],
          [
            "2022-04-23 09:30:00",
            "2022-04-23 23:00:00"
          ]
        ],
       "is_reserved": true,
       "is_selected": true,
        "includedInResult": true,
        "is_favorite": false
      }
    ],
    "reservableContainers": [],
    "nextItemIndex": -1,
    "filter": {
      "floors": [],
      "standard_services": [
        {
          "sys_id": "9b01458edb7650106c731dcd13961945",
          "name": "Flip chart",
          "short_description": "Flip chart with paper sheets",
          "font_awesome_icon": "fa-calendar-o"
        }
      ],
      "reservable_purposes": [
        {
          "sys_id": "18f4c3cd1ba4e01051848489cc4bcb82",
          "name": "Board room",
          "short_description": null
        }
      ]
    },
    "totalProcessed": 2,
    "nextFavIndex": 0
  }
}

WSD 検索:GET /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

シフト [sn_wsd_core_shift] テーブルで利用可能なシフトを検索するために使用できるエンコードされたクエリを返します。

指定された予約可能モジュールのappy_to_shiftフィールドが有効になっている場合にのみ適用されます。それ以外の場合、返されるエンコードされたクエリ文字列は空になります。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/shift/{building_id}/{module_id}

デフォルト URL: /api/sn_wsd_rsv/search/shift/{building_id}/{module_id}

注:

サポートされている要求パラメーター

表 : 25. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
building_id	検索クエリに含める建物のSys_id。データタイプ：文字列テーブル:建物 [sn_wsd_core_building]
module_id	検索クエリに含める予約可能モジュールのSys_id。予約可能なモジュールは、椅子や机など、類似するタイプの職場アイテムをグループ化します。データタイプ：文字列テーブル:予約可能なモジュール [sn_wsd_core_reservable_module]

表 : 26. クエリパラメーター
名前	説明
なし

表 : 27. 要求本文のパラメーター
名前	説明
end_date	エンコードされたクエリに含めるシフト終了日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
start_date	エンコードされたクエリに含めるシフト開始日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss

ヘッダー

表 : 28. 要求ヘッダー
ヘッダー	説明
承認	要求本文のデータ形式。サポートされているタイプ: application/json、 application/xml 、または text/xml。デフォルト： application/json

表 : 29. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 30. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	指定された利用可能なシフトを取得するために使用するエンコードされたクエリ。データタイプ: オブジェクト `"result": { "moduleHasShift": Boolean, "query": "String" }`
moduleHasShift	指定された予約可能モジュールでシフトが有効になっているかどうかを示すフラグ。有効な値： true:予約可能なモジュールでシフトが有効になっています。 false:予約可能なモジュールでシフトが有効になっていません。エンコードされたクエリは返されませんでした。データタイプ：ブーリアン
クエリ	指定された予約可能モジュールのシフト情報を取得するために使用するエンコードされたクエリ。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを使用してシフトエンコードされたクエリを取得する方法を示しています。

curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/shift/94e264cedb3650106c731dcd13961919/fc71f64fdb42a01097acc900399619a8?start_date=2022-04-23 16:00:00&end_date=2022-04-28 16:00:00"  \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

結果を返します:

{
  "result": { 
    "moduleHasShift" : true,
    "query" : "active=true^state=2^building=94e264cedb3650106c731dcd13961919^building.is_reservable=true^building.active=true^floorISEMPTY^ORfloor.is_reservable=true^floorISEMPTY^ORfloor.active=true^start<=2022-04-26 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY^start<=2022-04-28 16:00:00^ORstartISEMPTY^end>=2022-04-28 16:00:00^ORendISEMPTY"
  }
}

WSD 検索:POST /api/sn_wsd_rsv/search/availability_score

指定されたタイムスロットの予約可能アイテムの可用性スコアを返します。

URL 形式

バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/search/availability_score

デフォルト URL: /api/sn_wsd_rsv/search/availability_score

注:

サポートされている要求パラメーター

表 : 31. パスパラメーター
名前	説明
api_version	オプション。アクセスするエンドポイントのバージョン。たとえば、 `v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 32. クエリパラメーター
名前	説明
なし

表 : 33. 要求本文のパラメーター
名前	説明
recurringPattern	startEndDateTimesパラメーターが指定されていない場合は必須です。指定された繰り返しイベントで利用可能な予約を検索するために使用する繰り返しパターン。データタイプ: オブジェクト `"recurringPattern": { "duration": Number, "label": "String", "options": {Object}, "repeats": "String", "startDate": "String" }`
recurringPattern.duration	必須です。予約可能サービスを利用可能にする必要がある時間の長さ。データタイプ：数値単位：ミリ秒
recurringPattern.label	繰り返しパターンの説明 ( `「毎日 5 回繰り返す`」など)。データタイプ：文字列
recurringPattern.options	検索する繰り返し予約の可用性オプション。データタイプ: オブジェクト `"options": { "count": Number, "daysOfWeek": "String", "endDate": "String" }`
recurringPattern.options.count	endDateが渡されない場合は必須です。両方が渡された場合は、 count が使用されます。会議パターンを繰り返す回数。データタイプ：数値
recurringPattern.options.daysOfWeek	recurringPattern.repeatsパラメーターが`「週次`」に設定されている場合は必須です。予約が必要な曜日。有効な値： 1 = 月曜日 2 = 火曜日 3 = 水曜日 4 = 木曜日 5 = 金曜日 6 = 土曜日 7 = 日曜日たとえば、火曜日、木曜日、金曜日を指定するには、245 (区切り文字なし) を渡します。repeat が週次、count が 5、daysOfWeek が 245 の場合、返される結果では、合計は `countdaysOfWeek.length` (53=15) に等しくなります。データタイプ：文字列
recurringPattern.options.endDate	recurringPattern.options.countが渡されない場合は必須です。両方が渡された場合は、 count が使用されます。会議が繰り返される終了日時 (「2022-07-08T14:00:00Z」など)。データタイプ：文字列形式:UTC yyyy-mm-dd hh:mm:ss
recurringPattern.repeats	必須です。予約可能な繰り返しパターン。有効な値 (大文字と小文字を区別): 日次月次週次年次データタイプ：文字列
recurringPattern.startDate	必須です。繰り返しパターンの開始日時 (「2022-07-08T14:00:00Z」など)。データタイプ：文字列形式:UTC yyyy-mm-dd hh:mm:ss
reservableId	必須です。可用性スコアに含める予約sys_idsのリスト。データタイプ：アレイテーブル:職場の場所 [sn_wsd_core_workplace_location]
予約可能タイプ	必須です。可用性スコアに含める予約のタイプ。検索を絞り込むために使用されます。有効な値 (大文字と小文字を区別): configuration_item location データタイプ：文字列
startEndDateTime	検索対象のユーザーのタイムゾーンの開始日時と終了日時のリスト。データタイプ：オブジェクトのアレイ `"startEndDateTimes": [ { "end": "String", "start": "String" } ]` デフォルト: recurringPattern パラメーターを指定する必要があります。
startEndDateTimes.end	予約の終了日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
startEndDateTimes.start	予約の開始日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss

ヘッダー

表 : 34. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 35. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 36. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	指定された可用性スコアの結果を返します。データタイプ: オブジェクト `"result": { "reservable_sys_id": {Object} }`
result.reservable_sys_id	可用性スコアの詳細。データタイプ: オブジェクト `"reservable_sys_id": { "available": Number, "score": "String", "total": Number }`
result.reservable_sys_id.available	指定された検索条件を満たした利用可能な予約の数。データタイプ：数値
result.reservable_sys_id.score	可用性スコア。指定された検索条件を満たした予約の合計数に対する利用可能な予約の数。たとえば、 available が 2 で total が 4 の場合、 score 値は 2/4 です。データタイプ：文字列
result.reservable_sys_id.total	指定された検索条件を満たした予約の合計数。データタイプ：数値

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl "https://instance.servicenow.com/api/sn_wsd_rsv/search/availability_score" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"reservableType\": \"location\",
  \"reservableIds\": [
    \"fe1f744edb7650106c731dcd139619ca\",
    \"5eafb44edb7650106c731dcd13961943\"
  ],
  \"recurringPattern\": {
    \"duration\": 3600000,
    \"repeats\": \"daily\",
    \"options\": {
      \"count\": 150,
      \"daysOfWeek\": \"\",
    },
    \"label\": \"Repeats daily, 5 times\",
    \"startDate\": \"2022-04-26T14:00:00Z\"
  },
  \"startEndDateTimes\": [
    {
      \"start\": \"2022-07-05 14:00:00\",
      \"end\": \"2022-07-05 15:00:00\"
    },
    {
      \"start\": \"2022-07-06 14:00:00\",
      \"end\": \"2022-07-06 15:00:00\"
    }
  ]
}" \
--user "username":"password"

結果を返します:

{
  "result": {
    "fe1f744edb7650106c731dcd139619ca": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    },
    "5eafb44edb7650106c731dcd13961943": {
      "available": 2,
      "total": 2,
      "score": "2/2"
    }
  }