WSD Extra Service API

ワシントンDC API リファレンス

Release

washingtondc

ft:locale

ja-JP

ft:publication_title

ワシントンDC API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

WSD Extra Service API

リリースバージョン: Washingtondc

更新日 2024年02月01日

読む24読むのに数分

ワークプレイスサービスデリバリ (WSD) Extra Service API を使用すると、職場の場所のレイアウトや標準サービスなどの追加サービスを取得できます。

この API にアクセスするには、問い合わせユーザーに sn_wsd_core.workplace_user ロールが必要です。

この API は sn_wsd_rsv 名前空間で実行されます。この API にアクセスするには、Workplace Reservation Management (sn_wsd_rsv) プラグインを有効にする必要があります。

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

WSD Extra Service Request - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/reservation/{sys_id}

単一の予約に関連付けられている追加のサービス要求を返します。

注:

このエンドポイントは、グループまたは複数の予約では機能しません。

URL 形式

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

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

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

表 : 1. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、`v1` や `v2`。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
sys_id	追加のサービス要求の詳細を返す予約レコードの sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
なし

表 : 3. 要求本文パラメーター
名前	説明
なし

ヘッダー

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

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

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

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

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

応答本文のパラメーター


名前	説明
result	指定された追加のサービス要求の詳細。データタイプ：オブジェクト `{ "result": { "reservableId": "String", "reservationId": "String", "serviceCategories": {Object}, "serviceTimes": {Object} } }`
result.reservableId	予約が作成される職場の場所の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。データタイプ：文字列
result.reservationId	追加のサービス要求の詳細を返す予約の sys_id。職場予約 [sn_wsd_rsv_reservation] テーブルにあります。データタイプ：文字列
result.serviceCategory	関連する追加サービスのサービスカテゴリに関する詳細。データタイプ： `"serviceCategories": { "String": { "categoryFriendlyName": "String", "categoryCurrencyCode": "String", "comment": "String", "flexibleServices": [Array], "serviceTimes": {Object} } }`
result.serviceCategories.categoryFriendlyName	スペースの配置など、職場サービスまたは追加サービスのカテゴリの分かりやすい名前。データタイプ：文字列
result.serviceCategories.categoryCurrencyCode	職場サービスアイテムまたは追加サービスのコストを計算するために使用される通貨コード。データタイプ：文字列
result.serviceCategories.comment	サービスカテゴリに関するコメント。データタイプ：文字列
result.flexibleService	予約に対して要求された各職場サービスアイテムまたは追加のサービスの詳細。データタイプ：オブジェクトのアレイ "flexibleServices": [ { "capacity": Number, "capacityEnabled": Boolean, "category": "String", "categoryComment": "String", "categoryFriendlyName": "String", "comment": "String", "currencyCode": "String", "deliveryTime": "String", "flexibleServiceId": "String", "flexibleServiceName": "String", "maxCapacity": Number, "quantity": Number, "quantityEnabled": Boolean, "requestId": "String", "serviceItemImage": "String", "servicePrice": Number, "serviceTimes": {Object}, "state": {Object}, "subCategory": {Object}, "totalPrice": Number, } ]
result.serviceCategories.flexibleServices.capacity	職場サービスアイテムを要求するときに要求されるキャパシティ。データタイプ：数値
result.serviceCategories.flexibleServices.capacityEnabled	予約を作成するユーザーが職場のキャパシティを指定できるかどうかを示すフラグ。有効な値： true：ユーザーはキャパシティを指定できます。 false：ユーザーはキャパシティを指定できません。データタイプ：ブーリアン
result.serviceCategories.flexibleServices.category	予約に関連付けられた職場サービスまたは追加サービスのカテゴリの sys_id。データタイプ：文字列
result.serviceCategories.flexibleServices.categoryComment	カテゴリに関する追加のコメント。データタイプ：文字列
result.serviceCategories.flexibleServices.categoryFriendlyName	スペースの配置など、職場サービスまたは追加サービスのカテゴリの分かりやすい名前。データタイプ：文字列
result.serviceCategories.flexibleServices.comment	職場サービスアイテムまたは追加サービスに関する追加コメント。データタイプ：文字列
result.serviceCategories.flexibleServices.currencyCode	関連する職場サービスアイテムまたは追加サービスのコストを計算するために使用される通貨コード。データタイプ：文字列
result.serviceCategories.flexibleServices.deliveryTime	職場サービスアイテムまたは追加サービスの配送時間。データタイプ：文字列形式：UTC：yyyy-mm-ddThh:mm:ssZ (2021-02-05T18:00:00Z など)
result.serviceCategories.flexibleServices.flexibleServiceId	追加サービスまたは職場サービスアイテムの sys_id。[sn_wsd_case_workplace_service_item] テーブルにあります。データタイプ：文字列
result.serviceCategories.flexibleServices.flexibleServiceName	関連する追加サービスまたは職場サービスアイテムの名前。データタイプ：文字列
result.serviceCategories.flexibleServices.maxCapacity	要求可能な職場の最大キャパシティ。データタイプ：数値
result.serviceCategories.flexibleServices.quantity	要求された追加サービスアイテムの数。データタイプ：数値
result.serviceCategories.flexibleServices.quantityEnabled	予約を作成するユーザーがサービスアイテムの数量を指定できるかどうかを示すフラグ。有効な値： true：ユーザーは数量を指定できます。 false：ユーザーは数量を指定できません。データタイプ：ブーリアン
result.serviceCategories.flexibleServices.requestId	追加サービスまたは職場サービスアイテムの sys_id。[sn_wsd_case_service_item_request] テーブルにあります。データタイプ：文字列
result.serviceCategories.flexibleServices.serviceItemImage	職場サービスアイテムのサムネイル画像のファイル名。データタイプ：文字列
result.serviceCategories.flexibleServices.servicePrice	職場サービスアイテムまたは追加サービスのコスト。データタイプ：文字列
result.serviceCategories.flexibleServices.serviceTimes	職場サービスアイテムの準備とクリーンアップにかかる時間の詳細。データタイプ：オブジェクト `"serviceTimes": { "endCleanup": "String", "endPreparation": "String", "startCleanup": "String", "startPreparation": "String" }`
result.serviceCategories.flexibleServices.serviceTimes.endCleanup	職場サービスアイテムのクリーンアップが終了する日時。データタイプ：文字列
result.serviceCategories.flexibleServices.serviceTimes.endPreparation	職場サービスアイテムの準備が終了する日時。データタイプ：文字列
result.serviceCategories.flexibleServices.serviceTimes.startCleanup	職場サービスアイテムのクリーンアップが開始する日時。データタイプ：文字列
result.serviceCategories.flexibleServices.serviceTimes.startPreparation	職場サービスアイテムの準備が開始する日時。データタイプ：文字列
result.serviceCategories.flexibleServices.state	関連する職場サービスアイテムの現在のステータスに関する詳細。データタイプ：オブジェクト `"state": { "display_value": "String", "value": "String" }`
result.serviceCategories.flexibleServices.state.display_value	職場サービスアイテムのステータスの表示値 (Open など)。データタイプ：文字列
result.serviceCategories.flexibleServices.state.value	職場サービスアイテムのステータスの内部値 (Open など)。データタイプ：文字列
result.serviceCategories.flexibleServices.subCategory	関連する職場サービスアイテムのサブカテゴリに関する詳細。データタイプ：オブジェクト `"subCategory": { "display_value": "String", "value": "String" }`
result.serviceCategories.flexibleServices.subCategory.display_value	職場サービスアイテムまたは追加サービスのサブカテゴリ (椅子のレイアウト、ドリンク、IT サポートなど) の表示値。データタイプ：文字列
result.serviceCategories.flexibleServices.subCategory.value	職場サービスアイテムまたは追加サービスのサブカテゴリの内部値 (chair_layout、drinks、IT_support など)。データタイプ：文字列
result.serviceCategories.flexibleServices.total_price	予約に対する職場サービスアイテムまたは追加サービスの総コスト。データタイプ：数値
result.serviceTime	職場サービスアイテムの準備とクリーンアップにかかる時間の詳細。データタイプ：オブジェクト `"serviceTimes": { "endCleanup": "String", "endPreparation": "String", "startCleanup": "String", "startPreparation": "String" }`
result.serviceTimes.endCleanup	職場サービスアイテムのクリーンアップが終了する日時。データタイプ：文字列
result.serviceTimes.endPreparation	職場サービスアイテムの準備が終了する日時。データタイプ：文字列
result.serviceTimes.startCleanup	職場サービスアイテムのクリーンアップが開始する日時。データタイプ：文字列
result.serviceTimes.startPreparation	職場サービスアイテムの準備が開始する日時。データタイプ：文字列

