WSD Multi Reservation API

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む33読むのに数分
  • ワークプレイスサービスデリバリ (WSD) Multi Reservation API は、複数の職場の場所を含む予約を管理するためのエンドポイントを提供します。

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

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

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

    WSD Multi Reservation - PATCH /api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

    指定された複数予約をキャンセルします。

    URL 形式

    バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/multi_reservation/cancel/{sys_id}

    デフォルトの URL:/api/sn_wsd_rsv/multi_reservation/cancel/{sys_id}

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

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

    データタイプ:文字列

    sys_id キャンセルする複数予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    データタイプ:文字列

    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター
    名前 説明
    cancel_notes 予約をキャンセルする理由

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result キャンセル要求の結果の詳細。

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

    "result": {
      "error": "String",
      "parent": "String",
      "success": Boolean,
      "successfulReservations": [Array],
      "unSuccessfulReservations": [Array]
    }
    result.error 関連するエラーを説明するメッセージ。

    データタイプ:文字列

    result.parent 親予約の sys_id。親には、1 つ以上の子予約を関連付けることができます。

    データタイプ:文字列

    result.success 予約が正常にキャンセルされたかどうかを示すフラグ。
    可能な値:
    • true:正常にキャンセルされました。
    • false:予約はキャンセルされませんでした。

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

    result.successfulReservations 複数予約の正常なキャンセルに関する詳細。

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

    "successfulReservations": [
      {
        "msg": "String",
        "success": Boolean,
        "sys_id": "String"
      }
    ]
    result.successfulReservations.msg キャンセルメッセージ。

    データタイプ:文字列

    result.successfulReservations.success 予約が正常にキャンセルされたかどうかを示すフラグ。
    可能な値:
    • true:正常にキャンセルされました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations.sys_id キャンセルされた予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    データタイプ:文字列

    result.unSuccessfulReservations 正常にキャンセルされなかった複数予約に関する詳細。

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

    "unSuccessfulReservations": [
      {
        "msg": "String",
        "success": Boolean,
        "sys_id": "String"
      }
    ]
    result.unSuccessfulReservations.msg キャンセルメッセージ。

    データタイプ:文字列

    result.unSuccessfulReservations.success 予約が正常にキャンセルされたかどうかを示すフラグ。
    可能な値:
    • true:正常にキャンセルされました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.unSuccessfulReservations.sys_id キャンセルされなかった予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    データタイプ:文字列

    cURL 要求

    次のコード例は、複数予約をキャンセルする方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/cancel/1b1fdf5987ab01506342b846dabb35ec" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{\"cancel_notes\":\"Meeting no longer needed.\"}" \ 
    --user "username":"password’"

    返される結果:

    {
      "result": {
        "success": true,
        "successfulReservations": [
          {
            "success": true,
            "msg": "Cancelled successfully.",
            "sys_id": "5b1f9f1d87ab01506342b846dabb35a4"
          },
          {
            "success": true,
            "msg": "Cancelled successfully.",
            "sys_id": "931f9f1d87ab01506342b846dabb35a0"
          }
        ],
        "unSuccessfulReservations": [],
        "error": null,
        "parent": "1b1fdf5987ab01506342b846dabb35ec"
      }
    }

    WSD Multi Reservation - PATCH /api/sn_wsd_rsv/multi_reservation/update/{sys_id}

    同じ予約 (会議) に複数の職場の場所がある複数予約に関連付けられている予約を更新します。

    このエンドポイントは、次の 4 つの異なる更新シナリオを処理できます。
    1. 件名、日付、時刻などの複数の予約レコードの内容を更新します。
    2. 複数予約を親 (単一の職場の場所に対する予約) に基づいて単一予約に変換します。
    3. 単一予約 (単一の職場の場所に対する予約) を複数予約に変換します。
    4. 職場の場所を既存の複数予約に追加または複数予約から削除します。

    URL 形式

    バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/multi_reservation/update/{sys_id}

    デフォルトの URL:/api/sn_wsd_rsv/multi_reservation/update/{sys_id}

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

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

    データタイプ:文字列

    sys_id 更新する予約の sys_id。
    • 単一予約から複数予約:単一予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。
    • 複数予約のコンテンツを更新:親予約レコードの sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    子レコードから複数の親予約の詳細を取得するには、子レコードの [source_reservation] フィールドで sys_id を参照します。

    データタイプ:文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター
    名前 説明
    終了 パラメーターが渡されない場合は shift 必須です。予約の要求された終了時間。

    データタイプ:文字列

    形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)

    requested_for 予約対象のユーザーの sys_id またはメールアドレス。ユーザー [sys_user] テーブルにあります。

    データタイプ:文字列

    予約可能 List of details about the reservables associated with the reservation.

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

    "reservables": [
      {
        "is_private": Boolean,
        "sys_id": "String"
      }
    ]
    reservables.is_private 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外には表示されません。

    これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。

    有効な値:
    • true:予約はプライベートです。
    • false:予約はプライベートではありません。

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

    デフォルト:システムプロパティのプライバシーに設定された値。

    reservables.sys_id Sys_id of the location at which to make the reservations. 職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    reservable_module 必須です。予約に関連付ける予約可能モジュールの sys_id。予約 可能なモジュールは、予約 に必要な職場アイテムを定義します。予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルにあります。

    データタイプ:文字列

    shift
    予約に関連付けるシフトの sys_id。シフト [sn_wsd_core_shift] テーブルにあります。このパラメーターが渡される場合、 end このパラメーターは必要ありません。

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

    データタイプ:文字列

    start 必須です。予約の要求された開始時間。

    データタイプ:文字列

    形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)

    件名
    予約に関連付けられた会議の件名。

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 複数予約の作成または更新の結果を返します。

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

    "result": {
      "parent": "String",
      "success": Boolean,
      "successfulReservations": Array,
      "unSuccessfulReservations": Array
    }
    result.parent 親予約の sys_id。親には、1 つ以上の子予約を関連付けることができます。

    データタイプ:文字列

    result.success 予約が正常に作成されたかどうかを示すフラグ。
    可能な値:
    • true:正常に作成されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations 正常に作成された予約のリスト。

    データタイプ:アレイ

    "successfulReservations": [
      {
        "cancelled": Boolean,
        "error": "String",
        "reservable": "String"
        "success": Boolean,
        "sys_id": "String",
        "updated": Boolean
      }
    ]
    result.successfulReservations.cancelled 予約が正常にキャンセルされたかどうかを示すフラグ。
    可能な値:
    • true:正常にキャンセルされました。
    • false:キャンセルされませんでした。

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

    result.successfulReservations.error 予約の作成中に問題が発生した場合のエラーメッセージ。

    データタイプ:文字列

    result.SuccessfulReservations.insert 予約が正常に挿入されたかどうかを示すフラグ。予約が追加されたときなど。
    可能な値:
    • true:正常に挿入されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations.reservable 予約が行われた職場の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    result.successfulReservations.success 関連する操作が成功したかどうかを示すフラグ。
    可能な値:
    • true:操作に成功しました。
    • false:操作に失敗しました。

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

    result.successfulReservations.sys_id 作成された予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    データタイプ:文字列

    result.successfulReservations.update 予約が正常に更新されたかどうかを示すフラグ。
    可能な値:
    • true:正常に更新されました。
    • false:更新されませんでした。

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

    result.unSuccessfulReservations 正常に作成されなかった予約のリスト。

    データタイプ:アレイ

    "unSuccessfulReservations": [
      {
        "cancelled": Boolean,
        "error": "String",
        "insert": Boolean
        "reservable": "String"
        "success": Boolean,
        "sys_id": "String",
        "updated": Boolean
      }
    ]
    result.unSuccessfulReservations.cancelled 予約が正常にキャンセルされたかどうかを示すフラグ。
    可能な値:
    • true:正常にキャンセルされました。
    • false:キャンセルされませんでした。

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

    result.unSuccessfulReservations.error 予約の作成中に問題が発生した場合のエラーメッセージ。

    データタイプ:文字列

    result.unSuccessfulReservations.insert 予約が正常に挿入されたかどうかを示すフラグ。
    可能な値:
    • true:正常に挿入されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.unSuccessfulReservations.reservable 予約が試行された職場の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    result.unSuccessfulReservations.success 予約が正常に作成されたかどうかを示すフラグ。
    可能な値:
    • true:正常に作成されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.unSuccessfulReservations.sys_id 失敗した予約の sys_id。

    常に null です。

    データタイプ:文字列

    result.unSuccessfulReservations.update 予約が正常に更新されたかどうかを示すフラグ。
    可能な値:
    • true:正常に更新されました。
    • false:更新されませんでした。

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

    cURL 要求

    次のコード例は、既存の複数予約のコンテンツを変更する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
        \"reservables\":[
            { 
                \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\" 
            }, 
            {
                \"sys_id\":\"02000d4edb7650106c731dcd13961914\"
            }
        ],
        \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
        \"subject\":\"Test 1\",
        \"start\":\"2022-05-27 13:00:00\",
        \"end\":\"2022-05-27 14:00:00\",
        \"requested_for\": \"workplace_user@example.com\"
    }" \
    --user 'username':'password'

    返される結果:

    {
      "result": {
        "parent": "98ccb4348723cd106342b846dabb359a",
        "success": true,
        "successfulReservations": [
          {
            "success": true,
            "updated": true,
            "cancelled": false,
            "sys_id": "6cccb4348723cd106342b846dabb359d",
            "error": null,
            "reservable": "5eafb44edb7650106c731dcd13961943"
          },
          {
            "success": true,
            "updated": true,
            "cancelled": false,
            "sys_id": "74af283c87ef8d106342b846dabb3592",
            "error": null,
            "reservable": "fe1f744edb7650106c731dcd139619ca"
          }
        ],
        "unSuccessfulReservations": []
      }
    }

    cURL 要求

    次のコード例は、既存の複数予約に職場の場所を追加する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"reservables\":[
           { 
               \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
               \"is_private\": false 
           }, 
           {
               \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
               \"is_private\": false
           },
        {
               \"sys_id\":\"c4308d4edb7650106c731dcd1396194c\",
               \"is_private\": false
           }
       ],
       \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
       \"subject\":\"Test 1\",
       \"start\":\"2022-05-27 13:00:00\",
       \"end\":\"2022-05-27 14:00:00\",
       \"requested_for\": \"workplace_user@example.com\"
    }" \
    --user 'username':'password'

    返される結果:

    {
      "result": {
        "parent": "98ccb4348723cd106342b846dabb359a",
        "success": true,
        "successfulReservations": [
          {
            "success": true,
            "updated": true,
            "cancelled": false,
            "sys_id": "6cccb4348723cd106342b846dabb359d",
            "error": null,
            "reservable": "5eafb44edb7650106c731dcd13961943"
          },
          {
            "success": true,
            "updated": true,
            "cancelled": false,
            "sys_id": "74af283c87ef8d106342b846dabb3592",
            "error": null,
            "reservable": "fe1f744edb7650106c731dcd139619ca"
          },
          {
            "success": true,
            "inserted": true,
            "sys_id": "9e6d78748723cd106342b846dabb35a5",
            "error": null,
            "reservable": "c4308d4edb7650106c731dcd1396194c"
          }
        ],
        "unSuccessfulReservations": []
      }
    }
    

    cURL 要求

    次のコード例は、単一予約を複数予約に変換する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"reservables\":[
           { 
               \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
               \"is_private\": false
           }, 
           {
               \"sys_id\":\"5eafb44edb7650106c731dcd13961943\",
               \"is_private\": false
           }
       ],
       \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
       \"subject\":\"Test 1\",
       \"start\":\"2022-05-27 13:00:00\",
       \"end\":\"2022-05-27 14:00:00\",
       \"requested_for\": \"workplace_user@example.com\"
    }" \
    --user 'username':'password'

    返される結果:

    {
      "result": {
        "success": true,
        "parent": "98ccb4348723cd106342b846dabb359a",
        "successfulReservations": [
          {
            "success": true,
            "inserted": true,
            "sys_id": "6cccb4348723cd106342b846dabb359d",
            "error": null,
            "reservable": "5eafb44edb7650106c731dcd13961943"
          },
          {
            "success": true,
            "insert": false,
            "update": true,
            "cancel": false,
            "sys_id": "74af283c87ef8d106342b846dabb3592",
            "reservable": "fe1f744edb7650106c731dcd139619ca"
          }
        ],
        "unSuccessfulReservations": [],
        "error": null
      }
    }

    cURL 要求

    次のコード例は、複数予約を単一予約に変換する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_reservation/update/02000d4edb7650106c731dcd13961914" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"reservables\":[
           { 
               \"sys_id\":\"fe1f744edb7650106c731dcd139619ca\",
               \"is_private\": false
           }
       ],
       \"reservable_module\":\"c31241cedb7650106c731dcd13961917\",
       \"subject\":\"Test 1\",
       \"start\":\"2022-05-27 13:00:00\",
       \"end\":\"2022-05-27 14:00:00\",
       \"requested_for\": \"workplace_user@example.com\"
    }" \
    --user 'username':'password'

    返される結果:

    {
      "result": {
        "sys_id": "74af283c87ef8d106342b846dabb3592",
        "success": true,
        "successfulReservations": [
          {
            "success": true,
            "insert": false,
            "update": true,
            "cancel": false,
            "sys_id": "74af283c87ef8d106342b846dabb3592",
            "reservable": "fe1f744edb7650106c731dcd139619ca",
            "error": ""
          },
          {
            "success": true,
            "insert": false,
            "update": true,
            "cancel": true,
            "sys_id": "3caf283c87ef8d106342b846dabb3596",
            "reservable": "5eafb44edb7650106c731dcd13961943"
          }
        ],
        "unSuccessfulReservations": [],
        "error": null
      }
    }

    WSD Multi Reservation - POST /api/sn_wsd_rsv/multi_reservation/add

    異なる職場の場所で同じ時間に職場予約を作成します。

    URL 形式

    バージョニングされている URL:/api/sn_wsd_rsv/{api_version}/multi_reservation/add

    デフォルトの URL:/api/sn_wsd_rsv/multi_reservation/add

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

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

    データタイプ:文字列

    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター
    名前 説明
    終了 パラメーターが渡されない場合は shift 必須です。予約の要求された終了時間。

    データタイプ:文字列

    形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)

    requested_for 予約対象のユーザーの sys_id またはメールアドレス。ユーザー [sys_user] テーブルにあります。

    データタイプ:文字列

    予約可能 List of details about the reservables associated with the reservation.

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

    "reservables": [
      {
        "is_private": Boolean,
        "sys_id": "String"
      }
    ]
    reservables.is_private 予約がプライベートかどうかを示すフラグ。プライベートの場合、予約は所有者以外には表示されません。

    これらのプライバシー設定の詳細については、「 場所のプライバシー設定と影響」を参照してください。

    有効な値:
    • true:予約はプライベートです。
    • false:予約はプライベートではありません。

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

    デフォルト:システムプロパティのプライバシーに設定された値。

    reservables.sys_id Sys_id of the location at which to make the reservations. 職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    reservable_module 必須です。予約に関連付ける予約可能モジュールの sys_id。予約 可能なモジュールは、予約 に必要な職場アイテムを定義します。予約可能なモジュール [sn_wsd_rsv_reservable_module] テーブルにあります。

    データタイプ:文字列

    shift
    予約に関連付けるシフトの sys_id。シフト [sn_wsd_core_shift] テーブルにあります。このパラメーターが渡される場合、 end このパラメーターは必要ありません。

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

    データタイプ:文字列

    start 必須です。予約の要求された開始時間。

    データタイプ:文字列

    形式:UTC または現地時間 (yyyy-mm-dd hh:mm:ss)

    subject 必須です。
    予約に関連付けられた会議の件名。

    データタイプ:文字列

    ヘッダー

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

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

    デフォルト: application/json

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 複数予約の作成または更新の結果を返します。

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

    "result": {
      "parent": "String",
      "success": Boolean,
      "successfulReservations": Array,
      "unSuccessfulReservations": Array
    }
    result.parent 親予約の sys_id。親には、1 つ以上の子予約を関連付けることができます。

    データタイプ:文字列

    result.success 予約が正常に作成されたかどうかを示すフラグ。
    可能な値:
    • true:正常に作成されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations 正常に作成された予約のリスト。

    データタイプ:アレイ

    "successfulReservations": [
      {
        "error": "String",
        "inserted": Boolean,
        "reservable": "String"
        "success": Boolean,
        "sys_id": "String"
      }
    ]
    result.successfulReservations.error 予約の作成中に問題が発生した場合のエラーメッセージ。

    データタイプ:文字列

    result.successfulReservations.inserted 予約が正常に挿入されたかどうかを示すフラグ。予約が追加されたときなど。
    可能な値:
    • true:正常に挿入されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations.reservable 予約が行われた職場の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    result.successfulReservations.success 予約が正常に作成されたかどうかを示すフラグ。
    可能な値:
    • true:正常に作成されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.successfulReservations.sys_id 作成された予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。

    データタイプ:文字列

    result.unSuccessfulReservations 正常に作成されなかった予約のリスト。

    データタイプ:アレイ

    "unSuccessfulReservations": [
      {
        "error": "String",
        "inserted": Boolean,
        "reservable": "String"
        "success": Boolean,
        "sys_id": "String"
      }
    ]
    result.unSuccessfulReservations.error 予約の作成中に問題が発生した場合のエラーメッセージ。

    データタイプ:文字列

    result.unSuccessfulReservations.inserted 予約が正常に挿入されたかどうかを示すフラグ。
    可能な値:
    • true:正常に挿入されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.unSuccessfulReservations.reservable 予約が試行された職場の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。

    データタイプ:文字列

    result.unSuccessfulReservations.success 予約が正常に作成されたかどうかを示すフラグ。
    可能な値:
    • true:正常に作成されました。
    • false:操作に失敗しました。

    データタイプ:ブール

    result.unSuccessfulReservations.sys_id 失敗した予約の sys_id。

    常に null です。

    データタイプ:文字列

    cURL 要求

    このコード例は、同じ予約に対して 2 つの異なる職場を予約する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/multi_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\",
        \"reservables\": [
            {
                \"sys_id\": \"fe1f744edb7650106c731dcd139619ca\",
                \"is_private\": false
            },
            {
                \"sys_id\": \"d1208d4edb7650106c731dcd1396194a\",
                \"is_private\": false
            }
        ],
        \"start\": \"2023-01-12T11:30:00Z\",
        \"end\": \"2023-01-12T12:30:00Z\",
        \"reservation_type\": \"space\"
    }" \
    --user "username":"password"

    返される結果:

    {
      "result": {
        "success": true,
        "parent": "08e8a18687586550cfaa99b73cbb354f",
        "successfulReservations": [
          {
            "success": true,
            "inserted": true,
            "sys_id": "44e8a18687586550cfaa99b73cbb3552",
            "error": null,
            "reservable": "fe1f744edb7650106c731dcd139619ca"
          },
          {
            "success": true,
            "inserted": true,
            "sys_id": "04e8a18687586550cfaa99b73cbb3555",
            "error": null,
            "reservable": "d1208d4edb7650106c731dcd1396194a"
          }
        ],
        "unSuccessfulReservations": []
      }
    }