WSD Search API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む116読むのに数分

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

    この API にアクセスするには、問い合わせユーザーに sn_wsd_core.workplace_user ロールが必要であり、Workplace Safety Management (sn_wsd_core) と Workplace Reservation Management (sn_wsd_rsv) プラグインを有効にする必要があります。

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

    Workplace Reservation Managementの詳細については、「Workplace Reservation Management」を参照してください。

    WSD Search - GET /api/sn_wsd_rsv/search/availability

    指定された可能な予約が、指定された時間に利用可能かどうかをチェックします。

    URL 形式

    バージョニングされている URL：/api/sn_wsd_rsv/{api_version}/search/availability

    デフォルトの URL：/api/sn_wsd_rsv/search/availability

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

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

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    end 必須です。利用可能な予約可能モジュールを検索するために使用する終了時間。この値は、start パラメーターで指定された値よりも後でなければなりません。

    データタイプ：文字列

    形式：UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
    include_reservations_within_days 1 日の各予約可能項目について、応答で利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。
    有効な値：
    • true：すべての空きスロットを返します。
    • false:すべての空きスロットを返しません。

    データタイプ：ブーリアン

    デフォルト値：false
    reservable_ids 必須。使用可否を評価する予約可能 sys_id のカンマ区切りリスト。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ：文字列
    reservation_ids 既存の予約sys_idsのカンマ区切りリスト。関連する予約を編集する場合は、このパラメーターを渡します。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    対応する予約可能項目のこれらの sys_id に対してブロックされた時間は、利用可能として扱われます。

    データタイプ：文字列

    デフォルト：なし
    reservable_module 必須です。検索に含める予約可能なモジュールの sys_id。予約可能モジュールは、類似タイプの職場アイテムをグループ化します。予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルにあります。

    データタイプ：文字列
    schedule_view_obj 返すスケジュールビューの詳細。1 日を超える予約に 24 時間可用性データが必要な場合は、このオブジェクトを渡します。返される結果には、指定された日付の利用可能な時間と予約のみが含まれます。

    この機能が正しく機能するためには、パラメーター ignore_same_day_validationinclude_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 返す予約可用性データを決定するために使用する建物のタイムゾーン。例:米国/太平洋。

    データタイプ：文字列
    shift 指定された予約可能なモジュールがシフトに基づいている場合は必須です。
    予約に関連付けるシフトの sys_id。シフト [sn_wsd_core_shift] テーブルにあります。このパラメーターが渡される場合、 end このパラメーターは必要ありません。

    シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。

    データタイプ：文字列
    start 必須です。利用可能な予約可能モジュールを検索するために使用する開始時間。この値は、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 フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    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 Search - 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
    end 必須です。利用可能な予約可能モジュールを検索するために使用する終了時間。この値は、start パラメーターで指定された値よりも後でなければなりません。

    データタイプ：文字列

    形式：UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
    include_reservable_purposes 返される結果で各予約可能項目の職場の場所を予約する目的を返すかどうかを示すフラグ。この情報は予約可能な目的 [sn_wsd_rsv_reservable_purpose] テーブルにあります。
    有効な値：
    • true：予約可能な目的を返します。
    • false:予約可能な目的を返しません。

    データタイプ：ブーリアン

    デフォルト値：false
    include_reservations_within_days 1 日の各予約可能項目について、応答で利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。
    有効な値：
    • true：すべての空きスロットを返します。
    • false:すべての空きスロットを返しません。

    データタイプ：ブーリアン

    デフォルト値：false
    include_standard_​services 応答で標準サービス情報を返すかどうかを示すフラグ。

    標準サービスでは、ホワイトボード、追加のモニター、および類似サービスなど、予約時に予約可能な職場アイテムで利用可能な基本的なプロビジョニングについて説明します。標準サービスの詳細については、「 標準サービス」を参照してください。この情報は、標準サービス [sn_wsd_rsv_standard_service] テーブルにあります。

    有効な値：
    • true：標準サービス情報を返します。
    • false:標準サービス情報を返しません。

    データタイプ：ブーリアン

    デフォルト値：false
    q 必須です。返された検索結果をフィルタリングするために使用するエンコードされたクエリ。このクエリ内では、建物の sys_id を指定する必要があり、floor、area、capacity、standard services、reservable_purposes などのパラメーターを指定できます。

    数値である capacity を除いて、渡すパラメーターはすべて sys_id である必要があります。

    例：q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    この情報は、次のテーブルにあります。
    • 建物：sn_wsd_core_building
    • フロア：sn_wsd_core_floor
    • エリア：sn_wsd_core_area
    • 標準サービス：sn_wsd_rsv_standard_service
    • 予約可能な目的：sn_wsd_rsv_reservable_purpose

    データタイプ：文字列
    reservable_module 必須です。検索に含める予約可能なモジュールの sys_id。予約可能モジュールは、類似タイプの職場アイテムをグループ化します。予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルにあります。

    データタイプ：文字列
    start 必須です。利用可能な予約可能モジュールを検索するために使用する開始時間。この値は、end パラメーターで指定された値よりも前でなければなりません。

    データタイプ：文字列

    形式：UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
    time_slot 最も一致する可能な予約の検索を試みているタイムスロットレコードの sys_id。タイムスロット [sn_wsd_rsv_time_slot] テーブルにあります。

    データタイプ：文字列

    デフォルト：なし
    タイムゾーン 優先タイムゾーン (ヨーロッパ/アムステルダムなど)。

    データタイプ：文字列

    デフォルト：なし
    表 : 9. 要求本文パラメーター
    ヘッダー 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 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 フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    result.hasMore 返される結果にさらに予約可能項目が含まれているかどうかを示すフラグ。
    可能な値：
    • true：より多くの予約可能項目が利用可能です。
    • false：これ以上の予約可能項目は利用できません。

    データタイプ：ブール
    result.nextItemIndex フェッチする次の予約可能レコードのインデックス。予約可能レコードをページネーションするときに、この値を使用します。

    データタイプ：数値
    result.reservableContainers selection_type フィールドが container に設定されている予約可能モジュールに対してのみ返されます。コンテナーは、デスクのグループなど、類似のアイテムをグループ化したものです。

    データタイプ：オブジェクトのアレイ

    "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
    予約可能項目がある敷地の詳細。

    敷地 [sn_wsd_core_campus] テーブルにあります。

    データタイプ：オブジェクト

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    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 フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    result.reservableContainers.image 関連する予約可能項目のレイアウトを表す画像の詳細。

    画像 [db_image] テーブルにあります。

    "image": {
  "link": "String",
  "sys_id": "String"
}
    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 予約可能モジュールがあるエリアの詳細。エリア [sn_wsd_core_area] テーブルにあります。

    データタイプ：オブジェクト

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value 予約可能モジュールエリアの表示値。

    データタイプ：文字列
    result.reservableUnits.area.sys_id 予約可能項目に関連するエリアレコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.availableTimes 関連する予約可能項目が使用可能な日時のリスト。

    データタイプ：アレイ
    result.reservableUnits.building 予約可能項目がある建物の詳細。建物 [sn_wsd_core_building] テーブルにあります。

    データタイプ：オブジェクト

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value 建物の表示値。

    データタイプ：文字列
    result.reservableUnits.building.sys_id 関連付けられた建物レコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.campus
    予約可能項目がある敷地の詳細。

    敷地 [sn_wsd_core_campus] テーブルにあります。

    データタイプ：オブジェクト

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    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
    可能な予約があるフロアの詳細。

    フロア [sn_wsd_core_floor] テーブルにあります。

    データタイプ：オブジェクト

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.floor.display_value 予約可能項目が存在するフロアの階数を表示します (12 など)。

    データタイプ：文字列
    result.reservableUnits.floor.sys_id フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.image 関連する予約可能項目のレイアウトを表す画像の詳細。

    画像 [db_image] テーブルにあります。

    "image": {
  "link": "String",
  "sys_id": "String"
}
    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 予約可能項目の場所のタイプに関する詳細 (workplace/desk、cafe、gym など)。

    職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableUnits.location_type.​display_value 場所タイプの表示値。

    データタイプ：文字列
    result.reservableUnits.location_type.name 地下やストレージなどの場所タイプの名前。表示値と同じです。

    データタイプ：文字列
    result.reservableUnits.location_type.sys_id スペースタイプ [sn_wsd_core_space_type] テーブルの関連レコードの sys_id。

    データタイプ：文字列
    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.​name 予約可能項目の名前。

    データタイプ：文字列
    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 予約可能項目が存在するサイトの詳細。

    サイト [sn_wsd_core_site] テーブルにあります。

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.site.display_value サイトの表示値。

    データタイプ：文字列
    result.reservableUnits.site.sys_id サイト [sn_wsd_core_site] テーブルの関連サイトレコードの sys_id。

    データタイプ：文字列
    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. クエリパラメーター
    名前 説明
    終了 必須です。重複予約の確認に使用する終了時間。

    データタイプ：文字列

    形式:YYY-MM-DDTHH:MM:SSZ
    recurring_pattern 予約の繰り返し発生するパターンの詳細。

    データタイプ: オブジェクト

    "recurring_pattern": {
  "duration": Number,
  "options": {Object},
  "repeats": "String",
  "startDate":"String"
}
    recurring_pattern.duration チェックする時間の長さ。

    データタイプ：数値

    単位：秒
    recurring_pattern.オプション 繰り返し予約に関連付けられたオプションの詳細。

    データタイプ: オブジェクト

    "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 予約の重複チェックの繰り返しパターン。
    可能な値：(大文字と小文字を区別)
    • 日次
    • monthly
    • weekly
    • yearly

    データタイプ：文字列
    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。シフト [sn_wsd_core_shift] テーブルにあります。このパラメーターが渡される場合、 end このパラメーターは必要ありません。

    データタイプ：文字列
    shift_info_object.timezone 重複を確認するシフトのタイムゾーン。

    データタイプ：文字列
    start 必須です。重複予約の確認に使用する開始時間。

    データタイプ：文字列

    形式:YYY-MM-DDTHH:MM:SSZ
    user_id 必須です。予約の重複を確認するユーザーのSys_id。ユーザー [sys_user] テーブルにあります。

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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

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

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

    名前 説明
    結果 重複チェックの結果の詳細。

    データタイプ: オブジェクト

    "results": {
  "isOverlapped": Boolean,
  "reservableId": "String"
}
    results.isOverlapped 重複予約が存在するかどうかを示すフラグ。

    有効な値：

    • true:重複予約が存在します。
    • false:重複予約は存在しません。

    データタイプ：ブーリアン
    results.reservableId グループ予約の場合、重複が発生する予約可能項目のsys_id。

    データタイプ：文字列

    cURL 要求

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

    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 Search - 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. クエリパラメーター
    名前 説明
    end 必須です。利用可能な予約可能モジュールを検索するために使用する終了時間。この値は、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 返される結果で各予約可能項目の職場の場所を予約する目的を返すかどうかを示すフラグ。この情報は予約可能な目的 [sn_wsd_rsv_reservable_purpose] テーブルにあります。
    有効な値：
    • true：予約可能な目的を返します。
    • false:予約可能な目的を返しません。

    データタイプ：ブーリアン

    デフォルト値：false
    include_reservations_within_days 1 日の各予約可能項目について、応答で利用可能な時間のすべての空きスロットを返すかどうかを示すフラグ。
    有効な値：
    • 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。近隣 [sn_wsd_spcmgmt_neighborhood] テーブルにあります。

    近隣スペースの予約の詳細については、「」を参照してください Create neighborhood reservations。

    データタイプ：文字列
    next_item_index 取得する次のアイテムのインデックス。返される結果をページネーションするときに、このパラメーターを渡します。

    データタイプ：数値

    デフォルト：0
    page_size 返される結果で返されるレコードの最大数。

    データタイプ：数値

    デフォルト：6
    q 必須です。返された検索結果をフィルタリングするために使用するエンコードされたクエリ。このクエリ内では、建物の sys_id を指定する必要があり、floor、area、capacity、standard services、reservable_purposes などのパラメーターを指定できます。

    数値である capacity を除いて、渡すパラメーターはすべて sys_id である必要があります。

    例：q=building=94e264cedb3650106c731dcd13961919​^floorINfc7368cedb3650106c731dcd13961902​^capacity>=1​^standard_services=55c0818edb7650106c731dcd13961904​^reservable_purposes=d6e5c7cd1ba4e01051848489cc4bcb81

    この情報は、次のテーブルにあります。
    • 建物：sn_wsd_core_building
    • フロア：sn_wsd_core_floor
    • エリア：sn_wsd_core_area
    • 標準サービス：sn_wsd_rsv_standard_service
    • 予約可能な目的：sn_wsd_rsv_reservable_purpose

    データタイプ：文字列
    reservable_module 必須です。検索に含める予約可能なモジュールの sys_id。予約可能モジュールは、類似タイプの職場アイテムをグループ化します。予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルにあります。

    データタイプ：文字列
    reservation_ids 既存の予約sys_idsのカンマ区切りリスト。関連する予約を編集する場合は、このパラメーターを渡します。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    対応する予約可能項目のこれらの sys_id に対してブロックされた時間は、利用可能として扱われます。

    データタイプ：文字列

    デフォルト：なし
    rsv_path 検索に適用する予約パス。
    有効な値：
    • browse_all：可能なすべての予約を検索します。
    • browse_by_area：特定の場所の近くにある可能な予約を検索します。エリア識別子は、エンコードされたクエリ (q パラメーター) で渡す必要があります。
    • browse_by_neighborhood:パラメーターで指定された neighborhood 近隣の可能な予約を検索します。
    • browse_near_a_person：near_by_location_id パラメーターで指定されたユーザーの職場の場所の近くにある可能な予約を検索します。

    データタイプ：文字列

    デフォルト：browser_all
    schedule_view_obj 返すスケジュールビューの詳細。1 日を超える予約に 24 時間可用性データが必要な場合は、このオブジェクトを渡します。返される結果には、指定された日付の利用可能な時間と予約のみが含まれます。

    この機能が正しく機能するためには、パラメーター ignore_same_day_validationinclude_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 返す予約可用性データを決定するために使用する建物のタイムゾーン。例:米国/太平洋。

    データタイプ：文字列
    start 必須です。利用可能な予約可能モジュールを検索するために使用する開始時間。この値は、end パラメーターで指定された値よりも前でなければなりません。

    データタイプ：文字列

    形式：UTC または現地時間 (yyyy-mm-dd hh:mm:ss)
    shift
    予約に関連付けるシフトの sys_id。シフト [sn_wsd_core_shift] テーブルにあります。このパラメーターが渡される場合、 end このパラメーターは必要ありません。

    シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。

    データタイプ：文字列
    sort_by 返された予約可能なアイテムの望ましいソート順。
    有効な値：
    • a_z：昇順のソート順。
    • favorites_first：ユーザーのお気に入りの予約可能な職場の順にソートされ、残りは昇順になります。
    • z_a:降順のソート順。

    データタイプ：文字列

    デフォルト：a_z
    タイムゾーン 優先タイムゾーン (ヨーロッパ/アムステルダムなど)。

    データタイプ：文字列

    デフォルト：なし
    表 : 21. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

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

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 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
    可能な予約があるフロアの詳細。

    フロア [sn_wsd_core_floor] テーブルにあります。

    データタイプ：オブジェクト

    "floors": [
  {
    "display_value": "String",
    "sys_id": "String"
  }
]
    result.filter.floors.display_value 予約可能項目が存在するフロアの階数を表示します (12 など)。

    データタイプ：文字列
    result.filter.floors.sys_id フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    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 フィールドが container に設定されている予約可能モジュールに対してのみ返されます。コンテナーは、デスクのグループなど、類似のアイテムをグループ化したものです。

    データタイプ：オブジェクトのアレイ

    "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
    予約可能項目がある敷地の詳細。

    敷地 [sn_wsd_core_campus] テーブルにあります。

    データタイプ：オブジェクト

    "campus": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    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 フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    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 予約可能モジュールがあるエリアの詳細。エリア [sn_wsd_core_area] テーブルにあります。

    データタイプ：オブジェクト

    "area": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.area.display_value 予約可能モジュールエリアの表示値。

    データタイプ：文字列
    result.reservableUnits.area.sys_id 予約可能項目に関連するエリアレコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.availableTimes 関連する予約可能項目が使用可能な日時のリスト。

    データタイプ：アレイ
    result.reservableUnits.building 予約可能項目がある建物の詳細。建物 [sn_wsd_core_building] テーブルにあります。

    データタイプ：オブジェクト

    "building": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.building.display_value 建物の表示値。

    データタイプ：文字列
    result.reservableUnits.building.sys_id 関連付けられた建物レコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.campus
    予約可能項目がある敷地の詳細。

    敷地 [sn_wsd_core_campus] テーブルにあります。

    データタイプ：オブジェクト

    "campus": {
  "display_value": "String",
  "sys_id": "String"
}
    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
    可能な予約があるフロアの詳細。

    フロア [sn_wsd_core_floor] テーブルにあります。

    データタイプ：オブジェクト

    "floor": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.floor.display_value 予約可能項目が存在するフロアの階数を表示します (12 など)。

    データタイプ：文字列
    result.reservableUnits.floor.sys_id フロア [sn_wsd_core_floor] テーブル内の関連レコードの sys_id。

    データタイプ：文字列
    result.reservableUnits.image 関連する予約可能項目のレイアウトを表す画像の詳細。

    画像 [db_image] テーブルにあります。

    "image": {
  "link": "String",
  "sys_id": "String"
}
    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 予約可能項目の場所のタイプに関する詳細 (workplace/desk、cafe、gym など)。

    職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    "location_type": {
  "display_value": "String",
  "name": "String",
  "sys_id": "String"
}
    result.reservableUnits.location_type.​display_value 場所タイプの表示値。

    データタイプ：文字列
    result.reservableUnits.location_type.name 地下やストレージなどの場所タイプの名前。表示値と同じです。

    データタイプ：文字列
    result.reservableUnits.location_type.sys_id スペースタイプ [sn_wsd_core_space_type] テーブルの関連レコードの sys_id。

    データタイプ：文字列
    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.​name 予約可能項目の名前。

    データタイプ：文字列
    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 予約可能項目が存在するサイトの詳細。

    サイト [sn_wsd_core_site] テーブルにあります。

    "site": {
  "display_value": "String",
  "sys_id": "String"
}
    result.reservableUnits.site.display_value サイトの表示値。

    データタイプ：文字列
    result.reservableUnits.site.sys_id サイト [sn_wsd_core_site] テーブルの関連サイトレコードの sys_id。

    データタイプ：文字列
    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 Search - 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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 指定された利用可能なシフトを取得するために使用するエンコードされたクエリ。

    データタイプ：オブジェクト

    "result": { 
  "moduleHasShift" : Boolean,
  "query": "String"
}
    moduleHasShift 指定された予約可能なモジュールでシフトが有効になっているかどうかを示すフラグ。
    有効な値：
    • true：予約可能なモジュールでシフトが有効になっています。
    • false：予約可能なモジュールでシフトが有効になっていません。エンコードされたクエリが返されませんでした。

    データタイプ：ブーリアン
    query 指定された予約可能なモジュールのシフト情報を取得するために使用するエンコードされたクエリ。

    データタイプ：文字列

    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 Search - 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 「Repeats daily, 5 times」など、繰り返し発生するパターンの説明。

    データタイプ：文字列
    recurringPattern.options 検索する繰り返し予約の使用可否オプション。

    データタイプ：オブジェクト

    "options": {
  "count": Number,
  "daysOfWeek": "String",
  "endDate": "String",
  "every": Number
}
    recurringPattern.options.count endDate が渡されない場合に必須です。両方が渡される場合、count が使用されます。会議パターンを繰り返す回数。

    データタイプ：数値
    recurringPattern.options.daysOfWeek recurringPattern.repeats パラメーターが weekly に設定されている場合は必須です。予約が必要な曜日。
    有効な値：
    • 1 = 月曜日
    • 2 = 火曜日
    • 3 = 水曜日
    • 4 = 木曜日
    • 5 = 金曜日
    • 6 = 土曜日
    • 7 = 日曜日

    たとえば、火曜日、木曜日、金曜日を指定するには、245 (区切り文字なし) を渡します。repeat が weekly、count が 5、daysOfWeek が 245 の場合、返される結果の合計は count*daysOfWeek.length (5*3=15) になります。

    データタイプ：文字列
    recurringPattern.options.endDate recurringPattern.options.count が渡されない場合に必須です。両方が渡される場合、count が使用されます。会議の繰り返しの終了日時 (「2022-07-08T14:00:00Z」など)。

    データタイプ：文字列

    形式：UTC yyyy-mm-dd hh:mm:ss
    recurringPattern.options.every パターンの繰り返し間隔。たとえば、この値が 2 の場合は、repeats パラメーターの選択に基づいて隔日や隔週など、パターンを繰り返します。

    データタイプ：数値
    recurringPattern.repeats 必須。可能な予約の繰り返しパターン。
    有効な値 (大文字と小文字を区別)：
    • daily
    • monthly
    • weekly
    • yearly

    データタイプ：文字列
    recurringPattern.startDate 必須です。繰り返しパターンの開始日時 (「2022-07-08T14:00:00Z」など)。

    データタイプ：文字列

    形式：UTC yyyy-mm-dd hh:mm:ss
    reservableIds 必須。使用可否スコアに含める可能な予約の sys_id のリスト。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ：アレイ
    reservableType 必須。使用可否スコアに含める可能な予約のタイプ。検索を絞り込むために使用します。
    有効な値 (大文字と小文字を区別)：
    • location
    • configuration_item

    データタイプ：文字列
    startEndDateTimes 検索するユーザーのタイムゾーンでの開始日時と終了日時のリスト。

    データタイプ：オブジェクトのアレイ

    "startEndDateTimes": [
  {
    "end": "String",
    "start": "String"
  }
]

    デフォルト：recurringPattern パラメーターを指定する必要があります。
    startEndDateTimes.end 可能な予約の終了日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss
    startEndDateTimes.start 可能な予約の開始日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss

    ヘッダー

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

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 指定された使用可否スコアの結果を返します。

    データタイプ：オブジェクト

    "result": {
  "reservable_sys_id": {
    "available": Number,
    "score": "String",
    "total": Number
  }
}
    result.available 指定された検索条件を満たした利用可能な予約の数。

    データタイプ：数値
    result.score 使用可否スコア。指定された検索条件を満たした利用可能な予約の合計数に対する、利用可能な予約の数。たとえば、available が 2 で total が 4 の場合、score の値は 2/4 です。

    データタイプ：文字列
    result.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\": \"\",
      \"every\": 1
    },
    \"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"
    }
  }