WSD 繰り返し予約 API
ワークプレイスサービスデリバリ (WSD) 繰り返し予約 API は、同時に発生するが日付が異なる予約を管理するためのエンドポイントを提供します。
この API にアクセスするには、発信者に sn_wsd_core.workplace_user ロールが必要であり、ワークプレイス安全管理 (sn_wsd_core) プラグインとワークプレイス予約管理 (sn_wsd_rsv) プラグインがアクティブ化されている必要があります。
この API は sn_wsd_rsv 名前空間で実行されます。
ワークプレイス予約管理の詳細については、「ワークプレイス予約管理」を参照してください。
WSD 繰り返し予約:GET /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}
指定された繰り返し予約を返します。
予約で繰り返し発生する会議が 6 回を超える場合は、クエリパラメーターを使用して会議をページネーションできます。返さない発生レコードを指定することもできます。
URL 形式
バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/recurring_reservation/list/{parent_id}
デフォルト URL: /api/sn_wsd_rsv/recurring_reservation/list/{parent_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| parent_id | 繰り返し親予約レコードのSys_id。 繰り返し予約が作成されると、1 つの繰り返し親レコードと 1 つ以上の子予約レコードが作成されます。予約レコードには、予約レコードのタイプを示す reservation_subtype というフィールドが含まれています。繰り返し発生する親レコードの場合、このフィールドは「繰り返し発生する親」に設定されます。子レコードの場合、このフィールドは [発生件数] に設定されます。 子レコード内では、関連付けられた繰り返し親レコードのsys_idが [source_reservation] フィールドにあります。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| end_index | 繰り返しレコードセットをページネーションするときに、発生レコードの返却を停止するゼロベースのレコード番号。 注: 繰り返し発生の回数が 6 未満の場合、エンドポイントはすべての発生を返し、それ以外の場合は最初の 6 回を返します。6 件を超える発生件数を取得するには、それに応じてend_indexパラメーターを渡す必要があります。 データタイプ:数値 |
| occurrence_sys_id | 繰り返されない繰り返し系列の発生レコードのSys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| start_index | 繰り返しレコードセットをページネーションするときに、発生レコードの返却を開始する 0 ベースのレコード番号。 データタイプ:数値 デフォルト:0 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この 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.occurencesTotalCount | 繰り返し系列における会議の合計発生回数。 データタイプ:文字列 |
| 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、fully_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.last_updated_sub_source | 予約の最終更新サブソースに関する詳細。サブソースは、予約を外部カレンダーと統合するときに使用されます。このオブジェクトには、「servicenow_workplace_service_delivery」、「google_calendar」、「microsoft_exchange」などの情報が含まれています。 データタイプ: オブジェクト |
| result.reservation.last_updated_sub_source。display_value | ServiceNow ワークプレイスサービスデリバリや Google カレンダーなど、予約の最終更新サブソースの表示値。Google カレンダーや Microsoft Outlook などの外部サービスと予約を統合するときに使用されます。 データタイプ:文字列 |
| result.reservation.last_updated_sub_source。値 | 予約の最終更新サブソースの内部値 ( 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 | デスク 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 | アムステルダムキャンパスなど、この場所が属する敷地の表示値。 データタイプ:文字列 |
| 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 | この場所が属するフロアの表示値 (1 階など)。 データタイプ:文字列 |
| 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.reservable_module | 予約に関連付けられた予約可能なモジュールの詳細。 データタイプ: オブジェクト |
| result.reservation.location.reservable_module。inline_title | 予約可能モジュールのインラインタイトル。タイトルは、職場サービスポータルの説明テキストに沿って表示されます。 データタイプ:文字列 |
| result.reservation.location.reservable_module。名前 | 予約可能なモジュールの名前。 データタイプ:文字列 |
| result.reservation.location.reservable_module。sys_id | 予約可能モジュールのSys_id。 データタイプ:文字列 |
| result.reservation.location.reservable_module。タイトル | 予約可能モジュールのタイトル。 データタイプ:文字列 |
| result.reservation.location.region | 場所に関連付けられている地域に関する詳細。 データタイプ: オブジェクト |
| result.reservation.location.region.active | リージョンがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.location.region.display_value | ヨーロッパなど、この場所が属する地域の表示値。 データタイプ:文字列 |
| result.reservation.location.region.sys_id | この場所が属する地域のSys_id。 データタイプ:文字列 テーブル:リージョン [sn_wsd_core_region] |
| 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.reservation.state | 場所の予約状況に関する詳細。 データタイプ: オブジェクト |
| result.reservation.location.reservation..state.display_value | 予約の現在のステータスの表示値 (確認済みなど)。 データタイプ:文字列 |
| result.reservation.location.reservation..state.value | 予約の現在のステータスの内部値 (2 など)。 データタイプ:文字列 |
| result.reservation.location.site | 場所が属するサイト。 データタイプ: オブジェクト テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.site.active | サイトがアクティブかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| result.reservation.location.site.display_value | 西ヨーロッパなど、この場所が属するサイトの表示値。 データタイプ:文字列 |
| result.reservation.location.site.sys_id | この場所が属するサイトのSys_id。 データタイプ:文字列 テーブル:サイト [sn_wsd_core_site] |
| result.reservation.location.standard_services | 標準で利用可能なサービス。 データタイプ:文字列 |
| 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.number_of_attendees | この予約の出席者の数。 データタイプ:数値 |
| 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.name | 予約を開いたユーザーの名前。 データタイプ:文字列 |
| result.reservation.opened_by.user_name | 予約を開いたユーザーのユーザー名。 データタイプ:文字列 |
| result.reservation.opened_by.value | 予約を開いたユーザーの内部値。 データタイプ:文字列 |
| result.reservation.recording_details | 予約 (会議) に関連付けられた記録に関する詳細。 データタイプ:オブジェクトのアレイ |
| result.reservation.recording_details。recording_url | 予約に関連付けられた記録の URL。 データタイプ:文字列 |
| result.reservation.recurring_pattern | 予約の繰り返しパターンに関する詳細。 データタイプ: オブジェクト |
| result.reservation.recurring_pattern。amountOfDate | 予約が予約されている日付の数。 データタイプ:文字列 |
| result.reservation.recurring_pattern.duration |
予約可能なものを予約する時間の長さ。
データタイプ:数値 単位:秒 |
| result.reservation.recurring_pattern.label | 繰り返し予約のわかりやすい名前。 データタイプ:文字列 |
| result.reservation.recurring_pattern.options | 繰り返し予約に関連付けられたオプションの詳細。 データタイプ: オブジェクト |
| result.reservation.recurring_pattern.options。カウント |
パターンを繰り返す回数。 データタイプ:数値 |
| result.reservation.recurring_pattern.options。曜日 |
予約が必要な曜日。 有効な値:
たとえば、火曜日、木曜日、金曜日を指定するには、245 (区切り文字なし) を渡します。repeats が週次、countが 5、daysOfWeek が 245 の場合、返される結果では、合計は データタイプ:文字列 |
| result.reservation.recurring_pattern.options。各 | パターンの繰り返し間隔。たとえば、値「2」は、 repeats プロパティの値に応じてパターンが 2 日または 2 か月ごとに繰り返されることを示します。 注:
この設定は、週次の繰り返し間隔には適用されません。隔週の繰り返し間隔では、 repeats プロパティを 日次 に設定し、この値を 14 に設定できます。データタイプ:数値 デフォルト値: 1 |
| result.reservation.recurring_pattern.options。終了日 | 会議が繰り返される終了日時 (「2022-07-08T14:00:00Z」など)。 データタイプ:文字列 形式:UTC yyyy-mm-dd hh:mm:ss |
| result.reservation.recurring_pattern.options。endDateGdt | 会議の繰り返しの終了日時。 データタイプ:文字列 形式:「2022-07-08T14:00:00Z」などの GDT |
| result.reservation.recurring_pattern.repeats |
予約可能な繰り返しパターン。 有効な値:(大文字と小文字を区別)
注: パターンの繰り返し間隔は、 options.every プロパティで設定します。週次パターンで有効な繰り返し間隔は 1 のみです。 データタイプ:文字列 |
| result.reservation.recurring_pattern.startDate |
繰り返しパターンの開始日時 (「2022-07-08T14:00:00Z」など)。
データタイプ:文字列 形式:UTC yyyy-mm-dd hh:mm:ss |
| result.reservation.recurring_pattern。startDateGdt |
繰り返しパターンの開始日時 (「2022-07-08T14:00:00Z」など)。
データタイプ:文字列 形式:UTC yyyy-mm-dd hh:mm:ss |
| 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_of。 データタイプ:文字列 テーブル: ユーザー [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。buildingSysId | 予約可能なモジュールに関連付けられている建物のsys_idsのリスト。 データタイプ:文字列のアレイ |
| 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 | ユーザーが予約の機密性 (通常、プライベートなど) を設定できるかどうかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| 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 | スペースなどの予約タイプの内部値。 データタイプ:文字列 |
| result.reservation.reservation_subtype | 予約のサブタイプに関する詳細。サブタイプは、単一、複数の親、複数の子、繰り返しの親、発生などの予約のタイプを示します。 データタイプ: オブジェクト |
| result.reservation.reservation_subtype。display_value | 予約のサブタイプの表示値 ([単一] など)。 データタイプ:文字列 |
| result.reservation.reservation_subtype.value | 予約のサブタイプの内部値 (「単一」など)。 データタイプ:文字列 |
| 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.source_reservation。display_value | ソース予約の表示値。 データタイプ:文字列 |
| result.reservation.source_reservation.name | ソース予約の名前。 データタイプ:文字列 |
| result.reservation.source_reservation.sys_id | ソース予約レコードのSys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| result.reservation.source_reservation_requester | 繰り返し予約を要求したユーザー。 データタイプ: オブジェクト |
| result.reservation.source_reservation_requester.name | 繰り返し予約要求者の名前。 データタイプ:文字列 |
| result.reservation.source_reservation_requester.sys_id | 繰り返し予約を要求したユーザーのSys_id。 データタイプ:文字列 テーブル: ユーザー [sys_user] |
| result.reservation.source_reservation_requester.user_name | 繰り返し予約要求者のユーザー名。 データタイプ:文字列 |
| result.reservation.start | 予約の開始日時。 データタイプ:文字列 形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z) |
| result.reservation.state | 予約のステータスに関する詳細。 データタイプ: オブジェクト |
| result.reservation.state.display_value | 予約の現在のステータスの表示値 (確認済みなど)。 データタイプ:文字列 |
| result.reservation.state.value | 予約の現在のステータスの内部値 (2 など)。 データタイプ:文字列 |
| 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」や「同期済み」など、別のサービスからの予約の同期ステータスに関する詳細。 データタイプ: オブジェクト |
| result.reservation.sync_state.display_value | 予約の現在の同期ステータスの表示値 (同期済みなど)。 データタイプ:文字列 |
| result.reservation.sync_state.value | 予約の現在の同期ステータスの内部値 (同期済みなど)。 データタイプ:文字列 |
| 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。 データタイプ:文字列 |
cURL 要求
次のコード例は、特定の繰り返し予約を取得する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/list/d98a381587b789506342b846dabb3563" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"
結果を返します:
{
"result": {
"reservations": [
{
"sys_id": "198a381587b789506342b846dabb3565",
"number": "WRES0001247",
"location": {
"sys_id": "fe1f744edb7650106c731dcd139619ca",
"name": "Aspen",
"description": "A room with large windows, dark leather seats and a large wooden table.",
"display_value": "Aspen",
"capacity": 16,
"label_value": "Room name",
"email": null,
"reservable_module": {
"sys_id": "c31241cedb7650106c731dcd13961917",
"name": "Meeting rooms",
"title": "Meeting rooms",
"inline_title": "meeting room"
},
"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": "2f554296dbba10106c731dcd139619ed",
"display_value": "Floor 2",
"active": true
},
"area": {
"sys_id": "",
"display_value": "",
"active": false
},
"reservation": {
"sys_id": "198a381587b789506342b846dabb3565",
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
},
"number": "WRES0001247",
"active": true
},
"number_of_attendees": 1,
"state": {
"value": "confirmed",
"display_value": "Confirmed"
},
"number": "WRES0001247",
"requested_for": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
}
},
"start": "2022-06-11T13:00:00Z",
"end": "2022-06-11T14:00:00Z",
"sys_created_on": "2022-05-30T07:06:37Z",
"sys_updated_on": "2022-05-30T07:06:40Z",
"source_reservation": {
"sys_id": "d98a381587b789506342b846dabb3563",
"display_value": "WRES0001246",
"name": "WRES0001246"
},
"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": "occurrence",
"display_value": "Occurrence"
},
"reservation_purpose": {
"value": "meeting",
"display_value": "Meeting"
},
"attendees": null,
"number_of_attendees": 1,
"is_parent": false,
"subject": "Rec 1",
"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": "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_recurring": "1",
"allow_whole_day": "1",
"require_whole_day": null,
"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": "1",
"enable_group_reservations": null,
"enable_browse_near_a_person": "1",
"enable_browse_by_area": "1",
"enable_floor_search": "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": [],
"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",
"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": "2de07e1887cb89106342b846dabb35fe",
"value": "2de07e1887cb89106342b846dabb35fe",
"displayValue": "Workplace User",
"display_value": "Workplace User",
"name": "Workplace User",
"user_name": "workplace_user",
"table": "sys_user",
"avatar": null,
"initials": "WU",
"email": "workplace_user@example.com",
"label": ""
},
"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": null,
"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_reservation_requester": {
"sys_id": "2de07e1887cb89106342b846dabb35fe",
"name": "Workplace User",
"user_name": "workplace_user"
},
"source_icon": {
"classNames": "fa fa-calendar-check-o",
"tooltip": "Reservation is confirmed",
"imgSrc": ""
},
"shift": null,
"recurring_pattern": {
"duration": "3600000",
"repeats": "daily",
"options": {
"count": 3,
"daysOfWeek": "",
"every": 1,
"endDate": "2022-06-13 14:00:00",
"endDateGdt": {}
},
"label": "Repeats daily, 3 times",
"startDate": "2022-06-11 13:00:00",
"startDateGdt": "{}",
"amountOfDates": "3"
},
"reservationAcl": {
"write": {
"record": true,
"fields": {
"subject": true,
"sensitivity": true,
"requested_for": true,
"number_of_attendees": true,
"location": true
},
"allFields": true
},
"read": true
}
}
],
"occurencesTotalCount": "1"
}
}
WSD 繰り返し予約:PATCH /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}
指定された繰り返し系列の予約全体、または系列内の特定の会議をキャンセルします。
URL 形式
バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/recurring_reservation/cancel_series/{sys_id}
デフォルト URL: /api/sn_wsd_rsv/recurring_reservation/cancel_series/{sys_id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| sys_id | シリーズ全体をキャンセルするには、繰り返し親予約レコードのsys_idを渡します。 系列の特定の発生をキャンセルするには、系列の発生sys_id渡します。 繰り返し親レコードの列reservation_subtypeは [ 繰り返し親] に設定されます。個々の発生レコードの reservation_subtype フィールドは [発生] に設定されています。 発生レコードから繰り返し親予約の詳細を取得するには、発生レコードの [source_reservation] フィールドのsys_idを参照してください。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| 名前 | 説明 |
|---|---|
| cancel_notes | 予約をキャンセルする理由。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result | 繰り返し予約のキャンセル要求の結果を返します。 データタイプ: オブジェクト |
| result.failedToCancelOccurrenceReservations | キャンセルに失敗した個々の会議の発生レコードのsys_idsリスト。 データタイプ:文字列のアレイ |
| result.seriesId | 系列全体がキャンセルされた場合の繰り返し発生する親のSys_id、または単一の発生がキャンセルされた場合の特定の発生のsys_id。 データタイプ:文字列 |
| result.success | 予約が正常にキャンセルされたかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.failedToCancelOccurrenceReservations | 正常にキャンセルされた個々の会議の発生レコードのsys_idsリスト。 データタイプ:文字列のアレイ |
| result.user_msg | 要求に関するメッセージ。 データタイプ:文字列 |
cURL 要求
次のコード例は、繰り返し予約全体をキャンセルする方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/cancel_series/f64983a347274550003a4587746d43b8" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"
結果を返します:
{
"result": {
"failedToCancelOccurrenceReservations": [],
"successCanceledOccurrences": [
"cb4983a347274550003a4587746d43bd",
"cf4983a347274550003a4587746d43ba"
],
"user_msg": "Your Recurring reservation has been canceled successfully!",
"seriesId": "f64983a347274550003a4587746d43b8",
"success": true
}
}
WSD 繰り返し予約:POST /api/sn_wsd_rsv/recurring_reservation/create_series
毎週、毎月、隔週など、同じ時間で異なる日付の職場予約を作成します。
URL 形式
バージョニングされた URL: /api/sn_wsd_rsv/{api_version}/recurring_reservation/create_series
デフォルト URL: /api/sn_wsd_rsv/recurring_reservation/create_series
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| recurringPattern | 予約の繰り返しパターンに関する詳細。 データタイプ: オブジェクト |
| recurringPattern.duration | シフトベースの予約でない場合は必須です。 予約可能なものを予約する時間の長さ。 データタイプ:数値 単位:秒 |
| recurringPattern.label | 繰り返し予約のわかりやすい名前。 データタイプ:文字列 |
| recurringPattern.options | 必須です。 繰り返しパターンに設定されたオプションの詳細。 データタイプ: オブジェクト
|
| recurringPattern.options.count | シフトベースの予約でない場合は必須です。シフトベースの予約では無視されます。 パターンを繰り返す回数。 データタイプ:数値 |
| recurringPattern.options.daysOfWeek | repeatsパラメーターが「週次」に設定されている場合は必須です。 予約が必要な曜日。 有効な値:
たとえば、火曜日、木曜日、金曜日を指定するには、245 (区切り文字なし) を渡します。repeats が週次、countが 5、daysOfWeek が 245 の場合、返される結果では、合計は データタイプ:文字列 |
| recurringPattern.options.every | パターンの繰り返し間隔。たとえば、値「2」は、 repeats プロパティの値に応じてパターンが 2 日または 2 か月ごとに繰り返されることを示します。 注:
この設定は、週次の繰り返し間隔には適用されません。隔週の繰り返し間隔では、 repeats プロパティを 日次 に設定し、この値を 14 に設定できます。データタイプ:数値 デフォルト値: 1 |
| recurringPattern.options.endDate | 会議が繰り返される終了日時 (「2022-07-08T14:00:00Z」など)。 データタイプ:文字列 形式:UTC yyyy-mm-dd hh:mm:ss |
| recurringPattern.repeats | シフトベースの予約でない場合は必須です。 予約可能な繰り返しパターン。 有効な値:(大文字と小文字を区別)
注: パターンの繰り返し間隔は、 options.every プロパティで設定します。週次パターンで有効な繰り返し間隔は 1 のみです。 データタイプ:文字列 |
| recurringPattern.startDate | 必須です。 繰り返しパターンの開始日時 (「2022-07-08T14:00:00Z」など)。 データタイプ:文字列 形式:UTC yyyy-mm-dd hh:mm:ss |
| 予約 | 作成する繰り返し予約に関する詳細。 データタイプ: オブジェクト |
| reservation.is_private | 予約がプライベートであるかどうかを示すフラグ。プライベートの場合、予約は所有者以外の誰にも表示されません。 これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。 有効な値:
データタイプ:ブーリアン デフォルト:システムプロパティのプライバシーに設定された値。 |
| reservation.location | 必須です。 予約する場所のSys_id。 データタイプ:文字列 テーブル:職場の場所 [sn_wsd_core_workplace_location] |
| reservation.reservable_module | 必須です。予約に関連付ける予約可能モジュールのSys_id。予約可能なモジュールは、予約に必要な職場アイテムを定義します。 データタイプ:文字列 テーブル:予約可能なモジュール [sn_wsd_rsv_reservable_module] |
| reservation.shift | 予約に関連付けるシフトのSys_id。このパラメーターが渡される場合、 end パラメーターは必須ではありません。 シフトベースの予約の詳細については、「 シフトベースの予約を有効にする」を参照してください。 データタイプ:文字列 テーブル:シフト [sn_wsd_core_shift] |
| reservation.subject | 必須です。 予約に関連付けられた会議の件名。 データタイプ:文字列 |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| result | 複数予約の作成または更新の結果を返します。 データタイプ: オブジェクト |
| result.isValid | 予約が正常に作成されたかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.parent | 更新された親予約のSys_id。 データタイプ:文字列 |
| result.successfulReservations | 正常に更新された予約のリスト。 データタイプ:オブジェクトのアレイ |
| result.successfulReservations.collision | 指定された時間に予約が既に存在しており、現在の予約と競合しているかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.successfulReservations.end | 予約の終了日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z) |
| result.successfulReservations.error | 予約の作成中に問題が発生した場合のエラーメッセージ。 データタイプ:文字列 |
| result.successfulReservations.inserted | 予約が正常に挿入されたかどうかを示すフラグ。予約が追加されたときなどです。 可能な値:
データタイプ:ブーリアン |
| result.successfulReservations.start | 予約の開始日時。 データタイプ:文字列 形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z) |
| result.successfulReservations.sys_id | 作成された予約のSys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
| result.unSuccessfulReservations | 正常に更新されなかった予約のリスト。 データタイプ:オブジェクトのアレイ |
| result.unSuccessfulReservations.collision | 指定された時間に予約が既に存在しており、現在の予約と競合しているかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン |
| result.unSuccessfulReservations.end | 予約の終了日時。 データタイプ:文字列 形式:UTC:yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z) |
| result.unSuccessfulReservations.error | 予約の作成中に問題が発生した場合のエラーメッセージ。 データタイプ:文字列 |
| result.unSuccessfulReservations.inserted | 予約が正常に挿入されたかどうかを示すフラグ。予約が追加されたときなどです。 可能な値:
データタイプ:ブーリアン |
| result.unSuccessfulReservations.start | 予約の開始日時。 データタイプ:文字列 形式:UTC - yyyy-mm-ddThh:mm:ssZ (例: 2021-02-05T18:00:00Z) |
| result.unSuccessfulReservations.sys_id | 予約レコードのSys_id。 データタイプ:文字列 テーブル:職場予約 [sn_wsd_rsv_reservation] |
cURL 要求
次のコード例は、2 日間連続する日次繰り返し予約を作成する方法を示しています。
curl "https://instance.servicenow.com/api/sn_wsd_rsv/recurring_reservation/create_series" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservation\": {
\"reservable_module\": \"5db44502dbb650106c731dcd13961937\",
\"subject\": \"Test-123\",
\"reservation_purpose\": \"meeting\",
\"timezone\": \"US/Pacific\",
\"requested_for\": \"6816f79cc0a8016401c5a33be04be441\",
\"location\": \"6a11a94adb7210106c731dcd1396194e\",
\"attendees\": \"6816f79cc0a8016401c5a33be04be441\",
\"is_private\": false
},
\"recurringPattern\": {
\"duration\": 3600000,
\"repeats\": \"daily\",
\"options\": {
\"count\": 2,
\"daysOfWeek\": \"\",
\"every\": 1
},
\"label\": \"Repeats daily, 2 times\",
\"startDate\": \"2023-01-12T12:00:00Z\"
}
}" \
結果を返します:
{
"result": {
"isValid": true,
"parent": "1e5f65ca87586550cfaa99b73cbb3513",
"successfulReservations": [
{
"inserted": true,
"collision": false,
"sys_id": "9e5f65ca87586550cfaa99b73cbb3517",
"error": null,
"start": "2023-01-13T12:00:00Z",
"end": "2023-01-13T13:00:00Z"
}
],
"unSuccessfulReservations": [
{
"inserted": true,
"collision": true,
"sys_id": "5e5f65ca87586550cfaa99b73cbb3515",
"error": null,
"start": "2023-01-12T12:00:00Z",
"end": "2023-01-12T13:00:00Z"
}
]
}
}