cURL 要求

このコード例は、予約に対する追加サービスまたは職場サービスアイテムの詳細を要求する方法を示しています。

curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_extra_service_request/reservation/383e36c1536f01103cf7ddeeff7b1245" \
--request GET \
--header "Accept:application/json" \
--user "username": "password"

返される結果：

{
  "result": {
    "reservationId": "383e36c1536f01103cf7ddeeff7b1245",
    "serviceTimes": {
      "startPreparation": "2022-05-17T11:45:00ZZ",
      "endPreparation": "2022-05-17T12:00:00ZZ",
      "startCleanup": "2022-05-17T13:00:00ZZ",
      "endCleanup": "2022-05-17T13:15:00ZZ"
    },
    "reservableId": "02000d4edb7650106c731dcd13961914",
    "serviceCategories": {
      "50723fbf07100110c9b36b6e0ad300b4": {
        "serviceTimes": {
          "startPreparation": "2022-05-17T11:45:00Z",
          "endPreparation": "2022-05-17T12:00:00Z",
          "startCleanup": "2022-05-17T13:00:00Z",
          "endCleanup": "2022-05-17T13:15:00Z"
        },
        "flexibleServices": [
          {
            "requestId": "743eb605536f01103cf7ddeeff7b126b",
            "category": "50723fbf07100110c9b36b6e0ad300b4",
            "categoryComment": "test2",
            "subCategory": {
              "value": "chair_layout",
              "display_value": "Chair layout"
            },
            "categoryFriendlyName": "Space arrangement",
            "servicePrice": 0,
            "serviceItemImage": "4c6a0d7107600110c9b36b6e0ad300fc.iix",
            "currencyCode": "GBP",
            "totalPrice": 0,
            "flexibleServiceId": "21e2c08407600110c9b36b6e0ad3007c",
            "flexibleServiceName": "Theater Style",
            "deliveryTime": "2022-05-17 12:00:00",
            "comment": "test1",
            "quantity": 1,
            "capacity": 1,
            "quantityEnabled": false,
            "capacityEnabled": true,
            "maxCapacity": null,
            "state": {
              "value": "2",
              "display_value": "Work in Progress"
            },
            "serviceTimes": {
              "startPreparation": "2022-05-17T11:45:00Z",
              "endPreparation": "2022-05-17T12:00:00Z",
              "startCleanup": "2022-05-17T13:00:00Z",
              "endCleanup": "2022-05-17T13:15:00Z"
            }
          }
        ],
        "comment": "test2",
        "categoryFriendlyName": "Space arrangement",
        "categoryCurrencyCode": "GBP"
      }
    }
  }
}

WSD Extra Service Request - PATCH /api/sn_wsd_rsv/wsd_extra_service_request/submit

指定された単一の予約に新しい追加のサービス要求を追加するか、既存の追加のサービス要求を更新します。

注: