WSD Reservation API
ワークプレイスサービスデリバリ (WSD) Reservation API は、職場予約を管理するためのエンドポイントを提供します。
この API にアクセスするには、問い合わせユーザーに sn_wsd_core.workplace_user ロールが必要であり、Workplace Safety Management (sn_wsd_core) と Workplace Reservation Management (sn_wsd_rsv) プラグインを有効にする必要があります。
この API は sn_wsd_rsv 名前空間で実行されます。
ワークプレイス予約管理の詳細については、「ワークプレイス予約管理」を参照してください。
WSD Reservation - GET /api/sn_wsd_rsv/reservation/get
指定された職場予約を取得します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/get
デフォルトの URL:/api/sn_wsd_rsv/reservation/get
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| external_ical | 予約の一意の外部 iCalendar ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。関連する外部 iCalendar アプリケーションからこの値を取得します。 データタイプ:文字列 |
| external_id | 予約の一意の外部 ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。関連する外部アプリケーションからこの値を取得します。 データタイプ:文字列 |
| include_multi_child_data | 関連する職場予約 [sn_wsd_rsv_reservation] レコードの reservation_subtype フィールド値が multi_child に設定されている場合、このフラグは予約の詳細を返すかどうかを示します。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| include_standard_services | 応答で標準サービス情報を返すかどうかを示すフラグ。この情報は、標準サービス [sn_wsd_rsv_standard_service] テーブルにあります。 標準サービスでは、ホワイトボード、追加のモニター、および類似サービスなど、予約時に予約可能な職場アイテムで利用可能な基本的なプロビジョニングについて説明します。標準サービスの詳細については、「 標準サービス」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| sys_id | 必須です。 予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result.reservation | 予約の詳細。 データタイプ:オブジェクト |
| result.reservation.active | 予約がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.attendees | 予約の出席者のリスト。 データタイプ:オブジェクトのアレイ |
| result.reservation.attendees.avatar | 出席者に関連付けられたアバターの sys_id。 データタイプ:文字列 テーブル:添付ファイル [sys_attachment] |
| result.reservation.attendees.displayValue | 出席者の表示値。 データタイプ:文字列 |
| result.reservation.attendees.display_value | 出席者の表示値。displayValue と同じです。 データタイプ:文字列 |
| result.reservation.attendees.email | 出席者のメールアドレス。 データタイプ:文字列 |
| result.reservation.attendees.initials | 出席者のイニシャル。 データタイプ:文字列 |
| result.reservation.attendees.name | 出席者の名前。 データタイプ:文字列 |
| result.reservation.attendees.sys_id | 出席者レコードのSys_id。 データタイプ:文字列 |
| result.reservation.attendees.table | 出席者レコードが存在するテーブル。 データタイプ:文字列 |
| result.reservation.attendees.user_name | 出席者のユーザー名。 データタイプ:文字列 |
| result.reservation.attendees.value | 出席者の内部値。 データタイプ:文字列 |
| result.reservation.check_in_state | 予約のチェックインステータスに関する詳細。 データタイプ:オブジェクト |
| result.reservation.check_in_state.display_value | 予約の現在のチェックインステータスの表示値 (処理中、完了など)。 データタイプ:文字列 |
| result.reservation.check_in_state.value | 予約の現在のチェックインステータスの内部値 (2 など)。 データタイプ:文字列 |
| result.reservation.edit_restriction | 予約のユーザー編集制限の説明 (no_restrictions、service_only、full_restricted など)。 データタイプ:オブジェクト |
| result.reservation.edit_restriction.display_value | 予約の編集制限の表示値 ([制限なし] など)。 データタイプ:文字列 |
| result.reservation.edit_restriction.value | 予約の編集制限の内部値 (no_restriction など)。 データタイプ:文字列 |
| result.reservation.end | 予約の終了日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (2021-02-05T18:00:00Z など) |
| result.reservation.external_ical | 予約の一意の外部 iCalendar ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。 データタイプ:文字列 |
| result.reservation.external_id | 予約の一意の外部 ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。 データタイプ:文字列 |
| result.reservation.is_parent | この予約が親予約かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.reservation.is_private | 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外の誰にも表示されません。 これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト:システムプロパティでプライバシーに設定された値。 |
| result.reservation.last_updated_sub_source | 予約の最後に更新されたサブソースに関する詳細。サブソースは、予約を外部カレンダーと統合するときに使用されます。このオブジェクトには、「servicenow_workplace_service_delivery」、「google_calendar」、「microsoft_exchange」などの情報が含まれています。 データタイプ:オブジェクト |
| result.reservation.last_updated_sub_source.display_value | ServiceNow Workplace Service Delivery や Google カレンダーなど、予約の最後に更新されたサブソースの表示値。予約を Google カレンダーや Microsoft Outlook などの外部サービスと統合するときに使用されます。 データタイプ:文字列 |
| result.reservation.last_updated_sub_source.value | servicenow_workplace_service_delivery や google_calendar など、予約の最後に更新されたサブソースの内部値。予約を Google カレンダーや Microsoft Outlook などの外部サービスと統合するときに使用されます。 データタイプ:文字列 |
| result.reservation.location | 予約に関連付けられた場所の詳細。 データタイプ:オブジェクト |
| result.reservation.location.area | 場所に関連付けられたエリアに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.area.active | エリアがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.area.display_value | Desk A2 など、この場所が属するエリアの表示値。 データタイプ:文字列 |
| result.reservation.location.area.sys_id | この場所が属するエリアの sys_id。 データタイプ:文字列 テーブル:エリア [sn_wsd_core_area] |
| result.reservation.location.building | 場所に関連付けられた建物に関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.building.active | 建物がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.building.display_value | AMS - Bld1 など、この場所が属する建物の表示値。 データタイプ:文字列 |
| result.reservation.location.building.sys_id | この場所が属する建物の sys_id。 データタイプ:文字列 テーブル:建物 [sn_wsd_core_building] |
| result.reservation.location.building.timezone | 場所に関連付けられたタイムゾーンに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.building.timezone.display_value | この場所が属するタイムゾーンの表示値。 データタイプ:文字列 |
| result.reservation.location.building.timezone.value | この場所が属するタイムゾーンの内部値。 データタイプ:文字列 |
| result.reservation.location.campus | 場所に関連付けられた敷地に関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.campus.active | 敷地がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.campus.display_value | Amsterdam Campus など、この場所が属する敷地の表示値。 データタイプ:文字列 |
| result.reservation.location.campus.sys_id | この場所が属する敷地の sys_id。 データタイプ:文字列 テーブル:敷地 [sn_wsd_core_campus] |
| result.reservation.location.capacity | 場所の参加者の最大人数。 データタイプ:数値 |
| result.reservation.location.description | 場所の簡単な説明。 データタイプ:文字列 |
| result.reservation.location.display_value | この場所の UI に表示する値。 データタイプ:文字列 |
| result.reservation.location.email | 場所のメールアドレス。 データタイプ:文字列 |
| result.reservation.location.floor | 場所に関連付けられたフロアに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.floor.active | フロアがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.floor.display_value | First floor など、この場所が属するフロアの表示値。 データタイプ:文字列 |
| result.reservation.location.floor.sys_id | この場所が属するフロアの sys_id。 データタイプ:文字列 テーブル:フロア [sn_wsd_core_floor] |
| result.reservation.location.label_value | name パラメーターで指定された値のタイプ (部屋名など)。 データタイプ:文字列 |
| result.reservation.location.name | 場所の名前。 データタイプ:文字列 |
| result.reservation.location.number | 予約番号。 データタイプ:文字列 |
| result.reservation.location.number_of_attendees | 予約の出席者の数。 データタイプ:数値 |
| result.reservation.location.region | 場所に関連付けられたリージョンに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.region.active | リージョンがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.region.display_value | Europe など、この場所が属するリージョンの表示値。 データタイプ:文字列 |
| result.reservation.location.region.sys_id | この場所が属するリージョンの sys_id。 データタイプ:文字列 テーブル:リージョン [sn_wsd_core_region] |
| result.reservation.location.requested_for | 代理で予約が要求されたユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.location.requested_for.name | 予約が要求されたユーザーの名前。 データタイプ:文字列 |
| result.reservation.location.requested_for.sys_id | 予約が要求されているユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.location.requested_for.user_name | 予約が要求されたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.location.reservation | 場所に関連付けられた予約の詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservation.active | 予約がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.reservation.number | 予約番号。 データタイプ:文字列 |
| result.reservation.location.reservation.number_of_attendees | 予約の出席者の数。 データタイプ:数値 |
| result.reservation.location.reservation.requested_for | 代理で予約が要求されたユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservation.requested_for.name | 予約が要求されたユーザーの名前。 データタイプ:文字列 |
| result.reservation.location.reservation.requested_for.sys_id | 要求されたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.location.reservation.requested_for.user_name | 予約が要求されたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.location.reservable_module | 予約に関連付けられている予約可能モジュールに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservable_module.inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストとともインラインに表示されます。 データタイプ:文字列 |
| result.reservation.location.reservable_module.name | 予約可能モジュールの名前。 データタイプ:文字列 |
| result.reservation.location.reservable_module.sys_id | 予約可能モジュールの sys_id。 データタイプ:文字列 |
| result.reservation.location.reservable_module.title | 予約可能なモジュールのタイトル。 データタイプ:文字列 |
| result.reservation.location.site | 場所が属するサイト。 データタイプ: オブジェクト テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.site.active | サイトがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.site.display_value | Western Europe など、この場所が属するサイトの表示値。 データタイプ:文字列 |
| result.reservation.location.site.sys_id | この場所が属するサイトの sys_id。 データタイプ:文字列 テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.state | 場所の予約のステータスの詳細。 データタイプ:オブジェクト |
| result.reservation.location.state.display_value | 予約の現在のステータスの表示値 (確定済みなど)。 データタイプ:文字列 |
| result.reservation.location.state.value | 予約の現在のステータスの内部値 (2 など)。 データタイプ:文字列 |
| result.reservation.location.sys_id | 関連付けられた場所レコードの sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.reservation.notification_custom_message | reservation.notification_recipients にリストされている受信者に送信される通知のカスタムメッセージ。 データタイプ:文字列 |
| result.reservation.notification_recipients | 予約に関する通知を受信する受信者のリスト。 データタイプ:オブジェクトのアレイ |
| result.reservation.notification_recipients.name | 受信者の名前。 データタイプ:文字列 |
| result.reservation.notification_recipients.sys_id | 受信者の sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.notification_recipients.user_name | 受信者のユーザー名。 データタイプ:文字列 |
| result.reservation.number | 予約レコードの一意の番号。この値を使用して予約を照会できます。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| result.reservation.opened_by | 予約を作成したユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.opened_by.avatar | 予約をオープンしたユーザーのアバター。 データタイプ:文字列 |
| result.reservation.opened_by.displayValue | オープンしたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.opened_by.display_value | オープンしたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.opened_by.email | 予約をオープンしたユーザーのメールアドレス。 データタイプ:文字列 |
| result.reservation.opened_by.initials | 予約をオープンしたユーザーのイニシャル。 データタイプ:文字列 |
| result.reservation.opened_by.label | 予約をオープンしたユーザーのラベル。これは、ユーザーの役職と部門の組み合わせです。 データタイプ:文字列 |
| result.reservation.opened_by.name | 予約をオープンしたユーザーの名前。 データタイプ:文字列 |
| result.rservation.opened_by.sys_id | 予約をオープンしたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.rservation.opened_by.table | ユーザーレコードを含むテーブル。 データタイプ:文字列 |
| result.reservation.opened_by.user_name | 予約をオープンしたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.opened_by.value | 予約をオープンしたユーザーの内部値。 データタイプ:文字列 |
| result.reservation.number | 予約番号。 データタイプ:文字列 |
| result.reservation.number_of_attendees | この予約の出席者の数。 データタイプ:数値 |
| result.reservation.recording_details | 予約 (会議) に関連付けられている記録に関する詳細。 データタイプ:オブジェクトのアレイ |
| result.reservation.recording_details.recording_url | 予約に関連付けられている記録の URL。 データタイプ:文字列 |
| result.reservation.requested_for | 予約が代理で行われたユーザーに関する詳細。 データタイプ:オブジェクト |
| result.reservation.requested_for.avatar | 予約が代理で行われたユーザーのアバター。 データタイプ:文字列 |
| result.reservation.requested_for.displayValue | 予約が代理で行われたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.requested_for.display_value | 予約が代理で行われたユーザーの表示値。displayValue と同じです。 データタイプ:文字列 |
| result.reservation.requested_for.email | 予約が代理で行われたユーザーのメールアドレス。 データタイプ:文字列 |
| result.reservation.requested_for.initials | 予約が代理で行われたユーザーのイニシャル。 データタイプ:文字列 |
| result.reservation.requested_for.label | 予約が代理で行われたユーザーのラベル。 データタイプ:文字列 |
| result.reservation.requested_for.name | 予約が代理で行われたユーザーの名前。 データタイプ:文字列 |
| result.rservation.requested_for.sys_id | 予約が代理で行われたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.rservation.requested_for.table | ユーザーレコードを含むテーブル。 データタイプ:文字列 |
| result.reservation.requested_for.user_name | 予約が代理で行われたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.requested_for.value | 予約が代理で行われたユーザーの内部値。 データタイプ:文字列 |
| result.reservation.reservable_module | 要求された予約可能モジュールの詳細。 データタイプ:オブジェクト |
| result.reservation.reservable_module.allow_invitees | 従業員が招待者を予約に追加できるどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.allow_whole_day | ユーザーが予約可能項目を終日予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.apply_to_shift | 予約可能モジュールに対してシフトベースの予約が有効かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.browse_by_area_enabled | ユーザーがエリア別に予約可能モジュールを検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.browse_near_a_person_enabled | ユーザーが特定のユーザーによって配置された予約可能モジュールを検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.buildingSysIds | 予約可能モジュールに関連付けられた建物の sys_id のリスト。 データタイプ:文字列のアレイ |
| result.reservation.reservable_module.checkin_before_minutes | ユーザーが予約にチェックインできる予約開始前の時間。 単位:分 データタイプ:数値 |
| result.reservation.reservable_module.display_number_of_attendees | ユーザーが予約の出席者の数を指定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.display_on_behalf_of | 他のユーザーの代わりに予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.display_sensitivity | ユーザーが、normal、private などの予約の機密性を設定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.display_value | 予約可能モジュールの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.enable_browse_by_area | ユーザーがエリア別に予約可能モジュールを検索できるかどうかを示すフラグ。browse_by_area_enabled と同じです。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_browse_near_a_person | ユーザーが特定のユーザーによって配置された予約可能モジュールを検索できるかどうかを示すフラグ。 browse_near_a_person_enabled と同じです。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_facet_filter | 職場アイテムのファセットフィルタリングが有効かどうかを示すフラグ。有効にすると、表示されるフィルターオプションは検索結果に基づきます。ユーザーは、生成された検索結果で使用可能なアイテムのみをフィルターで選択できます。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_group_reservations | ユーザーがグループ予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.enable_ical_generation | ユーザーが予約の iCalendar を生成できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.font_awesome_icon | 予約可能モジュールに添付されているフォントアイコンの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストとともインラインに表示されます。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping | 場所のレイアウトマッピングの構造に関する詳細。このデータを使用して、UI に情報をレイアウトします。 データタイプ: オブジェクト |
| result.reservation.reservable_module.layout_mapping.body | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.layout_mapping.body.field | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.field_to_display | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.icon | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.label | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.description | フロントエンド UI データをマッピングするためのプレースホルダー。レイアウトマッピングの説明。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.image | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.subtitle | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.subtitle_asc | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.title | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.max_days_in_future | ユーザーが予約可能モジュールを予約できる、今後の最大日数。 データタイプ:数値 |
| result.reservation.reservable_module.max_occurrences | 予約可能モジュールの繰り返し予約が利用可能な場合の繰り返し予約の最大発生回数。 データタイプ:数値 |
| result.reservation.reservable_module.name | 予約可能モジュールの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.override_approval_policy | 承認ポリシーの実装方法を指定するオプション。 Choices (選択肢):
データタイプ:文字列 |
| result.reservation.reservable_module.require_cancel_notes | 予約可能モジュールをキャンセルする前にユーザーがキャンセルメモを入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.require_cc_dept_check | ワークスペースアイテムとログインユーザーの間にコストセンターまたは部門の不一致があるかどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.require_subject | 予約時にユーザーが件名を入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.reservable_columns | 予約可能項目の列のリスト。 データタイプ:アレイ テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.reservation.reservable_module.reservable_container_field | 特定のエリアのデスクのグループなどのコンテナーのレベル。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_filter | 関連付けられた予約可能テーブルの予約可能アイテムのフィルタリングに使用されるフィルター条件。予約可能テーブルは、予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブル内のフィールドです。これらのフィルター条件は、フィールドの予約可能テーブルに含まれるテーブルに適用されました。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_quantity_field | すべてのスペースの予約可能な数量。数は、エリアに近隣スペースをアサインするときに使用されます。詳細については、「 エリアへの近隣スペースの割り当て」を参照してください。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_table | 予約可能な職場アイテムを含むテーブル。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_type | 予約可能アイテムのタイプ (場所など)。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views | カードビューやスケジュールビューなど、予約可能モジュールに関連付けられたさまざまなビューに関する詳細。 データタイプ: オブジェクト テーブル:予約可能なビュー [sn_wsd_rsv_reservable_view] |
| result.reservation.reservable_module.reservable_views.iconClass | 予約可能なビューのアイコンクラス。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views.isDefault | この予約可能なビューを予約可能なモジュールのデフォルトにするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.reservable_views.label | 予約可能なビューの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views.order | UI の予約可能モジュールのビューが表示される順序。UI では小さい順序番号が先に表示されます。同じ順序番号の場合は、ランダムな順序が割り当てられます。 データタイプ:数値 |
| result.reservation.reservable_module.reservable_views.type | 予約可能なビューのバックエンド名。内部処理に使用されます。 データタイプ:文字列 |
| result.reservation.reservable_module.reservation_paths | [すべて参照]、 [人の近くで参照する] などの予約可能なモジュールに関連付けられた予約パス。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.reservation_paths.display_value | [人の近くで参照する] などの予約パスの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.reservation_paths.value | 「browse_near_a_person」などの予約パスの内部値。 データタイプ:文字列 |
| result.reservation.reservable_module.search_limit | ユーザーが職場の場所を検索するときに返される検索結果の最大数。 データタイプ:数値 |
| result.reservation.reservable_module.selection_type | 検索結果に表示する選択のタイプ。 次のいずれかのオプションを指定できます。
データタイプ:文字列 |
| result.reservation.reservable_module.short_description | 予約可能なモジュールの簡単な説明。 データタイプ:文字列 |
| result.reservation.reservable_module.show_map_view | この予約可能なモジュールのマップビューを有効にするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.sys_id | 予約可能モジュールの sys_id。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots | 予約可能モジュールに関連付けられたタイムスロットの詳細。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.timeSlots.name | タイムスロットの名前 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.short_description | タイムスロットの簡単な説明。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.slot_end | タイムスロットの終了時間 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.slot_start | スロットの開始時間。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.sys_id | タイムスロットレコードの sys_id。 データタイプ:文字列 テーブル:タイムスロット [sn_wsd_rsv_time_slot] |
| result.reservation.reservable_module.title | 予約可能なモジュールのタイトル。 データタイプ:文字列 |
| result.reservation.reservable_module.virtual_meeting_provider | 予約可能モジュールに関連付けられている仮想プロバイダーの詳細。 データタイプ:オブジェクト |
| result.reservation.reservable_module.virtual_meeting_provider.display_value | バーチャル会議プロバイダーの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.virtual_meeting_provider.sys_id | バーチャル会議プロバイダーの sys_id。 データタイプ:文字列 |
| result.reservation.reservationAcl | 関連する予約に設定されているユーザーアクセス制御レベル (ACL) チェックの詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.read | ユーザーがこの予約を読み取り可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write | 関連付けられている予約のユーザーの書き込み機能に関する詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.write.allFields | ユーザーが reservationACL.write.fields オブジェクトで指定されたすべてのフィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。ユーザーが一部の特定のフィールドにのみアクセスできる場合は、それらのフィールドのみが reservationACL.write.fields オブジェクトで true になります。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields | 予約のさまざまなフィールドに対するアクセス制御の詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.write.fields.location | ユーザーがこの予約の場所フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.number_of_attendees | ユーザーがこの予約の出席者の数フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.requested_for | ユーザーがこの予約の要求元フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.sensitivity | ユーザーがこの予約の機密フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.subject | ユーザーがこの予約の件名フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.record | ユーザーが予約レコード全体に書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservation_purpose | 予約の目的の詳細。 データタイプ:オブジェクト |
| result.reservation.reservation_purpose.display_value | 会社の会議などの予約の目的の表示値。 データタイプ:文字列 |
| result.reservation.reservation_purpose.value | company_meeting などの予約の目的の内部値。 データタイプ:文字列 |
| result.reservation.reservation_type | 予約のタイプの詳細。 データタイプ:オブジェクト |
| result.reservation.reservation_type.display_value | スペースなどの予約のタイプの表示値。 データタイプ:文字列 |
| result.reservation.reservation_type.value | space などの予約のタイプの内部値。 データタイプ:文字列 |
| result.reservation.reservation_subtype | 予約のサブタイプの詳細。サブタイプは、単一、複数の親、複数の子、繰り返し発生する親、発生件数などの予約のタイプを示します。 データタイプ:オブジェクト |
| result.reservation.reservation_subtype.display_value | 単一などの予約のサブタイプの表示値。 データタイプ:文字列 |
| result.reservation.reservation_subtype.value | single などの予約のサブタイプの内部値。 データタイプ:文字列 |
| result.reservation.sensitivity | 予約の機密性の詳細。 データタイプ:オブジェクト |
| result.reservation.sensitivity.display_value | 高、低などの予約の機密性の表示値。 データタイプ:文字列 |
| result.reservation.sensitivity.value | 1、3 などの予約の機密性の内部値。 データタイプ:文字列 |
| result.reservation.shift | 予約に適用されるシフトの詳細。 データタイプ:オブジェクト |
| result.reservation.shift.display_value | シフトの表示値。 データタイプ:文字列 |
| result.reservation.shift.name | シフトの名前。display_value と同じです。 データタイプ:文字列 |
| Result.reservation.shift.shiftDetails | シフトの詳細。 データタイプ:文字列 |
| result.reservation.shift.sys_id | シフトレコードの sys_id。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| result.reservation.source | 職場サービスや Google メールなどの予約のソースに関する詳細。 データタイプ:オブジェクト |
| result.reservation.source.display_value | 職場サービスなど予約ソースの表示値。 データタイプ:文字列 |
| result.reservation.source.value | servicenow など予約ソースの内部値。 データタイプ:文字列 |
| result.reservation.source_icon | 予約で使用されるアイコンのソースの詳細。このアイコンは UI で使用されます。 データタイプ:オブジェクト |
| result.reservation.source_icon.classNames | ソースアイコンのカンマ区切りのクラス名。 データタイプ:文字列 |
| result.reservation.source_icon.imgSrc | ソースアイコンの画像ソースの名前。このアイコンは画像 [db_image] テーブルに保存されます。 データタイプ:文字列 |
| result.reservation.source_icon.tooltip | ソースアイコンに関連付けられたツールヒント。 データタイプ:文字列 |
| result.reservation.source_reservation | 現在の予約のソース予約。 たとえば、複数の予約の場合、親予約が子予約のソースになります。 データタイプ:文字列 |
| result.reservation.start | 予約の開始日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (2021-02-05T18:00:00Z など) |
| result.reservation.subject | 予約の件名。 データタイプ:文字列 |
| result.reservation.sub_source | 予約のサブソースの詳細。サブソースは、Google カレンダーや Microsoft Exchange などの予約の作成元を指定します。 データタイプ:オブジェクト |
| result.reservation.sub_source.display_value | Google カレンダーなどの予約のサブソースの表示値。 データタイプ:文字列 |
| result.reservation.sub_source.value | google_calendar などの予約のサブソースフィールドの内部値。 データタイプ:文字列 |
| result.reservation.sync_state | 「sync_enqueued」や「synchronized」など、別のサービスからの予約の同期ステータスに関する詳細。 データタイプ:オブジェクト |
| result.reservation.sync_state.display_value | 同期済みなど予約の現在の同期ステータスの表示値。 データタイプ:文字列 |
| result.reservation.sync_state.value | synchronized など予約の現在の同期ステータスの内部値。 データタイプ:文字列 |
| result.reservation.sys_created_on | 予約が作成された日時。 データタイプ:文字列 |
| result.reservation.sys_id | 必須です。 予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| Result.reservation.sys_updated_on | 予約が最後に更新された日時。 データタイプ:文字列 |
| result.reservation.virtual_meeting | バーチャル会議リンクの URL。 データタイプ:文字列 |
| result.reservationAcl | 関連する予約に設定されているユーザーアクセス制御レベル (ACL) チェックの詳細。 データタイプ:オブジェクト |
| result.reservationAcl.read | ユーザーがこの予約を読み取り可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write | 関連付けられている予約のユーザーの書き込み機能に関する詳細。 データタイプ:オブジェクト |
| result.reservationAcl.write.allFields | ユーザーが reservationACL.write.fields オブジェクトで指定されたすべてのフィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。ユーザーが一部の特定のフィールドにのみアクセスできる場合は、それらのフィールドのみが reservationACL.write.fields オブジェクトで true になります。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields | 予約のさまざまなフィールドに対するアクセス制御の詳細。 データタイプ:オブジェクト |
| result.reservationAcl.write.fields.location | ユーザーがこの予約の場所フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.number_of_attendees | ユーザーがこの予約の出席者の数フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.requested_for | ユーザーがこの予約の要求元フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.sensitivity | ユーザーがこの予約の機密フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.subject | ユーザーがこの予約の件名フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.record | ユーザーが予約レコード全体に書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.standard_services | include_standard_services パラメーターが true に設定されている場合にのみ入力されます。 フリップチャート、プロジェクタースクリーン、ホワイトボードとマーカーなどの関連する標準サービス。 データタイプ:オブジェクトのアレイ
|
| result.standard_services.font_awesome_icon | 標準サービスに関連付けられたサムネイルアイコンの名前。 データタイプ:文字列 |
| result.standard_services.name | 標準サービスの名前。 データタイプ:文字列 |
| result.standard_services.short_description | 標準サービスの簡単な説明。 データタイプ:文字列 |
| result.standard_services.sys_id | 標準サービスレコードの sys_id。 データタイプ:文字列 テーブル:標準サービス [sn_wsd_rsv_standard_service] |
cURL 要求
次のコード例は、このエンドポイントを呼び出して標準サービス情報を含める方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get?sys_id=8e87c722870741106342b846dabb3573&include_standard_services=true" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
返される結果:
"result": {
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number": "WRES0001005",
"location": {
"sys_id": "9841e94adb7210106c731dcd13961914",
"name": "A1-02-02",
"description": "General desk available for reservation.",
"display_value": "A1-02-02",
"capacity": 1,
"label_value": "Workspace/Desk name",
"wsd_email": null,
"reservable_module": {
"sys_id": "5db44502dbb650106c731dcd13961937",
"name": "Desks",
"title": "Desks",
"inline_title": "desk",
"table": "sn_wsd_core_space"
},
"region": {
"sys_id": "3752ac8edb3650106c731dcd139619e0",
"display_value": "Americas",
"active": true
},
"site": {
"sys_id": "628eec06db7650106c731dcd139619dd",
"display_value": "North America",
"active": true
},
"campus": {
"sys_id": "82b2a0cedb3650106c731dcd139619e9",
"display_value": "California Campus",
"active": true
},
"building": {
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"active": true,
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"floor": {
"sys_id": "fc7368cedb3650106c731dcd13961902",
"display_value": "Floor 1",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"is_favorite": false,
"reservation": {
"sys_id": "bf3621de842c2110fa9b813be354f327",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"number": "WRES0001005",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001005",
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"user_name": "admin"
},
"is_private": true
},
"start": "2023-01-24T16:00:00Z",
"end": "2023-01-24T17:00:00Z",
"sys_created_on": "2023-01-24T15:49:49Z",
"sys_updated_on": "2023-01-24T15:49:50Z",
"source_reservation": null,
"check_in_state": {
"value": "awaiting_check_in",
"display_value": "Awaiting check-in"
},
"external_id": null,
"external_ical": null,
"building": {
"active": true,
"sys_id": "94e264cedb3650106c731dcd13961919",
"display_value": "CAL-B1",
"campus": {
"display_value": "California Campus",
"value": "82b2a0cedb3650106c731dcd139619e9",
"active": true
},
"site": {
"display_value": "North America",
"value": "628eec06db7650106c731dcd139619dd",
"active": true
},
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
},
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
}
],
"number_of_attendees": 1,
"is_parent": false,
"is_private": true,
"subject": "Reservation for A1-02-02",
"virtual_meeting": null,
"recording_details": [],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"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": null,
"enable_reservation_privacy": true,
"allow_invitees": "1",
"display_number_of_attendees": null,
"display_on_behalf_of": "1",
"display_sensitivity": null,
"max_days_in_future": "90",
"allow_recurring": "1",
"auto_resolve_conflict": null,
"allow_whole_day": "1",
"allow_multi_building": "1",
"require_whole_day": null,
"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_floor_search": null,
"enable_browse_by_neighborhood": null,
"require_cc_dept_check": false,
"display_value": "Desks",
"browse_near_a_person_enabled": true,
"browse_by_area_enabled": true,
"browse_by_neighborhood_enabled": false,
"reservable_columns": [
"sys_id",
"external_id",
"wsd_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": [
"03c45bf7dba41010d7981dcd1396196d",
"07c45bf7dba41010d7981dcd1396196b",
"07c45bf7dba41010d7981dcd13961972",
"0bc45bf7dba41010d7981dcd13961970",
"0fc45bf7dba41010d7981dcd1396196e",
"1aa39b1977220110b3d7be377b5a9953",
"2130659ae7321010809a268b03f6a91e",
"22c41bf7dba41010d7981dcd139619fe",
"2ac45bf7dba41010d7981dcd13961901",
"2ec41bf7dba41010d7981dcd139619ff",
"32c45bf7dba41010d7981dcd13961905",
"32c45bf7dba41010d7981dcd1396190c",
"32c45bf7dba41010d7981dcd13961943",
"e2c41bf7dba41010d7981dcd139619fb"
],
"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",
"availableFor": true
},
{
"value": "browse_favorites",
"displayValue": "Browse favorites",
"availableFor": false
},
{
"value": "browse_near_a_person",
"displayValue": "Browse near a person",
"availableFor": true
},
{
"value": "browse_by_area",
"displayValue": "Browse by area",
"availableFor": true
}
],
"override_approval_policy": "never_required"
},
"notification_recipients": null,
"notification_custom_message": null,
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"requested_for": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "a5d3c898c3222010ae17dd981840dd8b.iix?t=small",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator, Finance"
},
"auto_conflict_resolution_state": {
"value": null,
"display_value": null
},
"parent_reservation": {},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"hasPrivateReservation": true,
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true,
"is_private": true
},
"allFields": true
},
"read": true
}
}
}
WSD Reservation - GET /api/sn_wsd_rsv/reservation/get_user_reservations
指定されたユーザーに対する今後 7 日間の予約のリストを取得します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/get_user_reservations
デフォルトの URL:/api/sn_wsd_rsv/reservation/get_user_reservations
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| userId | 予約を返すユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result | 予約の返される結果: データタイプ: オブジェクト |
| result.informEmployeePrivacy | プライベートとしてマークされた予約が返却されたときにメッセージを表示するかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.reservationsByDate | 日付別の各予約の詳細。 データタイプ:オブジェクト - 独自のアレイ内の各日付 |
| result.reservationsByDate.building | 予約可能項目がある建物。 データタイプ: オブジェクト テーブル:建物 [sn_wsd_core_building] |
| result.reservationsByDate.building.display_value | 建物の表示値。 データタイプ:文字列 |
| result.reservationsByDate.building.sys_id | 関連付けられた建物レコードの sys_id。 データタイプ:文字列 |
| result.reservationsByDate.building.timezone | 建物のタイムゾーンの詳細。 データタイプ: オブジェクト |
| result.reservationsByDate.building.timezone.display_value | 関連する建物が存在するタイムゾーンの表示値。 データタイプ:文字列 |
| result.reservationsByDate.building.timezone.sys_id | 関連する建物が存在するタイムゾーンレコードの sys_id。 データタイプ:文字列 |
| result.reservationsByDate.building.value | 建物の内部値。 データタイプ:文字列 |
| result.reservationsByDate.floor | 予約に関連付けられているフロアの詳細。 データタイプ:オブジェクト |
| result.reservationsByDate.floor.displayValue | 予約可能項目が存在するフロアの階数を表示します (12 など)。 データタイプ:文字列 |
| result.reservationsByDate.floor.value | 予約が存在するフロアの内部値。 データタイプ:文字列 |
| result.reservationsByDate.location | 予約の場所の詳細。 データタイプ:オブジェクト |
| result.reservationsByDate.location.displayValue | South Parks などの場所の表示値。 データタイプ:文字列 |
| result.reservationsByDate.location.type | 職場/デスク、カフェ、ジムなど、場所のタイプ。 データタイプ:文字列 |
| result.reservationsByDate.location.value | south_parks など、場所の内部値。 データタイプ:文字列 |
| result.searchEndDate | 予約検索の終了日。開始日から 7 日間。 形式:yyyy-mm-dd データタイプ:文字列 |
| result.searchStartDate | 予約検索の開始日。エンドポイントが呼び出された日付。 形式:yyyy-mm-dd データタイプ:文字列 |
| result.sortedReservationDates | 指定されたユーザーが今後 7 日間で予約している日付 (日付順にソート)。 データタイプ:アレイ |
| result.workplaceProfile | ユーザー職場プロファイル。指定されたユーザーが働いている場所について説明します。 データタイプ:オブジェクト |
| result.workplaceProfile.building | ユーザーが働いている建物。 データタイプ: オブジェクト テーブル:建物 [sn_wsd_core_building] |
| result.workplaceProfile.building.display_value | 建物の表示値。 データタイプ:文字列 |
| result.workplaceProfile.building.sys_id | 関連付けられた建物レコードの sys_id。 データタイプ:文字列 |
| result.workplaceProfile.building.timezone | 建物のタイムゾーンの詳細。 データタイプ: オブジェクト |
| result.workplaceProfile.building.timezone.display_value | 関連する建物が存在するタイムゾーンの表示値。 データタイプ:文字列 |
| result.workplaceProfile.building.timezone.sys_id | 関連する建物が存在するタイムゾーンレコードの sys_id。 データタイプ:文字列 |
| result.workplaceProfile.building.value | 建物の内部値。 データタイプ:文字列 |
| result.workplaceProfile.floor | ユーザーが働いているフロアの詳細。 データタイプ:オブジェクト |
| result.workplaceProfile.floor.displayValue | ユーザーが働いているフロアの階数を表示します (フロア 8 など)。 データタイプ:文字列 |
| result.workplaceProfile.floor.value | ユーザーが働いているフロアの内部値。 データタイプ:文字列 |
| result.workplaceProfile.location | ユーザーの場所の詳細。 データタイプ:オブジェクト |
| result.workplaceProfile.location.displayValue | San Diego などの場所の表示値。 データタイプ:文字列 |
| result.workplaceProfile.location.type | デスクやオフィスなど、場所のタイプ。 データタイプ:文字列 |
| result.workplaceProfile.location.value | san_diego など、場所の内部値。 データタイプ:文字列 |
cURL 要求
次のコード例は、このエンドポイントを呼び出す方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/get_user_reservations?userId=2de07e1887cb89106342b846dabb35fe" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
返される結果:
{
"result": {
"sortedReservationDates": [
"2023-01-24"
],
"workplaceProfile": {
"location": {
"displayValue": "DDC-A2.0016A",
"value": "96d3139977220110b3d7be377b5a9918",
"externalId": "0e7bddfb475a011064062782846d43c2",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 2",
"value": "68d31f5977220110b3d7be377b5a991b"
},
"building": {
"displayValue": "Building A",
"value": "dea39b1977220110b3d7be377b5a9955",
"timezone": {
"value": "Europe/Paris",
"displayValue": "Europe/Paris"
}
}
},
"reservationsByDate": {
"2023-01-24": [
{
"location": {
"displayValue": "A1-02-04",
"value": "3e41e94adb7210106c731dcd1396198c",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-02",
"value": "9841e94adb7210106c731dcd13961914",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
},
{
"location": {
"displayValue": "A1-02-03",
"value": "fd41a94adb7210106c731dcd1396195a",
"externalId": "",
"type": "Workspace/Desk"
},
"floor": {
"displayValue": "Floor 1",
"value": "fc7368cedb3650106c731dcd13961902"
},
"building": {
"displayValue": "CAL-B1",
"value": "94e264cedb3650106c731dcd13961919",
"timezone": {
"value": "US/Pacific",
"displayValue": "US/Pacific"
}
}
}
]
},
"searchStartDate": "2023-01-24",
"searchEndDate": "2023-01-31",
"informEmployeePrivacy": true
}
}
WSD Reservation - GET /api/sn_wsd_rsv/reservation/icalendar/{sys_id}
指定された予約の iCalendar ファイル本文を生成します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/icalendar/{sys_id}
デフォルトの URL:/api/sn_wsd_rsv/reservation/icalendar/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | iCalendar ファイル本文を生成する予約の sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result | 指定された予約の iCalendar ファイル本文。 データタイプ:文字列 |
cURL 要求
次のコード例は、このエンドポイントを呼び出して iCalender 本文を作成する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/icalendar/60d26a0f47578910003a4587746d4331" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
返される結果:
{
"result": "BEGIN:VCALENDAR\nPRODID:-//Service-now.com//Outlook 11.0 MIMEDIR//EN\nVERSION:2.0\nMETHOD:REQUEST\nBEGIN:VEVENT\nATTENDEE;ROLE=REQ-PARTICIPANT;RSVP=TRUE:MAILTO:workplace_user@example.com\nDTSTART:20220521T050000Z\nDTEND:20220521T060000Z\nUID:60d26a0f47578910003a4587746d4331\nDTSTAMP:20220511T044018Z\nSUMMARY:For user 1\nDESCRIPTION:Dear System Administrator,\\n\\nThank you for your reservation.\\n\\nYou can find more details on your reservation, or manage your reservation using the following link: https://damay2.service-now.com/ws?id=wsd_reservation_summary&reservation_id=60d26a0f47578910003a4587746d4331\\n\\nKind regards,\\nWorkplace Services Team\nLOCATION:Berlin\nCLASS:PUBLIC\nORGANIZER;CN=Workplace User:MAILTO:workplace_user@example.com\nATTENDEE;ROLE=REQ-PARTICIPANT;CN=Workplace User:RSVP=TRUE:MAILTO:workplace_user@example.com\nEND:VEVENT\nEND:VCALENDAR"
}
WSD Reservation - GET /api/sn_wsd_rsv/reservation/list
指定されたユーザーに属する予約のリストを取得します。
このエンドポイントは、指定されたユーザーによって要求または作成された予約のみを返します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/list
デフォルトの URL:/api/sn_wsd_rsv/reservation/list
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| encodedQuery | 返された予約レコードの結果をフィルタリングするために使用するエンコードされたクエリ。職場予約 [sn_wsd_rsv_reservation] テーブル内のすべてのフィールドは、クエリ内で有効です。 例: データタイプ:文字列 |
| endIndex | ページネーションのインデックスを指定するときに返される結果セットの最後の予約レコード。返される結果レコードの利用可能な数よりこの値が大きい場合は、残りのすべてのレコードが返されます。 データタイプ:数値 |
| orderByEndDesc | 返される結果を開始時間の降順で返すかどうかを示すフラグ。 有効な値:
デフォルト値:false |
| searchCriteria | 返される結果に含めるために、予約内で一致する必要があるテキスト。エンドポイントは、次のフィールドでこの値をチェックします。
データタイプ:文字列 |
| startIndex | レコードを返す開始レコード (ゼロベース)。このパラメーターを使用して、大きなレコードセットをページネーションします。 データタイプ:文字列 デフォルト:0 |
| userId | 返された予約情報から除外するユーザーの sys_id。 この値が渡されると、[requested_for] フィールドまたは [opened_by] フィールドが現在ログインしているユーザーと等しい予約がエンドポイントによって除外されます。その予約リストから、渡された userId と requested_for または opened_by が等しい予約を除外します。 データタイプ:文字列 デフォルト:[requested_for] フィールドまたは [opened_by] フィールドが現在ログインしているユーザーと等しいすべての予約を返します。 テーブル: ユーザー [sys_user] |
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result.reservation | 予約の詳細。 データタイプ:オブジェクト |
| result.reservation.active | 予約がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.attendees | 予約の出席者のリスト。 データタイプ:オブジェクトのアレイ |
| result.reservation.attendees.avatar | 出席者に関連付けられたアバターの sys_id。 データタイプ:文字列 テーブル:添付ファイル [sys_attachment] |
| result.reservation.attendees.displayValue | 出席者の表示値。 データタイプ:文字列 |
| result.reservation.attendees.display_value | 出席者の表示値。displayValue と同じです。 データタイプ:文字列 |
| result.reservation.attendees.email | 出席者のメールアドレス。 データタイプ:文字列 |
| result.reservation.attendees.initials | 出席者のイニシャル。 データタイプ:文字列 |
| result.reservation.attendees.name | 出席者の名前。 データタイプ:文字列 |
| result.reservation.attendees.sys_id | 出席者レコードのSys_id。 データタイプ:文字列 |
| result.reservation.attendees.table | 出席者レコードが存在するテーブル。 データタイプ:文字列 |
| result.reservation.attendees.user_name | 出席者のユーザー名。 データタイプ:文字列 |
| result.reservation.attendees.value | 出席者の内部値。 データタイプ:文字列 |
| result.reservation.check_in_state | 予約のチェックインステータスに関する詳細。 データタイプ:オブジェクト |
| result.reservation.check_in_state.display_value | 予約の現在のチェックインステータスの表示値 (処理中、完了など)。 データタイプ:文字列 |
| result.reservation.check_in_state.value | 予約の現在のチェックインステータスの内部値 (2 など)。 データタイプ:文字列 |
| result.reservation.edit_restriction | 予約のユーザー編集制限の説明 (no_restrictions、service_only、full_restricted など)。 データタイプ:オブジェクト |
| result.reservation.edit_restriction.display_value | 予約の編集制限の表示値 ([制限なし] など)。 データタイプ:文字列 |
| result.reservation.edit_restriction.value | 予約の編集制限の内部値 (no_restriction など)。 データタイプ:文字列 |
| result.reservation.end | 予約の終了日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (2021-02-05T18:00:00Z など) |
| result.reservation.external_ical | 予約の一意の外部 iCalendar ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。 データタイプ:文字列 |
| result.reservation.external_id | 予約の一意の外部 ID。これがカレンダー同期関連の予約である場合は、この値を使用して予約を識別します。 データタイプ:文字列 |
| result.reservation.is_parent | この予約が親予約かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.reservation.is_private | 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外の誰にも表示されません。 これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト:システムプロパティでプライバシーに設定された値。 |
| result.reservation.last_updated_sub_source | 予約の最後に更新されたサブソースに関する詳細。サブソースは、予約を外部カレンダーと統合するときに使用されます。このオブジェクトには、「servicenow_workplace_service_delivery」、「google_calendar」、「microsoft_exchange」などの情報が含まれています。 データタイプ:オブジェクト |
| result.reservation.last_updated_sub_source.display_value | ServiceNow Workplace Service Delivery や Google カレンダーなど、予約の最後に更新されたサブソースの表示値。予約を Google カレンダーや Microsoft Outlook などの外部サービスと統合するときに使用されます。 データタイプ:文字列 |
| result.reservation.last_updated_sub_source.value | servicenow_workplace_service_delivery や google_calendar など、予約の最後に更新されたサブソースの内部値。予約を Google カレンダーや Microsoft Outlook などの外部サービスと統合するときに使用されます。 データタイプ:文字列 |
| result.reservation.location | 予約に関連付けられた場所の詳細。 データタイプ:オブジェクト |
| result.reservation.location.area | 場所に関連付けられたエリアに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.area.active | エリアがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.area.display_value | Desk A2 など、この場所が属するエリアの表示値。 データタイプ:文字列 |
| result.reservation.location.area.sys_id | この場所が属するエリアの sys_id。 データタイプ:文字列 テーブル:エリア [sn_wsd_core_area] |
| result.reservation.location.building | 場所に関連付けられた建物に関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.building.active | 建物がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.building.display_value | AMS - Bld1 など、この場所が属する建物の表示値。 データタイプ:文字列 |
| result.reservation.location.building.sys_id | この場所が属する建物の sys_id。 データタイプ:文字列 テーブル:建物 [sn_wsd_core_building] |
| result.reservation.location.building.timezone | 場所に関連付けられたタイムゾーンに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.building.timezone.display_value | この場所が属するタイムゾーンの表示値。 データタイプ:文字列 |
| result.reservation.location.building.timezone.value | この場所が属するタイムゾーンの内部値。 データタイプ:文字列 |
| result.reservation.location.campus | 場所に関連付けられた敷地に関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.campus.active | 敷地がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.campus.display_value | Amsterdam Campus など、この場所が属する敷地の表示値。 データタイプ:文字列 |
| result.reservation.location.campus.sys_id | この場所が属する敷地の sys_id。 データタイプ:文字列 テーブル:敷地 [sn_wsd_core_campus] |
| result.reservation.location.capacity | 場所の参加者の最大人数。 データタイプ:数値 |
| result.reservation.location.description | 場所の簡単な説明。 データタイプ:文字列 |
| result.reservation.location.display_value | この場所の UI に表示する値。 データタイプ:文字列 |
| result.reservation.location.email | 場所のメールアドレス。 データタイプ:文字列 |
| result.reservation.location.floor | 場所に関連付けられたフロアに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.floor.active | フロアがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.floor.display_value | First floor など、この場所が属するフロアの表示値。 データタイプ:文字列 |
| result.reservation.location.floor.sys_id | この場所が属するフロアの sys_id。 データタイプ:文字列 テーブル:フロア [sn_wsd_core_floor] |
| result.reservation.location.label_value | name パラメーターで指定された値のタイプ (部屋名など)。 データタイプ:文字列 |
| result.reservation.location.name | 場所の名前。 データタイプ:文字列 |
| result.reservation.location.number | 予約番号。 データタイプ:文字列 |
| result.reservation.location.number_of_attendees | 予約の出席者の数。 データタイプ:数値 |
| result.reservation.location.region | 場所に関連付けられたリージョンに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.region.active | リージョンがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.region.display_value | Europe など、この場所が属するリージョンの表示値。 データタイプ:文字列 |
| result.reservation.location.region.sys_id | この場所が属するリージョンの sys_id。 データタイプ:文字列 テーブル:リージョン [sn_wsd_core_region] |
| result.reservation.location.requested_for | 代理で予約が要求されたユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.location.requested_for.name | 予約が要求されたユーザーの名前。 データタイプ:文字列 |
| result.reservation.location.requested_for.sys_id | 予約が要求されているユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.location.requested_for.user_name | 予約が要求されたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.location.reservation | 場所に関連付けられた予約の詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservation.active | 予約がアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.reservation.number | 予約番号。 データタイプ:文字列 |
| result.reservation.location.reservation.number_of_attendees | 予約の出席者の数。 データタイプ:数値 |
| result.reservation.location.reservation.requested_for | 代理で予約が要求されたユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservation.requested_for.name | 予約が要求されたユーザーの名前。 データタイプ:文字列 |
| result.reservation.location.reservation.requested_for.sys_id | 要求されたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.location.reservation.requested_for.user_name | 予約が要求されたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.location.reservable_module | 予約に関連付けられている予約可能モジュールに関する詳細。 データタイプ:オブジェクト |
| result.reservation.location.reservable_module.inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストとともインラインに表示されます。 データタイプ:文字列 |
| result.reservation.location.reservable_module.name | 予約可能モジュールの名前。 データタイプ:文字列 |
| result.reservation.location.reservable_module.sys_id | 予約可能モジュールの sys_id。 データタイプ:文字列 |
| result.reservation.location.reservable_module.title | 予約可能なモジュールのタイトル。 データタイプ:文字列 |
| result.reservation.location.site | 場所が属するサイト。 データタイプ: オブジェクト テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.site.active | サイトがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.location.site.display_value | Western Europe など、この場所が属するサイトの表示値。 データタイプ:文字列 |
| result.reservation.location.site.sys_id | この場所が属するサイトの sys_id。 データタイプ:文字列 テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.state | 場所の予約のステータスの詳細。 データタイプ:オブジェクト |
| result.reservation.location.state.display_value | 予約の現在のステータスの表示値 (確定済みなど)。 データタイプ:文字列 |
| result.reservation.location.state.value | 予約の現在のステータスの内部値 (2 など)。 データタイプ:文字列 |
| result.reservation.location.sys_id | 関連付けられた場所レコードの sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.reservation.notification_custom_message | reservation.notification_recipients にリストされている受信者に送信される通知のカスタムメッセージ。 データタイプ:文字列 |
| result.reservation.notification_recipients | 予約に関する通知を受信する受信者のリスト。 データタイプ:オブジェクトのアレイ |
| result.reservation.notification_recipients.name | 受信者の名前。 データタイプ:文字列 |
| result.reservation.notification_recipients.sys_id | 受信者の sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.notification_recipients.user_name | 受信者のユーザー名。 データタイプ:文字列 |
| result.reservation.number | 予約レコードの一意の番号。この値を使用して予約を照会できます。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| result.reservation.opened_by | 予約を作成したユーザーの詳細。 データタイプ:オブジェクト |
| result.reservation.opened_by.avatar | 予約をオープンしたユーザーのアバター。 データタイプ:文字列 |
| result.reservation.opened_by.displayValue | オープンしたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.opened_by.display_value | オープンしたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.opened_by.email | 予約をオープンしたユーザーのメールアドレス。 データタイプ:文字列 |
| result.reservation.opened_by.initials | 予約をオープンしたユーザーのイニシャル。 データタイプ:文字列 |
| result.reservation.opened_by.label | 予約をオープンしたユーザーのラベル。これは、ユーザーの役職と部門の組み合わせです。 データタイプ:文字列 |
| result.reservation.opened_by.name | 予約をオープンしたユーザーの名前。 データタイプ:文字列 |
| result.rservation.opened_by.sys_id | 予約をオープンしたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.rservation.opened_by.table | ユーザーレコードを含むテーブル。 データタイプ:文字列 |
| result.reservation.opened_by.user_name | 予約をオープンしたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.opened_by.value | 予約をオープンしたユーザーの内部値。 データタイプ:文字列 |
| result.reservation.number | 予約番号。 データタイプ:文字列 |
| result.reservation.number_of_attendees | この予約の出席者の数。 データタイプ:数値 |
| result.reservation.recording_details | 予約 (会議) に関連付けられている記録に関する詳細。 データタイプ:オブジェクトのアレイ |
| result.reservation.recording_details.recording_url | 予約に関連付けられている記録の URL。 データタイプ:文字列 |
| result.reservation.requested_for | 予約が代理で行われたユーザーに関する詳細。 データタイプ:オブジェクト |
| result.reservation.requested_for.avatar | 予約が代理で行われたユーザーのアバター。 データタイプ:文字列 |
| result.reservation.requested_for.displayValue | 予約が代理で行われたユーザーの表示値。 データタイプ:文字列 |
| result.reservation.requested_for.display_value | 予約が代理で行われたユーザーの表示値。displayValue と同じです。 データタイプ:文字列 |
| result.reservation.requested_for.email | 予約が代理で行われたユーザーのメールアドレス。 データタイプ:文字列 |
| result.reservation.requested_for.initials | 予約が代理で行われたユーザーのイニシャル。 データタイプ:文字列 |
| result.reservation.requested_for.label | 予約が代理で行われたユーザーのラベル。 データタイプ:文字列 |
| result.reservation.requested_for.name | 予約が代理で行われたユーザーの名前。 データタイプ:文字列 |
| result.rservation.requested_for.sys_id | 予約が代理で行われたユーザーの sys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.rservation.requested_for.table | ユーザーレコードを含むテーブル。 データタイプ:文字列 |
| result.reservation.requested_for.user_name | 予約が代理で行われたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.requested_for.value | 予約が代理で行われたユーザーの内部値。 データタイプ:文字列 |
| result.reservation.reservable_module | 要求された予約可能モジュールの詳細。 データタイプ:オブジェクト |
| result.reservation.reservable_module.allow_invitees | 従業員が招待者を予約に追加できるどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.allow_whole_day | ユーザーが予約可能項目を終日予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.apply_to_shift | 予約可能モジュールに対してシフトベースの予約が有効かどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.browse_by_area_enabled | ユーザーがエリア別に予約可能モジュールを検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.browse_near_a_person_enabled | ユーザーが特定のユーザーによって配置された予約可能モジュールを検索できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.buildingSysIds | 予約可能モジュールに関連付けられた建物の sys_id のリスト。 データタイプ:文字列のアレイ |
| result.reservation.reservable_module.checkin_before_minutes | ユーザーが予約にチェックインできる予約開始前の時間。 単位:分 データタイプ:数値 |
| result.reservation.reservable_module.display_number_of_attendees | ユーザーが予約の出席者の数を指定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.display_on_behalf_of | 他のユーザーの代わりに予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.display_sensitivity | ユーザーが、normal、private などの予約の機密性を設定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.display_value | 予約可能モジュールの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.enable_browse_by_area | ユーザーがエリア別に予約可能モジュールを検索できるかどうかを示すフラグ。browse_by_area_enabled と同じです。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_browse_near_a_person | ユーザーが特定のユーザーによって配置された予約可能モジュールを検索できるかどうかを示すフラグ。 browse_near_a_person_enabled と同じです。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_facet_filter | 職場アイテムのファセットフィルタリングが有効かどうかを示すフラグ。有効にすると、表示されるフィルターオプションは検索結果に基づきます。ユーザーは、生成された検索結果で使用可能なアイテムのみをフィルターで選択できます。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.enable_group_reservations | ユーザーがグループ予約できるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.enable_ical_generation | ユーザーが予約の iCalendar を生成できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.font_awesome_icon | 予約可能モジュールに添付されているフォントアイコンの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストとともインラインに表示されます。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping | 場所のレイアウトマッピングの構造に関する詳細。このデータを使用して、UI に情報をレイアウトします。 データタイプ: オブジェクト |
| result.reservation.reservable_module.layout_mapping.body | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.layout_mapping.body.field | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.field_to_display | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.icon | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.body.label | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.description | フロントエンド UI データをマッピングするためのプレースホルダー。レイアウトマッピングの説明。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.image | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:文字列 |
| result.reservation.reservable_module.layout_mapping.subtitle | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.subtitle_asc | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.layout_mapping.title | フロントエンド UI データをマッピングするためのプレースホルダー。 データタイプ:アレイ |
| result.reservation.reservable_module.max_days_in_future | ユーザーが予約可能モジュールを予約できる、今後の最大日数。 データタイプ:数値 |
| result.reservation.reservable_module.max_occurrences | 予約可能モジュールの繰り返し予約が利用可能な場合の繰り返し予約の最大発生回数。 データタイプ:数値 |
| result.reservation.reservable_module.name | 予約可能モジュールの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.override_approval_policy | 承認ポリシーの実装方法を指定するオプション。 Choices (選択肢):
データタイプ:文字列 |
| result.reservation.reservable_module.require_cancel_notes | 予約可能モジュールをキャンセルする前にユーザーがキャンセルメモを入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブール |
| result.reservation.reservable_module.require_cc_dept_check | ワークスペースアイテムとログインユーザーの間にコストセンターまたは部門の不一致があるかどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.require_subject | 予約時にユーザーが件名を入力する必要があるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.reservable_columns | 予約可能項目の列のリスト。 データタイプ:アレイ テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.reservation.reservable_module.reservable_container_field | 特定のエリアのデスクのグループなどのコンテナーのレベル。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_filter | 関連付けられた予約可能テーブルの予約可能アイテムのフィルタリングに使用されるフィルター条件。予約可能テーブルは、予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブル内のフィールドです。これらのフィルター条件は、フィールドの予約可能テーブルに含まれるテーブルに適用されました。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_quantity_field | すべてのスペースの予約可能な数量。数は、エリアに近隣スペースをアサインするときに使用されます。詳細については、「 エリアへの近隣スペースの割り当て」を参照してください。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_table | 予約可能な職場アイテムを含むテーブル。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_type | 予約可能アイテムのタイプ (場所など)。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views | カードビューやスケジュールビューなど、予約可能モジュールに関連付けられたさまざまなビューに関する詳細。 データタイプ: オブジェクト テーブル:予約可能なビュー [sn_wsd_rsv_reservable_view] |
| result.reservation.reservable_module.reservable_views.iconClass | 予約可能なビューのアイコンクラス。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views.isDefault | この予約可能なビューを予約可能なモジュールのデフォルトにするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.reservable_views.label | 予約可能なビューの名前。 データタイプ:文字列 |
| result.reservation.reservable_module.reservable_views.order | UI の予約可能モジュールのビューが表示される順序。UI では小さい順序番号が先に表示されます。同じ順序番号の場合は、ランダムな順序が割り当てられます。 データタイプ:数値 |
| result.reservation.reservable_module.reservable_views.type | 予約可能なビューのバックエンド名。内部処理に使用されます。 データタイプ:文字列 |
| result.reservation.reservable_module.reservation_paths | [すべて参照]、 [人の近くで参照する] などの予約可能なモジュールに関連付けられた予約パス。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.reservation_paths.display_value | [人の近くで参照する] などの予約パスの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.reservation_paths.value | 「browse_near_a_person」などの予約パスの内部値。 データタイプ:文字列 |
| result.reservation.reservable_module.search_limit | ユーザーが職場の場所を検索するときに返される検索結果の最大数。 データタイプ:数値 |
| result.reservation.reservable_module.selection_type | 検索結果に表示する選択のタイプ。 次のいずれかのオプションを指定できます。
データタイプ:文字列 |
| result.reservation.reservable_module.short_description | 予約可能なモジュールの簡単な説明。 データタイプ:文字列 |
| result.reservation.reservable_module.show_map_view | この予約可能なモジュールのマップビューを有効にするかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservable_module.sys_id | 予約可能モジュールの sys_id。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots | 予約可能モジュールに関連付けられたタイムスロットの詳細。 データタイプ:オブジェクトのアレイ |
| result.reservation.reservable_module.timeSlots.name | タイムスロットの名前 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.short_description | タイムスロットの簡単な説明。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.slot_end | タイムスロットの終了時間 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.slot_start | スロットの開始時間。 データタイプ:文字列 |
| result.reservation.reservable_module.timeSlots.sys_id | タイムスロットレコードの sys_id。 データタイプ:文字列 テーブル:タイムスロット [sn_wsd_rsv_time_slot] |
| result.reservation.reservable_module.title | 予約可能なモジュールのタイトル。 データタイプ:文字列 |
| result.reservation.reservable_module.virtual_meeting_provider | 予約可能モジュールに関連付けられている仮想プロバイダーの詳細。 データタイプ:オブジェクト |
| result.reservation.reservable_module.virtual_meeting_provider.display_value | バーチャル会議プロバイダーの表示値。 データタイプ:文字列 |
| result.reservation.reservable_module.virtual_meeting_provider.sys_id | バーチャル会議プロバイダーの sys_id。 データタイプ:文字列 |
| result.reservation.reservationAcl | 関連する予約に設定されているユーザーアクセス制御レベル (ACL) チェックの詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.read | ユーザーがこの予約を読み取り可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write | 関連付けられている予約のユーザーの書き込み機能に関する詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.write.allFields | ユーザーが reservationACL.write.fields オブジェクトで指定されたすべてのフィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。ユーザーが一部の特定のフィールドにのみアクセスできる場合は、それらのフィールドのみが reservationACL.write.fields オブジェクトで true になります。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields | 予約のさまざまなフィールドに対するアクセス制御の詳細。 データタイプ:オブジェクト |
| result.reservation.reservationAcl.write.fields.location | ユーザーがこの予約の場所フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.number_of_attendees | ユーザーがこの予約の出席者の数フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.requested_for | ユーザーがこの予約の要求元フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.sensitivity | ユーザーがこの予約の機密フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.fields.subject | ユーザーがこの予約の件名フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservationAcl.write.record | ユーザーが予約レコード全体に書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.reservation_purpose | 予約の目的の詳細。 データタイプ:オブジェクト |
| result.reservation.reservation_purpose.display_value | 会社の会議などの予約の目的の表示値。 データタイプ:文字列 |
| result.reservation.reservation_purpose.value | company_meeting などの予約の目的の内部値。 データタイプ:文字列 |
| result.reservation.reservation_type | 予約のタイプの詳細。 データタイプ:オブジェクト |
| result.reservation.reservation_type.display_value | スペースなどの予約のタイプの表示値。 データタイプ:文字列 |
| result.reservation.reservation_type.value | space などの予約のタイプの内部値。 データタイプ:文字列 |
| result.reservation.reservation_subtype | 予約のサブタイプの詳細。サブタイプは、単一、複数の親、複数の子、繰り返し発生する親、発生件数などの予約のタイプを示します。 データタイプ:オブジェクト |
| result.reservation.reservation_subtype.display_value | 単一などの予約のサブタイプの表示値。 データタイプ:文字列 |
| result.reservation.reservation_subtype.value | single などの予約のサブタイプの内部値。 データタイプ:文字列 |
| result.reservation.sensitivity | 予約の機密性の詳細。 データタイプ:オブジェクト |
| result.reservation.sensitivity.display_value | 高、低などの予約の機密性の表示値。 データタイプ:文字列 |
| result.reservation.sensitivity.value | 1、3 などの予約の機密性の内部値。 データタイプ:文字列 |
| result.reservation.shift | 予約に適用されるシフトの詳細。 データタイプ:オブジェクト |
| result.reservation.shift.display_value | シフトの表示値。 データタイプ:文字列 |
| result.reservation.shift.name | シフトの名前。display_value と同じです。 データタイプ:文字列 |
| Result.reservation.shift.shiftDetails | シフトの詳細。 データタイプ:文字列 |
| result.reservation.shift.sys_id | シフトレコードの sys_id。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| result.reservation.source | 職場サービスや Google メールなどの予約のソースに関する詳細。 データタイプ:オブジェクト |
| result.reservation.source.display_value | 職場サービスなど予約ソースの表示値。 データタイプ:文字列 |
| result.reservation.source.value | servicenow など予約ソースの内部値。 データタイプ:文字列 |
| result.reservation.source_icon | 予約で使用されるアイコンのソースの詳細。このアイコンは UI で使用されます。 データタイプ:オブジェクト |
| result.reservation.source_icon.classNames | ソースアイコンのカンマ区切りのクラス名。 データタイプ:文字列 |
| result.reservation.source_icon.imgSrc | ソースアイコンの画像ソースの名前。このアイコンは画像 [db_image] テーブルに保存されます。 データタイプ:文字列 |
| result.reservation.source_icon.tooltip | ソースアイコンに関連付けられたツールヒント。 データタイプ:文字列 |
| result.reservation.source_reservation | 現在の予約のソース予約。 たとえば、複数の予約の場合、親予約が子予約のソースになります。 データタイプ:文字列 |
| result.reservation.start | 予約の開始日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (2021-02-05T18:00:00Z など) |
| result.reservation.subject | 予約の件名。 データタイプ:文字列 |
| result.reservation.sub_source | 予約のサブソースの詳細。サブソースは、Google カレンダーや Microsoft Exchange などの予約の作成元を指定します。 データタイプ:オブジェクト |
| result.reservation.sub_source.display_value | Google カレンダーなどの予約のサブソースの表示値。 データタイプ:文字列 |
| result.reservation.sub_source.value | google_calendar などの予約のサブソースフィールドの内部値。 データタイプ:文字列 |
| result.reservation.sync_state | 「sync_enqueued」や「synchronized」など、別のサービスからの予約の同期ステータスに関する詳細。 データタイプ:オブジェクト |
| result.reservation.sync_state.display_value | 同期済みなど予約の現在の同期ステータスの表示値。 データタイプ:文字列 |
| result.reservation.sync_state.value | synchronized など予約の現在の同期ステータスの内部値。 データタイプ:文字列 |
| result.reservation.sys_created_on | 予約が作成された日時。 データタイプ:文字列 |
| result.reservation.sys_id | 必須です。 予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| Result.reservation.sys_updated_on | 予約が最後に更新された日時。 データタイプ:文字列 |
| result.reservation.virtual_meeting | バーチャル会議リンクの URL。 データタイプ:文字列 |
| result.reservationAcl | 関連する予約に設定されているユーザーアクセス制御レベル (ACL) チェックの詳細。 データタイプ:オブジェクト |
| result.reservationAcl.read | ユーザーがこの予約を読み取り可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write | 関連付けられている予約のユーザーの書き込み機能に関する詳細。 データタイプ:オブジェクト |
| result.reservationAcl.write.allFields | ユーザーが reservationACL.write.fields オブジェクトで指定されたすべてのフィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。ユーザーが一部の特定のフィールドにのみアクセスできる場合は、それらのフィールドのみが reservationACL.write.fields オブジェクトで true になります。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields | 予約のさまざまなフィールドに対するアクセス制御の詳細。 データタイプ:オブジェクト |
| result.reservationAcl.write.fields.location | ユーザーがこの予約の場所フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.number_of_attendees | ユーザーがこの予約の出席者の数フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.requested_for | ユーザーがこの予約の要求元フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.sensitivity | ユーザーがこの予約の機密フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.write.fields.subject | ユーザーがこの予約の件名フィールドに書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservationAcl.record | ユーザーが予約レコード全体に書き込み可能かどうかを確認するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.standard_services | include_standard_services パラメーターが true に設定されている場合にのみ入力されます。 フリップチャート、プロジェクタースクリーン、ホワイトボードとマーカーなどの関連する標準サービス。 データタイプ:オブジェクトのアレイ
|
| result.standard_services.font_awesome_icon | 標準サービスに関連付けられたサムネイルアイコンの名前。 データタイプ:文字列 |
| result.standard_services.name | 標準サービスの名前。 データタイプ:文字列 |
| result.standard_services.short_description | 標準サービスの簡単な説明。 データタイプ:文字列 |
| result.standard_services.sys_id | 標準サービスレコードの sys_id。 データタイプ:文字列 テーブル:標準サービス [sn_wsd_rsv_standard_service] |
cURL 要求
このコード例は、このエンドポイントを呼び出して、指定されたユーザーに関連付けられた予約のリストを取得する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/list" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
返される結果:
{
"result": {
"reservations": [
{
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number": "WRES0001010",
"location": {
"sys_id": "02000d4edb7650106c731dcd13961914",
"name": "Eureka",
"description": "A comfortable meeting room with leather chairs and a wooden table. Client meeting room.",
"display_value": "Eureka",
"capacity": 12,
"label_value": "Room name",
"email": "eureka@example.com",
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room"
},
"region": {
"sys_id": "2d626c4edb3650106c731dcd1396194b",
"display_value": "Europe",
"active": true
},
"site": {
"sys_id": "b17220cedb3650106c731dcd1396197a",
"display_value": "Western Europe",
"active": true
},
"campus": {
"sys_id": "44d2e0cedb3650106c731dcd13961988",
"display_value": "Amsterdam Campus",
"active": true
},
"building": {
"sys_id": "9e0364cedb3650106c731dcd1396192b",
"display_value": "AMS-B1",
"active": true,
"timezone": {
"value": "Europe/Amsterdam",
"displayValue": "Europe/Amsterdam"
}
},
"floor": {
"sys_id": "5373a8cedb3650106c731dcd1396198a",
"display_value": "Floor 3",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"reservation": {
"sys_id": "12e2da5e87c701106342b846dabb354d",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
},
"number": "WRES0001010",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001010",
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
}
},
"start": "2022-05-15T16:00:00Z",
"end": "2022-05-15T17:00:00Z",
"sys_created_on": "2022-04-26T09:19:37Z",
"sys_updated_on": "2022-04-26T09:20:04Z",
"source_reservation": null,
"check_in_state": {
"value": "not_required",
"display_value": "Not required"
},
"external_id": null,
"external_ical": null,
"active": true,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"sensitivity": {
"value": "normal",
"display_value": "Normal"
},
"reservation_type": {
"value": "space",
"display_value": "Space"
},
"reservation_subtype": {
"value": "single",
"display_value": "Single"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": [
{
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
}
],
"number_of_attendees": 1,
"is_parent": false,
"subject": "Add rsv_1",
"virtual_meeting": "https://samplemeetingurl.com",
"recording_details": [
{
"recording_url": "https://samplerecordingurl.com"
}
],
"sync_state": {
"value": "not_required",
"display_value": "Synchronization not required"
},
"sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"last_updated_sub_source": {
"value": "servicenow_workplace_service_delivery",
"display_value": "ServiceNow Workplace Service Delivery"
},
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room",
"font_awesome_icon": "fa-building",
"reservable_table": "sn_wsd_core_room",
"reservable_filter": "active=true^is_reservable=true^building!=6c0364cedb3650106c731dcd13961927^building.is_reservable=true^floor.is_reservable=true^EQ",
"short_description": "Reserve a meeting room",
"reservable_type": "location",
"require_subject": "1",
"require_cancel_notes": true,
"virtual_meeting_provider": {
"sys_id": "e33d9e6853c201103cf7ddeeff7b1205",
"display_value": "Template"
},
"allow_invitees": "1",
"display_number_of_attendees": "1",
"display_on_behalf_of": "1",
"display_sensitivity": "1",
"max_days_in_future": "180",
"allow_whole_day": "1",
"selection_type": "unit",
"reservable_container_field": null,
"reservable_quantity_field": null,
"apply_to_shift": null,
"max_occurrences": "180",
"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",
"display_value": "Meeting rooms",
"browse_near_a_person_enabled": true,
"browse_by_area_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"
}
],
"buildingSysIds": [
"4703a4cedb3650106c731dcd13961945",
"6c0364cedb3650106c731dcd13961927",
"94e264cedb3650106c731dcd13961919",
"9e0364cedb3650106c731dcd1396192b"
],
"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"
},
"notification_recipients": [
{
"sys_id": "7016f79cc0a8016401c5a33be04be441",
"name": "workplace user",
"user_name": "workplace.user"
}
],
"notification_custom_message": "Demo notification message",
"opened_by": {
"sys_id": "6816f79cc0a8016401c5a33be04be441",
"value": "6816f79cc0a8016401c5a33be04be441",
"displayValue": "System Administrator",
"display_value": "System Administrator",
"name": "System Administrator",
"user_name": "admin",
"table": "sys_user",
"avatar": "eb513744c3222010ae17dd981840dd97",
"initials": "SA",
"email": "admin@example.com",
"label": "System Administrator"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": "d3513744c3222010ae17dd981840dd97",
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
},
"edit_restriction": {
"value": "no_restriction",
"display_value": "No restriction"
},
"source": {
"value": "servicenow",
"display_value": "Workplace Services"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": {
"sys_id": "e5d23acfdb42a01097acc9003996193a",
"name": "Test shift AMS-B1",
"display_value": "Test shift AMS-B1",
"shiftDetails": "8-5 weekdays excluding holidays\n - Monday-Friday 8-5"
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
}
]
}
}
WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/cancel/{sys_id}
指定された職場予約をキャンセルします。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/cancel/{sys_id}
デフォルトの URL:/api/sn_wsd_rsv/reservation/cancel/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | キャンセルする予約の sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| cancel_notes | 予約をキャンセルする理由 データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| sys_id | キャンセルされた予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
cURL 要求
次のコード例は、このエンドポイントを使用して予約をキャンセルする方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/cancel/12e2da5e87c701106342b846dabb354d" \
--request PATCH \
--header "Accept:application/json" \
--user ‘username’:’password’
返される結果:
"result": {
"sys_id": "73c316d2474b0150003a4587746d4337"
}
WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/share_details/{sys_id}
予約の詳細を更新し、メール通知を使用して指定された受信者リストを共有します。オプションで、予約とともに指定されたメッセージを送信できます。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/share_details/{sys_id}
デフォルトの URL:/api/sn_wsd_rsv/reservation/share_details/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | データタイプ:文字列 |
| sys_id | 共有する予約の sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| notification_custom_message | 指定された受信者に送信するメッセージ。 データタイプ:文字列 |
| notification_recipients | 必須。メール通知を送信するユーザーの sys_id のリスト。 データタイプ:アレイ テーブル: ユーザー [sys_user] |
| notification_type | 送信する通知のタイプ。 有効なタイプ:
データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| sys_id | 共有された予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
cURL 要求
次のコード例は、このエンドポイントを使用して予約を共有する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/share_details/60d26a0f47578910003a4587746d4331" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"notification_recipients\": [\"5dfb9fcf47d78910003a4587746d4367\"],
\"notification_type\":\"reservation_updated\",
\"notification_custom_message\": \"Please join our design brainstorming meeting!\"
}" \
--user "username":"password"
返される結果:
"result": {
"sys_id": "60d26a0f47578910003a4587746d4331"
}
WSD Reservation - PATCH /api/sn_wsd_rsv/reservation/update/{sys_id}
指定された職場予約を更新します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/update/{sys_id}
デフォルトの URL:/api/sn_wsd_rsv/reservation/update/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | 変更する予約の sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| ignore_same_day_validation | 予約検索で開始パラメーターと終了パラメーターの間の日付変更の検証を無視するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| 名前 | 説明 |
|---|---|
| 終了 | shiftパラメーターが渡されない場合は必須です。予約の要求された終了時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
| は_プライベート | 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外の誰にも表示されません。 これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト:システムプロパティでプライバシーに設定された値。 |
| 場所 | 必須です。 予約する場所の sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| requested_for | 予約対象のユーザーの sys_id またはメールアドレス。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| シフト | 予約に関連付けるシフトの sys_id。このパラメーターが渡される場合、 end パラメーターは必要ありません。 シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| 開始 | 必須です。予約の要求された開始時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
| subject | 必須です。 予約に関連付けられた会議の件名。 データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | 更新された予約の詳細。 データタイプ:オブジェクト |
| result.location_id | 予約場所レコードの sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| result.sys_id | 変更された予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| result.type_of_change | 予約で更新された情報のタイプ。 データタイプ:文字列 |
cURL 要求
次のコード例は、このエンドポイントを使用して予約を更新する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/update/b537abc947db4510003a4587746d4351" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"subject\": \"Rsv Update_1\",
\"start\": \"2022-07-21 14:00:00\",
\"end\": \"2022-07-21 15:00:00\",
\"requested_for\": \"workplace_user@example.com\",
\"workplace_location\": \"fe1f744edb7650106c731dcd139619ca\",
\"is_private\": \false\
}" \
--user "username":"password"
返される結果:
{
"result": {
"sys_id": "b537abc947db4510003a4587746d4351",
"location_id": "fe1f744edb7650106c731dcd139619ca",
"type_of_change": "location"
}
}
WSD Reservation - POST /api/sn_wsd_rsv/reservation/add
新しい職場予約を作成します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/add
デフォルトの URL:/api/sn_wsd_rsv/reservation/add
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| ignore_same_day_validation | 予約検索で開始パラメーターと終了パラメーターの間の日付変更の検証を無視するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| timezone | 要求の検証を実行するための優先タイムゾーン。例:ヨーロッパ/アムステルダム。この検証では、開始時間と終了時間が同じ日付かどうかを確認します。 データタイプ:文字列 デフォルト:ユーザーのタイムゾーン |
| 名前 | 説明 |
|---|---|
| 終了 | shiftパラメーターが渡されない場合は必須です。予約の要求された終了時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
| は_プライベート | 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外の誰にも表示されません。 これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト:システムプロパティでプライバシーに設定された値。 |
| 場所 | 必須です。 予約する場所の sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| requested_for | 予約対象のユーザーの sys_id またはメールアドレス。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| reservable_module | 必須です。予約に関連付ける予約可能モジュールの sys_id。予約可能なモジュールは、予約に必要な職場アイテムを定義します。 データタイプ:文字列 テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module] |
| シフト | 予約に関連付けるシフトの sys_id。このパラメーターが渡される場合、 end パラメーターは必要ありません。 シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| 開始 | 必須です。予約の要求された開始時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
| subject | 必須です。 予約に関連付けられた会議の件名。 データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| sys_id | 作成された予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
cURL 要求
次のコード例は、このエンドポイントを使用して予約を作成する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/add" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservable_module\": \"c31241cedb7650106c731dcd13961917\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"location\": \"5eafb44edb7650106c731dcd13961943\",
\"is_private\": false,
\"start\": \"2023-01-12T11:00:00Z\",
\"end\": \"2023-01-12T12:00:00Z\"
}" \
--user "username":"password"
返される結果:
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}
WSD Reservation - POST /api/sn_wsd_rsv/reservation/quick_reserve
クイック予約を使用して新しい職場予約を作成します。
URL 形式
バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/reservation/quick_reserve
デフォルトの URL:/api/sn_wsd_rsv/reservation/quick_reserve
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| 終了 | shiftパラメーターが渡されない場合は必須です。予約の要求された終了時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
| ignore_same_day_validation | 必須。エンドポイントが start パラメーターと end パラメーター間の日付変更の検証を無視するかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| reference_location_id | 必須。ユーザーが予約を希望する場所の近くにある場所の sys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| reservable_module | 必須です。予約に関連付ける予約可能モジュールの sys_id。予約可能なモジュールは、予約に必要な職場アイテムを定義します。 データタイプ:文字列 テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module] |
| シフト | 予約に関連付けるシフトの sys_id。このパラメーターが渡される場合、 end パラメーターは必要ありません。 シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| 開始 | 必須です。予約の要求された開始時間。 データタイプ:文字列 形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss) |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 要求本文のデータ形式。サポートされるタイプ:application/json、application/xml、または text/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| sys_id | 作成された予約レコードの sys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
cURL 要求
次のコード例は、クイック予約エンドポイントを使用して予約を作成する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/reservation/quick_reserve" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"start\":\"2022-05-23 16:00:00\",
\"end\": \"2022-05-23 17:00:00\",
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"reference_location_id\": \"05f5290edb7210106c731dcd13961951\",
\"ignore_same_day_validation\": \"true\"
}" \
--user "username":"password"
返される結果:
"result": {
"sys_id": "4b036a9e474b0150003a4587746d43b1"
}