WSD Extra Service Request API

Xanadu API リファレンス

Release

xanadu

ft:locale

ja-JP

ft:publication_title

Xanadu API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

WSD Extra Service Request API

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：10分

ワークプレイスサービスデリバリ (WSD) 追加サービス要求 API は、予約の追加サービス要求を管理するためのエンドポイントを提供します。

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

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

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

WSD Extra Service - GET /sn_wsd_rsv/extra_service/list_loc_layouts

指定された職場の場所に関連する場所のレイアウトの詳細を返します。

URL 形式

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

デフォルトの URL：/api/sn_wsd_rsv/extra_service/list_loc_layouts

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

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

表 : 2. クエリパラメーター
名前	説明
location	必須です。場所レイアウトの詳細を返す職場の場所の sys_id。職場の場所 [sn_wsd_core_workplace_location] テーブルにあります。データタイプ：文字列

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

ヘッダー

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

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

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

ステータスコード

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

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

応答本文のパラメーター


名前	説明
result	指定された職場の場所に関連付けられたレイアウトのリスト。データタイプ：オブジェクトのアレイ `"result": [ { "capacity": Number, "cleanup_duration": "String", "image": {Object}, "is_default": Boolean, "max_capacity": Number, "name": "String", "preparation_duration": "String", "short_description": "String", "sys_id": "String" } ]`
result.capacity	会議に出席する人数。データタイプ：数値
result.cleanup_duration	このレイアウトの予約可能項目の除去にかかる時間。データタイプ：数値単位：ミリ秒
result.image	関連する予約可能項目のレイアウトを表す画像の詳細。画像 [db_image] テーブルにあります。 `"image": { "link": "String", "sys_id": "String" }`
result.image.link	この予約可能項目のレイアウトを表す画像へのリンク。画像 [db_image] テーブルにあります。データタイプ：文字列
result.image.sys_id	関連する画像レコードの sys_id。データタイプ：文字列
result.is_default	関連付けられたレイアウトが予約可能項目のデフォルトかどうかを示すフラグ。有効な値： true：デフォルト。 false：デフォルトではない。データタイプ：ブール
result.name	場所のレイアウトの名前。データタイプ：文字列
result.max_capacity	予約可能項目に関連付けられたレイアウトで収容できる最大人数。データタイプ：数値
result.preparation_duration	関連付けられた場所のレイアウトの準備にかかる時間。データタイプ：数値単位：ミリ秒
result.short_description	場所のレイアウトの簡単な説明。データタイプ：文字列
result.sys_id	場所のレイアウトの sys_id。レイアウト [sn_wsd_rsv_layout] テーブルにあります。データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

"http://instance.servicenow.com/api/sn_wsd_rsv/extra_service/list_loc_layouts&location=d2716d4adb7210106c731dcd13961994" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

返される結果：

{
  "result": [
    {
      "sys_id": "f4fee556534301103cf7ddeeff7b12ed",
      "name": "Test",
      "short_description": "test",
      "is_default": false,
      "image": {
        "sys_id": "9648a7c5531301103cf7ddeeff7b1286",
        "link": "9648a7c5531301103cf7ddeeff7b1286.iix"
      },
      "capacity": null,
      "max_capacity": null,
      "preparation_duration": 172800000,
      "cleanup_duration": 86400000
    }
  ]
}

WSD Extra Service - GET /api/sn_wsd_rsv/extra_service/list_loc_standard_services

指定された職場の場所に関連する標準サービスの詳細を返します。