WSD 予約可能モジュール API
ワークプレイスサービスデリバリ (WSD) 予約可能モジュール API は、ServiceNow インスタンスから予約可能モジュールの詳細を取得するためのエンドポイントを提供します。
予約可能なモジュールは、類似するタイプの職場アイテムをグループ化します。従業員は、これらの類似アイテムを単一のカテゴリで表示できます。たとえば、部屋は予約可能なモジュールであり、会議室、カンファレンスルーム、その他の部屋などの類似の職場アイテムが含まれています。
この API にアクセスするには、発信者に sn_wsd_core.workplace_user ロールが必要であり、ワークプレイス予約管理 (sn_wsd_rsv) プラグインがアクティブ化されている必要があります。この API は sn_wsd_rsv 名前空間で実行されます。
ワークプレイス予約管理の詳細については、「Workplace Reservation Management」を参照してください。
WSD 予約可能モジュール:GET /sn_wsd_rsv/reservable_module/{sys_id}
指定された予約可能モジュールの詳細を返します。
URL 形式
バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/reservable_module/{sys_id}
デフォルト URL: /api/sn_wsd_rsv/reservable_module/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | 取得する取り消し可能なモジュールレコードのSys_id。 データタイプ:文字列 テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module] |
| 名前 | 説明 |
|---|---|
| is_buildings_tree_data_required | 予約可能モデルに関連付けられた建物データを返すかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| 近隣 | スペース管理 (sn_wsd_spc_mgmt_neighborhood) プラグインがアクティブ化されている場合にのみ使用できます。 エンコードされたクエリで使用する近隣レコードのSys_id。 近隣スペースの予約の詳細については、「 Create neighborhood reservations」を参照してください。 エンドポイントは、近隣が有効かどうかを確認し、近隣で参照パスに必要なデータを取得します。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| results | 要求された予約可能モジュールの詳細。 データタイプ: オブジェクト |
| result.allow_invitees | 従業員が招待者を予約に追加できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.allow_whole_day | ユーザーが予約可能サービスを終日予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.apply_to_shift | 予約可能なモジュールに対してシフトベースの予約が有効になっているかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.browse_by_area_enabled | ユーザーがエリア別に予約可能なモジュールを検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.browse_by_neighborhood_enabled | スペース管理 - sn_wsd_spc_mgmt プラグインがインストールされている場合にのみ使用できます。 ユーザーが予約可能モジュール内を近隣で検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.browse_near_a_person_enabled | 指定されたユーザーが見つけた予約可能なモジュールをユーザーが検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.buildingTreeData | is_buildings_tree_data_requiredクエリパラメーターが true に設定されている場合にのみ返されます。予約可能なモジュールに関連付けられている建物の階層。 階層順:
各 children[ ] ノードは、異なる建物レベル/階層を反映します。
データタイプ:オブジェクトのアレイ |
| result.buildingsTreeData.children | 予約可能なモジュールに関連付けられているサイト、敷地、または建物の詳細。すべての 子 [ ] ノードの各パラメータは同じです。これらはさまざまな建物エンティティにのみ適用されるため、このセクションでは 1 回だけ説明します。データタイプ:オブジェクトのアレイ |
| result.buildingsTreeData.children.data | 建物エンティティの詳細。 データタイプ: オブジェクト |
| result.buildingsTreeData.children.data.sys_id | 関連付けられた建物エンティティのSys_id。 データタイプ:文字列 |
| result.buildingsTreeData.children.data.table | sys_idで識別された建物エンティティレコードが配置されているテーブルの名前。 データタイプ:文字列 |
| result.buildingsTreeData.children.data.timezone | 建物エンティティのタイムゾーンに関する詳細。 |
| result.buildingsTreeData.children.data.timezone.displayValue | タイムゾーンのレコードに値を表示します。 データタイプ:文字列 |
| result.buildingsTreeData.children.data.timezone.value | タイムゾーンのレコードの内部値。 データタイプ:文字列 |
| result.buildingsTreeData.children.isSelectable | 関連する建物エンティティが予約可能モデルで利用可能 (選択可能) かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.buildingsTreeData.children.isValid | 関連付けられた建物エンティティが予約可能モデルに対して有効かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.buildingsTreeData.children.label | 建物エンティティの名前。 データタイプ:文字列 |
| result.buildingsTreeData.children.uId | 関連付けられた建物エンティティレコードのSys_id。 データタイプ:文字列 |
| result.buildingSysIds | 予約可能なモジュールに関連付けられている建物のsys_idsのリスト。 データタイプ:文字列のアレイ |
| result.checkin_before_minutes | 予約開始前にユーザーが予約にチェックインできる時間。 単位:分 データタイプ:数値 |
| result.display_number_of_attendees | ユーザーが予約の出席者の数を指定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.display_on_behalf_of | 他のユーザーの代わりに予約を行うことができるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.display_sensitivity | ユーザーが予約の機密性 (通常、プライベートなど) を設定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.display_value | 予約可能なモジュールの表示値。 データタイプ:文字列 |
| result.enable_browse_by_area | ユーザーがエリア別に予約可能なモジュールを検索できるかどうかを示すフラグ。browse_by_area_enabledと同じです。 有効な値:
データタイプ:ブーリアン |
| result.enable_browse_by_neighborhood | ユーザーが予約可能なモジュールを近隣で検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.enable_browse_near_a_person | 指定されたユーザーが見つけた予約可能なモジュールをユーザーが検索できるかどうかを示すフラグ。 browse_near_a_person_enabledと同じです。 有効な値:
データタイプ:ブーリアン |
| result.enable_facet_filter | 職場アイテムのファセットフィルタリングが有効かどうかを示すフラグ。有効にすると、検索結果に基づいてフィルターオプションが表示されます。ユーザーは、生成された検索結果で使用可能なアイテムのみをフィルターで選択できます。 有効な値:
データタイプ:ブーリアン |
| result.enable_group_reservations | ユーザーがグループ予約を行うことができるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.enable_ical_generation | ユーザーが予約の iCalendar を生成できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.font_awesome_icon | 予約可能モジュールに添付されているフォントアイコンの名前。 データタイプ:文字列 |
| result.inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストに沿って表示されます。 データタイプ:文字列 |
| result.layout_mapping | 場所のレイアウトマッピングの構造に関する詳細。このデータを使用して、UI に情報をレイアウトします。 データタイプ: オブジェクト |
| result.layout_mapping.body | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:オブジェクトのアレイ |
| result.layout_mapping.body.field | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.layout_mapping.body.field_to_display | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.layout_mapping.body.icon | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.layout_mapping.body.label | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.layout_mapping.description | フロントエンド UI データをマッピングするためのプレースホルダー。レイアウトマッピングの説明。 データタイプ:アレイ |
| result.layout_mapping.image | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.layout_mapping.subtitle | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.layout_mapping.subtitle_asc | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.layout_mapping.title | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.max_days_in_future | ユーザーが予約可能なモジュールを予約できる将来の最大日数。 データタイプ:数値 |
| result.max_occurrences | 予約可能なモジュールで繰り返し予約が利用可能な場合の繰り返し予約の最大発生回数。 データタイプ:数値 |
| result.name | 予約可能なモジュールの名前。 データタイプ:文字列 |
| result.nbhBuildingIds | スペース管理プラグインがインストールされていて、 browse_by_neighborhood_enabled パラメーターが true に設定され、 neighborhood パラメーターがクエリパラメーターで渡される場合にのみ返されます。 予約可能なモジュールに関連付けられ、近隣に設定されている建物のsys_idsのリスト。 データタイプ:文字列のアレイ |
| result.nbhBuildingsData | スペース管理プラグインがインストールされていて、 browse_by_neighborhood_enabled パラメーターが true に設定され、 neighborhood パラメーターがクエリパラメーターで渡される場合にのみ返されます。 予約可能なモジュールに関連付けられ、近隣に設定されている建物のsys_idsのリスト。各建物要素には、建物で利用可能な対応するフロアのsys_idsのリストも含まれています。 例: データタイプ:オブジェクトのアレイ テーブル:建物sys_idsに関連付けられたレコードは、建物 [sn_wsd_core_building] テーブルにあります。フロアsys_idsに関連付けられたレコードは、フロア [sn_wsd_core_floor] テーブルにあります。 |
| result.nbhBuildingsTreeData | スペース管理プラグインがインストールされていて、 browse_by_neighborhood_enabled パラメーターが true に設定され、 neighborhood パラメーターがクエリパラメーターで渡される場合にのみ返されます。 予約可能なモジュールと近隣に関連付けられている建物の階層。 データタイプ:オブジェクトのアレイ 階層順:
|
| result.nbhBuildingsTreeData.children | 建物に関連付けられている子の階層を示します。 各 children[] ノードは、異なる建物レベル/階層を反映します。
データタイプ:オブジェクトのアレイ
|
| result.nbhBuildingsTreeData.data | 関連エンティティに関する詳細。地域、サイト、敷地、または建物。 データタイプ: オブジェクト |
| result.nbhBuildingsTreeData.data.sysId | 関連付けられたエンティティレコードのSys_id。 データタイプ:文字列 |
| result.nbhBuildingsTreeData.data.table | 関連レコードが配置されているテーブル。 データタイプ:文字列 |
| result.nbhBuildingsTreeData.data.timezone | 関連付けられたエンティティが存在するタイムゾーンに関する情報。 データタイプ: オブジェクト |
| result.nbhBuildingsTreeData.data.timezone.displayValue | ユーザーインターフェイスで使用するタイムゾーン値。 データタイプ:文字列 |
| result.nbhBuildingsTreeData.data.timezone.value | 内部タイムゾーン値。 データタイプ:文字列 |
| result.nbhBuildingsTreeData.isSelectable | 関連するエンティティが予約可能モデルで利用可能 (選択可能) かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.nbhBuildingsTreeData.isValid | 関連付けられたエンティティが予約可能モデルに対して有効かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.nbhBuildingsTreeData.label | 予約可能なビューの名前。 データタイプ:文字列 |
| result.nbhBuildingsTreeData.uId | 関連付けられたエンティティのSys_id。 データタイプ:文字列 |
| result.override_approval_policy | 承認ポリシーの実装方法を指定するオプション。 Choices (選択肢):
データタイプ:文字列 |
| result.require_cancel_notes | 予約可能なモジュールをキャンセルする前にユーザーがキャンセルメモを入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.require_cc_dept_check | ワークスペースアイテムとログインユーザーの間にコストセンターまたは部門の不一致があるかどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.require_subject | 予約時にユーザーが件名を入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservable_columns | 予約可能な列のリスト。 データタイプ:アレイ テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.reservable_container_field | 特定のエリアにある机のグループなど、コンテナのレベル。 データタイプ:文字列 |
| result.reservable_filter | 関連する予約可能テーブル内の予約可能アイテムを除外するために使用されるフィルター条件。予約可能テーブルは、予約可能モジュール [sn_wsd_rsv_reservable_module] テーブルのフィールドです。これらのフィルター条件は、[予約可能テーブル] フィールドに含まれるテーブルに適用されました。 データタイプ:文字列 |
| result.reservable_quantity_field | すべてのスペースの予約可能な数量。数量は、エリアに近隣スペースをアサインするときに使用されます。詳細については、「 エリアへの近隣スペースのアサイン」をご参照ください。 データタイプ:文字列 |
| result.reservable_table | 予約可能な職場アイテムを含むテーブル。 データタイプ:文字列 |
| result.reservable_type | 場所などの予約可能なアイテムのタイプ。 データタイプ:文字列 |
| result.reservable_views | カードビューやスケジュールビューなど、予約可能なモジュールに関連付けられているさまざまなビューの詳細。 データタイプ: オブジェクト テーブル:予約可能なビュー [sn_wsd_rsv_reservable_view] |
| result.reservable_views.iconClass | 予約可能なビューのアイコンクラス。 データタイプ:文字列 |
| result.reservable_views.isDefault | この予約可能なビューを予約可能なモジュールのデフォルトにするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservable_views.label | 予約可能なビューの名前。 データタイプ:文字列 |
| result.reservable_views.order | UI で予約可能モジュールのビューが表示される順序。UI では、小さい番号が最初に表示されます。同じ順序番号の場合は、ランダムな順序で割り当てられます。 データタイプ:数値 |
| result.reservable_views.type | 予約可能なビューのバックエンド名。内部処理に使用されます。 データタイプ:文字列 |
| result.reservation_paths | [すべて参照]、[人の近くで参照する] などの予約可能モジュールに関連付けられた予約パス。 データタイプ:オブジェクトのアレイ |
| result.reservation_paths.displayValue | 「人の近くで参照する」などの予約パスの表示値。 データタイプ:文字列 |
| result.reservation_paths.value | 予約パスの内部値 (「browse_near_a_person」など)。 データタイプ:文字列 |
| result.search_limit | ユーザーが職場の場所を検索したときに返される検索結果の最大数。 データタイプ:数値 |
| result.selection_type | 検索結果に表示する選択のタイプ。 次のいずれかのオプションを指定できます。
データタイプ:文字列 |
| result.short_description | 予約可能なモジュールの簡単な説明。 データタイプ:文字列 |
| result.show_map_view | 予約可能モジュールのマップビューを有効にするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.sys_id | 予約可能モジュールのSys_id。 データタイプ:文字列 |
| result.timeSlots | 予約可能なモジュールに関連付けられたタイムスロットに関する詳細。 データタイプ:オブジェクトのアレイ |
| result.timeSlots.name | タイムスロットの名前 データタイプ:文字列 |
| result.timeSlots.short_description | タイムスロットの簡単な説明。 データタイプ:文字列 |
| result.timeSlots.slot_end | タイムスロットの終了時間 データタイプ:文字列 |
| result.timeSlots.slot_start | スロットの開始時間。 データタイプ:文字列 |
| result.timeSlots.sys_id | タイムスロットレコードのSys_id。 データタイプ:文字列 テーブル:タイムスロット [sn_wsd_rsv_time_slot] |
| result.title | 予約可能モジュールのタイトル。 データタイプ:文字列 |
| result.virtual_meeting_provider | 予約可能なモジュールに関連付けられている仮想プロバイダーの詳細。 データタイプ: オブジェクト |
| result.virtual_meeting_provider.display_value | バーチャル会議プロバイダーの表示値。 データタイプ:文字列 |
| result.virtual_meeting_provider.sys_id | バーチャル会議プロバイダーのSys_id。 データタイプ:文字列 |
cURL 要求
このコード例は、建物のツリーデータを使用して予約可能なモジュールを要求する方法を示しています。
curl "http://instance.servicenow.com/api/sn_wsd_rsv/reservable_module/5db44502dbb650106c731dcd13961937&is_buildings_tree_data_required=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
応答本文:
{
"result": {
"sys_id": "5db44502dbb650106c731dcd13961937", "name": "Desks",
"title": "Desks",
"inline_title": "desk",
"font_awesome_icon": "fa-desktop",
"reservable_table": "sn_wsd_core_space",
"reservable_filter": "active=true^is_reservable=true^location_type=5f017383eb512010b89bfdfc9c5228c8^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a single desks",
"reservable_type": "location",
"require_subject": null,
"require_cancel_notes": false,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": null,
"display_number_of_attendees": null,
"display_on_behalf_of": null,
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_whole_day": "1",
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "90",
"enable_facet_filter": false,
"search_limit": 10000,
"enable_ical_generation": null,
"enable_group_reservations": null,
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"enable_browse_by_neighborhood": "1",
"show_map_view": false,
"require_cc_dept_check": false,
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"browse_by_neighborhood_enabled": true,
"reservable_columns": [
"sys_id",
"external_id",
"email",
"name",
"title",
"description",
"image",
"number",
"site",
"campus",
"building",
"floor",
"area",
"capacity",
"reservable_quantity",
"location_type",
"order",
"requires_check_in",
"is_reservable"
],
"layout_mapping": {
"title": [
"name"
],
"description": [
"description"
],
"subtitle": [
"campus",
"building",
"floor",
"area"
],
"subtitle_asc": [
"area",
"floor",
"building",
"campus"
],
"image": "image",
"body": [
{
"label": "Capacity",
"icon": "fa-users",
"field": "capacity",
"field_to_display": ""
},
{
"label": "Standard services",
"icon": "fa-check",
"field": "standard_services",
"field_to_display": "name"
},
{
"label": "Reservable purposes",
"icon": "fa-tags",
"field": "reservable_purposes",
"field_to_display": "name"
}
]
},
"timeSlots": [
{
"sys_id": "d5331cf2dbb5f01038e42b24ca961906",
"name": "All day",
"short_description": "8am - 6pm",
"slot_start": "08:00",
"slot_end": "18:00"
},
{
"sys_id": "de131cf2dbb5f01038e42b24ca961931",
"name": "Before noon",
"short_description": "8am - 12pm",
"slot_start": "08:00",
"slot_end": "12:00"
},
{
"sys_id": "6e99ab5ddbb930102e8e853e68961929",
"name": "After noon",
"short_description": "1pm - 6pm",
"slot_start": "13:00",
"slot_end": "18:00"
}
],
"buildingSysIds": [
"9e0364cedb3650106c731dcd1396192b"
],
"buildingsTreeData": [
{
"isValid": true,
"label": "Europe",
"uId": "2d626c4edb3650106c731dcd1396194b",
"isSelectable": false,
"children": [
{
"isValid": true,
"label": "Western Europe",
"uId": "b17220cedb3650106c731dcd1396197a",
"isSelectable": false,
"children": [
{
"isValid": true,
"label": "Amsterdam Campus",
"uId": "44d2e0cedb3650106c731dcd13961988",
"isSelectable": false,
"children": [
{
"isValid": true,
"label": "AMS-B1",
"uId": "9e0364cedb3650106c731dcd1396192b",
"isSelectable": true,
"children": [],
"data": {
"sysId": "9e0364cedb3650106c731dcd1396192b",
"table": "sn_wsd_core_building",
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
}
}
],
"data": {
"sysId": "44d2e0cedb3650106c731dcd13961988",
"table": "sn_wsd_core_campus",
"timezone": null
}
}
],
"data": {
"sysId": "b17220cedb3650106c731dcd1396197a",
"table": "sn_wsd_core_site",
"timezone": null
}
}
],
"data": {
"sysId": "2d626c4edb3650106c731dcd1396194b",
"table": "sn_wsd_core_region",
"timezone": null
}
}
],
"reservable_views": [
{
"type": "card",
"label": "Card view",
"iconClass": "fa-th-large",
"isDefault": true,
"order": "1"
},
{
"type": "schedule",
"label": "Schedule view",
"iconClass": "fa-calendar-o",
"isDefault": false,
"order": "2"
}
],
"checkin_before_minutes": 30,
"reservation_paths": [
{
"value": "browse_all",
"displayValue": "Browse all"
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person"
},
{
"value": "browse_by_area",
"displayValue": "Browse by area"
}
],
"override_approval_policy": "never_required"
}
}