WSD Reservation Invitees API

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：22分

    • ワークプレイスサービスデリバリ (WSD) 予約招待者 API は、招待者を予約に追加し、予約の招待者をフェッチし、予約の招待者を再アサインするためのエンドポイントを提供します。

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

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

    ワークプレイス予約管理の詳細については、「ワークプレイス予約管理」を参照してください。

    WSD Reservation Invitees - GET /api/sn_wsd_rsv/wsd_reservation_invitees/reservation/{sys_id}

    指定された予約に関連付けられている招待者の詳細を取得します。

    URL 形式

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

    デフォルトの URL：/api/sn_wsd_rsv/reservation/{sys_id}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

    データタイプ：文字列
    sys_id 招待者の詳細を返す予約の sys_id。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

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

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 指定された予約に関連付けられている招待者の結果を返します。

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

    {
  "result": {
    "invitees": [Array],
    "reservationId": "String",
    "reservationSubType": "String",
    "success": Boolean
  }
}
    result.invitees 予約に関連付けられている招待者の詳細。

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

    "invitees": [
  {
    "email": "String",
    "firstName": "String",
    "inviteeId": "String",
    "inviteState": {Object},
    "inviteeType": "String",
    "isVIP": Boolean,
    "isWifiRequired": Boolean,
    "isParkingRequired": Boolean,
    "lastName": "String",
    "licensePlate": "String",
    "location": {Object},
    "name": "String",
    "org": "String",
    "parkingType": "String",
    "phoneNumber": "String",
    "privateNotes": "String",
    "reservationId": "String",
    "reservationInviteeId": "String",
    "title": "String",
    "visitorType": "String"
  }
]
    result.invitees.email
    招待者のメールアドレス。

    データタイプ：文字列
    result.invitees.firstName 招待者の名。

    データタイプ：文字列
    result.invitees.inviteeId
    従業員のユーザーレコードの sys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    result.invitees.inviteState 予約に対する招待者の現在のステータスに関する詳細。

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

    "inviteState": {
  "displayValue": "String",
  "value": "String"
}
    result.invitees.inviteState.displayValue New または Removed などの招待者のステータスの表示値。

    データタイプ：文字列
    result.invitees.inviteState.value 招待者のステータスの内部値。

    データタイプ：文字列
    result.invitees.inviteeType
    招待者のタイプ。
    有効な値： (大文字と小文字を区別)
    • 従業員
    • visitor

    データタイプ：文字列
    result.invitees.isVIP 招待者が VIP として分類されているかどうかを示すフラグ。
    有効な値：
    • true：招待者は VIP です。
    • false:招待者は VIP ではありません。

    データタイプ：ブーリアン
    result.invitees.isWifiRequired 入場時に WIFI パスワードを訪問者に提供する必要があるかどうかを示すフラグ。
    有効な値：
    • true：Wi-Fi パスワードを提供します。
    • false:WIFI パスワードを入力しません。

    データタイプ：ブーリアン
    result.invitees.isParkingRequired 招待者が駐車場を必要とするかどうかを示すフラグ。
    有効な値：
    • true：駐車場が必要です。
    • false:駐車場は必要ありません。

    データタイプ：ブーリアン
    result.invitees.lastName 招待者の姓。

    データタイプ：文字列
    result.invitees.licensePlate 招待者のライセンスプレート。

    データタイプ：文字列
    result.invitees.location 招待者の職場の場所に関する詳細。

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

     "location": {
  "displayName": "String",
  "sysId": "String"
}
    result.invitees.location.displayName 招待者の職場の場所の表示名 (Dublin など)。

    データタイプ：文字列
    result.invitees.location.sysId 招待者の職場の場所の sys_id。

    データタイプ：文字列

    テーブル:職場の場所 [sn_wsd_core_worplace_location]
    result.invitees.name 招待者の名前。

    データタイプ：文字列
    result.invitees.org 招待者の組織。

    データタイプ：文字列
    result.invitees.parkingType 招待者に必要な駐車場のタイプ。
    有効な値： (大文字と小文字を区別)
    • ev_parking
    • なし
    • normal_parking
    • van_accessible_parking

    データタイプ：文字列
    result.invitees.phoneNumber 招待者の電話番号。

    データタイプ：文字列
    result.invitees.privateNotes 招待者によって提供された追加のメモ。

    データタイプ：文字列
    result.invitees.reservationId 招待者が関連付けられている予約の sys_id。

    データタイプ：文字列

    テーブル:職場予約 [sn_wsd_rsv_reservation]
    result.invitees.reservationInviteeId

    訪問者の予約招待者の sys_id。

    データタイプ：文字列

    テーブル:予約招待者 [sn_wsd_rsv_m2m_reservation_invitee]
    result.invitees.title 招待者の役職。

    データタイプ：文字列
    result.invitees.visitorType 招待者のタイプ。
    有効な値： (大文字と小文字を区別)
    • client
    • contractor
    • friend_family
    • others

    データタイプ：文字列
    result.reservationId 招待者が関連付けられている予約の sys_id。

    データタイプ：文字列

    テーブル:職場予約 [sn_wsd_rsv_reservation]
    result.reservationSubType 単一または複数の子など、予約レコードのサブタイプ。

    データタイプ：文字列
    result.success コールが成功したかどうかを示すフラグ。
    可能な値：
    • true：エンドポイントコールに成功しました。
    • false：エンドポイントコールに失敗しました。

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

    cURL 要求

    次のコード例は、予約の招待者を取得する方法を示しています。

    curl 
"http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reservation/17979dc9536b01103cf7ddeeff7b12b3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    返される結果：

    {
  "result": {
    "success": true,
    "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
    "reservationSubType": "single",
    "invitees": [
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "1f97d58d53e701103cf7ddeeff7b129a",
        "inviteeType": "employee",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "6816f79cc0a8016401c5a33be04be441",
        "name": "System Administrator",
        "email": "admin@example.com"
      },
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "8ee7ddc9536b01103cf7ddeeff7b1219",
        "inviteeType": "employee",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "62826bf03710200044e0bfc8bcbe5df1",
        "name": "Abel Tuter",
        "email": "abel.tuter@example.com"
      },
      {
        "reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
        "location": {
          "sysId": "19efb84edb7650106c731dcd1396193c",
          "displayName": "Dublin"
        },
        "reservationInviteeId": "4ae7d10d536b01103cf7ddeeff7b126b",
        "inviteeType": "visitor",
        "inviteState": {
          "displayValue": "New",
          "value": "new"
        },
        "inviteeId": "86e7d10d536b01103cf7ddeeff7b1267",
        "firstName": "Visitor",
        "lastName": "User",
        "name": "Visitor User",
        "email": "visitoruser@example.com",
        "phoneNumber": "+919876543210",
        "isVIP": true,
        "parkingType": "normal_parking",
        "licensePlate": "1234",
        "isParkingRequired": true,
        "org": "Senow",
        "visitorType": "contractor",
        "title": "President",
        "isWifiRequired": true,
        "privateNotes": "Visiting"
      }
    ]
  }
}

    WSD Reservation Invitees - POST /api/sn_wsd_rsv/wsd_reservation_invitees/reassign

    ある予約から別の予約に指定された招待者を再アサインします。

    URL 形式

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

    デフォルトの URL：/api/sn_wsd_rsv/wsd_reservation_invitees/reassign

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター
    名前 説明
    reservationId 必須。招待者を再アサインする予約の sys_id。

    データタイプ：文字列

    テーブル:職場予約 [sn_wsd_rsv_reservation]
    reservationInvitees reservationId パラメーターで識別された予約に再アサインする招待者のリスト。

    これにより、指定された招待者が予約招待者テーブルに従って以前の予約から削除され、この予約に移動されます。

    データタイプ：文字列のアレイ

    テーブル:予約招待者 [sn_wsd_rsv_m2m_reservation_invitee]

    ヘッダー

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

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

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 招待者の再アサインに関する詳細。

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

    "result": {
   "reservationInviteeIds": [Array],
   "success": Boolean
}
    result.reservationInviteeIds 指定された予約に再アサインされた予約招待者の sys_id のリスト。

    データタイプ：文字列のアレイ
    result.success 招待者が予約に再アサインされたかどうかを示すフラグ。
    可能な値：
    • true：招待者は正常に再アサインされました。
    • false:招待者は再アサインされませんでした。

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

    cURL 要求

    次のコード例は、招待者を予約に再アサインする方法を示しています。

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reassign" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservationId\":\"3984e6c1532f01103cf7ddeeff7b129b\",
\"reservationInvitees\":{\"aa31427f531701103cf7ddeeff7b1243\",\"e231427f531701103cf7ddeeff7b1243\"}
}" \
--user 'username':'password'

    返される結果：

    {
  "result": {
    "success": true,
    "reservationInviteeIds": [
      "aa31427f531701103cf7ddeeff7b1243",
      "e231427f531701103cf7ddeeff7b1243"
    ]
  }
}

    WSD Reservation Invitees - POST /api/sn_wsd_rsv/wsd_reservation_invitees/submit

    指定された招待者を指定された予約に追加します。

    URL 形式

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

    デフォルトの URL：/api/sn_wsd_rsv/wsd_reservation_invitees/submit

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    invitees 指定された予約に追加する招待者のリスト。

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

    "invitees": [
  {
    "email": "String",
    "firstName": "String",
    "inviteeId": "String",
    "inviteeType": "String",
    "isVIP": Boolean,
    "isWifiRequired": Boolean,
    "lastName": "String",
    "licensePlate": "String",
    "org": "String",
    "parkingType": "String",
    "phone": "String",
    "privateNotes": "String",
    "title": "String",
    "visitorType": "String"
  }
]
    invitees.email inviteeType が「訪問者」の場合は必須です。
    招待者のメールアドレス。

    データタイプ：文字列
    invitees.firstName 招待者の名。

    データタイプ：文字列
    invitees.inviteeId inviteType が「従業員」の場合は必須です。
    従業員のユーザーレコードの sys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    invitees.inviteeType 必須です。
    招待者のタイプ。
    有効な値： (大文字と小文字を区別)
    • 従業員
    • visitor

    データタイプ：文字列
    invitees.isVIP 招待者が VIP として分類されているかどうかを示すフラグ。
    有効な値：
    • true：招待者は VIP です。
    • false:招待者は VIP ではありません。

    データタイプ：ブーリアン
    invitees.isWifiRequired 入場時に WIFI パスワードを訪問者に提供する必要があるかどうかを示すフラグ。
    有効な値：
    • true：Wi-Fi パスワードを提供します。
    • false:WIFI パスワードを入力しません。

    データタイプ：ブーリアン
    invitees.lastName 招待者の姓。

    データタイプ：文字列
    invitees.licensePlate 招待者のライセンスプレート。

    データタイプ：文字列
    invitees.org 招待者の組織。

    データタイプ：文字列
    invitees.parkingType 招待者に必要な駐車場のタイプ。
    有効な値： (大文字と小文字を区別)
    • ev_parking
    • なし
    • normal_parking
    • van_accessible_parking

    データタイプ：文字列
    invitees.phone 招待者の電話番号。

    データタイプ：文字列
    invitees.privateNotes 招待者によって提供された追加のメモ。

    データタイプ：文字列
    invitees.title 招待者の役職。

    データタイプ：文字列
    invitees.visitorType 招待者のタイプ。
    有効な値： (大文字と小文字を区別)
    • client
    • contractor
    • friend_family
    • others

    データタイプ：文字列
    reservationId 必須です。
    招待者を追加する予約の sys_id。

    データタイプ：文字列

    テーブル:職場予約 [sn_wsd_rsv_reservation]

    ヘッダー

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

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

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    result 招待者を予約に追加した結果。

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

    "result": {
  "reservationId": "String",
  "success": Boolean
}
    result.reservationId 招待者が追加された予約の sys_id。

    データタイプ：文字列
    result.success 招待者が予約に追加されたかどうかを示すフラグ。
    可能な値：
    • true：招待者は正常に追加されました。
    • false：招待者は追加されませんでした。

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

    cURL 要求

    次のコード例は、訪問者と従業員の両方を予約に追加する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_wsd_rsv/v1/wsd_reservation_invitees/submit" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{[
  \"reservationId\": \"041c4a13532f01103cf7ddeeff7b12c0\",
  \"invitees\": [
  {
    \"inviteeType\": \"employee\",
    \"inviteeId\": \"62826bf03710200044e0bfc8bcbe5df1\"
  },
  {
    \"inviteeType\":  \"visitor\",
    \"email\": \"visitoruser@example.com\",
    \"firstName\": \"Visitor\",
    \"lastName\":\"User\",
    \"isVIP\":true,
    \"visitorType\":\"contractor\",
    \"title\": \"ServiceNow Developer\",
    \"phone\": \"+91 9876543210\",
    \"isWifiRequired\": true,
    \"parkingType\": \"ev_parking\",
    \"licensePlate\": \"TS00TS0000\",
    \"org\": \"ServiceNow\",
    \"privateNotes\": \"Remarks\"
  }
]}" \
--user 'username':'password'

    返される結果：

    {
  "result": {
    "success": true,
    "reservationId": "17979dc9536b01103cf7ddeeff7b12b3"
  }
}