サービスカタログ API

サービスカタログ API は、サービスポータル内からサービスカタログ設定とアクションにアクセスするエンドポイントを提供します。

Service Catalog - DELETE /sn_sc/servicecatalog/cart/{cart_item_id}

指定されたアイテムを現在の買い物かごから削除します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

デフォルトの URL:/api/sn_sc/servicecatalog/cart/{cart_item_id}

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

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

データタイプ:文字列

cart_item_id 現在の買い物かごから削除するアイテムの sys_id。

データタイプ:文字列

表 : 2. クエリパラメーター
名前 説明
なし
表 : 3. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

ステータスコード

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

表 : 6. ステータスコード
ステータスコード 説明
204 要求が正常に完了し、指定されたアイテムが買い物かごから削除されたことを示します。
400 指定された cart_item_id が無効であるか、またはユーザーに買い物かごアイテムへのアクセス権がないことを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
なし

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc" \
--request DELETE \
--user "username":"password"
None

Service Catalog - DELETE /sn_sc/servicecatalog/cart/{sys_id}/empty

指定された買い物かごとその内容を削除します。

ユーザーが何を削除できるか (アイテムや買い物かご) は、ユーザーが認証に使用するロールによって異なります。

買い物かごと買い物かごの内容を削除するために必要なユーザーロール:
  • admin/catalog_admin:任意のユーザーの買い物かごを空にすることができます。
  • admin:買い物かごのすべての内容を削除した後、買い物かごを削除できます。
  • catalog_admin:買い物かご内のすべてのアイテムを削除できます。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty

デフォルトの URL:/api/sn_sc/servicecatalog/cart/{sys_id}/empty

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

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

データタイプ:文字列

sys_id 空にして削除する買い物かごの sys_id。

データタイプ:文字列

表 : 8. クエリパラメーター
名前 説明
なし
表 : 9. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

表 : 10. 要求ヘッダー
ヘッダー 説明
なし
表 : 11. 応答ヘッダー
ヘッダー 説明
なし

ステータスコード

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

表 : 12. ステータスコード
ステータスコード 説明
204 要求は正常に完了し、買い物かごを空にして削除します。
400 次のいずれかの理由によるエラーを示します。
  • 無効な cartId。
  • ユーザーが admin/catalog_admin ロールを持っていないか、別のユーザーの買い物かごを空にしようとしています。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
なし

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty" \
--request DELETE \
--user 'username':'password'
None

Service Catalog - GET /sn_sc/servicecatalog/cart

ログインしているユーザーの買い物かご内のアイテムの詳細を取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart

デフォルトの URL:/api/sn_sc/servicecatalog/cart

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

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

データタイプ:文字列

表 : 14. クエリパラメーター
名前 説明
なし
表 : 15. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 18. ステータスコード
ステータスコード 説明
200 要求が正常に完了したことを示します。買い物かごにアイテムがない場合は、ユーザーの基本的な買い物かご情報と価格設定が返されます。買い物かごにアイテムが含まれている場合は、アイテムとそれらの個々の価格設定に関する情報も含まれます。
400 買い物かごが空でチェックアウトできないことを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

パラメーター 説明
cart_id 買い物かごの sys_id。

データタイプ:文字列

<recurring_frequency> 買い物かご内で特定の発生頻度で繰り返されるアイテムのリスト。可能な値には次のようなものがあります。
  • daily
  • monthly
  • yearly
  • none (定期料金なし)

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

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
<recurring_frequency>.frequency_label 関連する定期料金の頻度。

データタイプ:文字列

デフォルト:Null

<recurring_frequency>.items 指定された繰り返し発生頻度カテゴリに関連付けられた各アイテムの詳細を含むオブジェクトのリスト。

データタイプ:アレイ

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id この買い物かご内のアイテムの sys_id。

データタイプ:文字列

<recurring_frequency>.items.catalog_item_id アイテムに関連付けられたカタログの sys_id。

データタイプ:文字列

<recurring_frequency>.items.created.by 最初に買い物かごにアイテムを入れたユーザー。

データタイプ:文字列

<recurring_frequency>.items.created_on アイテムが最初に買い物かごに入れられた日付。

データタイプ:文字列

<recurring_frequency>.items.delivery_time 指定されたアイテムの配送にかかる時間。

データタイプ:文字列

<recurring_frequency>.items.item_id アイテムのカタログ sys_id。

データタイプ:文字列

<recurring_frequency>.items.item_name 指定されたアイテムの名前。

データタイプ:文字列

<recurring_frequency>.items.localized_price 現地通貨でのアイテムの価格。

データタイプ:文字列

<recurring_frequency>.items.localized_recurring_price 指定されたアイテムの定期料金 (現地通貨)。

データタイプ:文字列

<recurring_frequency>.items.name アイテム名。

データタイプ:文字列

<recurring_frequency>.items.order_guide このアイテムが関連付けられている注文ガイドの名前。

データタイプ:文字列

<recurring_frequency>.items.picture アイテムの画像のファイル名。

データタイプ:文字列

<recurring_frequency>.items.price アイテムの価格です。

データタイプ:文字列

<recurring_frequency>.items.quantity 買い物かご内の指定されたアイテムの数。

データタイプ:文字列

<recurring_frequency>.items.recurring_frequency 指定されたアイテムに対して定期料金が請求される頻度。

データタイプ:文字列

デフォルト:Null

<recurring_frequency>.items.recurring_price 指定されたアイテムの定期料金。

データタイプ:文字列

<recurring_frequency>.items.recurring_subtotal アイテムの定期料金の小計 (recurring_price x quantity)。

データタイプ:数値

<recurring_frequency>.items.recurring_subtotal_price アイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.items.short_description アイテムの短い説明。

データタイプ:文字列

<recurring_frequency>.items.show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの価格を表示します。
  • false:買い物かご内のアイテムの価格を表示しません。

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

<recurring_frequency>.items.show_quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの数量を表示します。
  • false:買い物かご内のアイテムの数量を表示しません。

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

<recurring_frequency>.items.show_recurring_price 買い物かご内で定期料金を表示する必要があるかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の定期料金を表示します。
  • false:買い物かご内の定期料金を表示しません。

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

<recurring_frequency>.items.subtotal アイテム数の小計。

データタイプ:数値

<recurring_frequency>.items.subtotal_price アイテムの小計 (price x quantity)。

データタイプ:文字列

<recurring_frequency>.items.sys_class_name アイテムのシステム分類名。

データタイプ:文字列

<recurring_frequency>.items.sys_id アイテムレコードの sys_id。

データタイプ:文字列

<recurring_frequency>.items.updated_by 最初に買い物かごに入れた後にアイテムを更新したユーザー。

データタイプ:文字列

<recurring_frequency>.items.updated_on アイテムが最初に買い物かごに入れられたか、更新された最終日時。

データタイプ:文字列

<recurring_frequency>.items.variables アイテム変数の名前/値ペアのリスト。

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

<recurring_frequency>.show_subtotal_price 関連する定期料金カテゴリの小計を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の小計を表示します。
  • false:買い物かご内の小計を表示しません。

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

<recurring_frequency>.subtotal_price 関連する繰り返し発生頻度カテゴリに関するすべてのアイテムのコスト小計。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。subtotal_recurring_frequency と同じです。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_price 関連する繰り返し発生頻度カテゴリ内のアイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.subtotal_title show_subtotal_pricetrue に設定されている場合、買い物かごに表示される関連するサブタイトルのテキスト。

データタイプ:文字列

<recurring_frequency>.total_title 関連する繰り返し発生頻度カテゴリの合計タイトルに表示するテキスト。

データタイプ:文字列

show_subtotal_price 買い物かご内で小計の価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の小計を表示します。
  • false:買い物かご内の小計を表示しません。

データタイプ:文字列

subtotal_price 買い物かご内のすべてのアイテムの小計 (ドル単位)。

データタイプ:文字列

subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。<recurring_frequency>.subtotal_recurring_frequency と同じです。

データタイプ:文字列

subtotal_recurring_price 買い物かご内にあるすべてのアイテムの繰り返し発生頻度料金の小計。

データタイプ:文字列

subtotal_title 小計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

total_title 合計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "cart_id": "6d88bc29137d2300027879d96144b04b",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
      {
        "updated_on": "2018-11-15 14:24:00",
        "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "short_description": "Apple iPhone 7 ",
        "recurring_subtotal_price": "$0.00",
        "delivery_time": "2 Days",
        "sys_class_name": "sc_cat_item",
        "sys_id": "1f88bc29137d2300027879d96144b056",
        "price": "$799.00",
        "recurring_frequency": null,
        "subtotal_price": "$799.00",
        "variables": {},
        "quantity": "1",
        "item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "recurring_price": "$0.00",
        "show_price": true,
        "item_name": "Apple iPhone7",
        "cart_item_id": "1f88bc29137d2300027879d96144b056",
        "recurring_subtotal": 0,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
        "created_on": "2018-11-15 14:24:00",
        "localized_price": "$799.00",
        "subtotal": 799,
        "show_recurring_price": false,
        "name": "Apple iPhone7",
        "updated_by": "admin",
        "localized_recurring_price": "$0.00",
        "order_guide": ""
      },
    ],
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
   },
   "show_subtotal_price": "true",
   "subtotal_title": "Subtotal"
 }
}

Service Catalog - GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}

glide.sc.req_for.roles プロパティ、および glide.sc.req_for.roles.defaultproperty で構成されたデフォルトの動作に基づいて、指定されたユーザーの出荷先を取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}

デフォルトの URL:/api/sn_sc/servicecatalog/cart/delivery_address/{user_id}

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

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

データタイプ:文字列

user_id 出荷先を取得するユーザーの sys_id。ユーザー [sys_user] テーブルにあります。

データタイプ:文字列

表 : 20. クエリパラメーター
名前 説明
なし
表 : 21. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 24. ステータスコード
ステータスコード 説明
200 要求が正常に完了しました。指定されたユーザーの出荷先を返します。
400 ユーザー sys_id が無効です。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
result 指定されたユーザーのアドレス。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
'result': '25 New Chardon Street, Boston\nBoston, MA, 02114-1801\nUSA'
}

Service Catalog - GET /sn_sc/servicecatalog/catalogs

渡されたパラメーターに基づいて、ユーザーがアクセスできるカタログのリストを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/catalogs

デフォルトの URL:/api/sn_sc/servicecatalog/catalogs

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

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

データタイプ:文字列

表 : 26. クエリパラメーター
名前 説明
sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。

この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。

注:
異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。

データタイプ:数値

デフォルト:10000

sysparm_text 利用可能なサービスカタログの「タイトル」フィールドで検索するキーワード。

データタイプ:文字列

sysparm_view アイテムを表示できるデバイス:
  • desktop:デスクトップ上。
  • mobile:モバイルデバイス上。
  • both:デスクトップとモバイルデバイスの両方。

データタイプ:文字列

表 : 27. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 30. ステータスコード
ステータスコード 説明
200 要求が正常に完了したことを示します。有効なクエリで結果が返されなかった場合、応答の本文には空の結果アレイのみが含まれます。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
description カタログの説明

データタイプ:文字列

desktop_image desktop_image

データタイプ:文字列

has_categories カタログにカテゴリが含まれているかどうかを示すフラグ。
可能な値:
  • true:カタログにカテゴリが含まれています。
  • false:カタログにカテゴリは含まれていません。

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

has_items カタログにアイテムが含まれているかどうかを示すフラグ。
可能な値:
  • true:カタログにアイテムが含まれています。
  • false:カタログにアイテムは含まれていません。

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

sys_id カタログの sys_id。

データタイプ:文字列

title カタログタイトル。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "title": "Technical Catalog",
      "sys_id": "742ce428d7211100f2d224837e61036d",
      "has_categories": true,
      "has_items": true,
      "description": "Products and services for the IT department",
      "desktop_image": "7a7c8271475211002ee987e8dee4906d.iix"
    },
    {
      "title": "Service Catalog",
      "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
      "has_categories": true,
      "has_items": true,
      "description": "Service Catalog - IT Now",
      "desktop_image": "adbcc271475211002ee987e8dee49001.iix"
    }
  ]
}

Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories

指定されたカタログで利用可能なカテゴリのリストを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories

デフォルトの URL:/api/sn_sc/servicecatalog/catalogs/{sys_id}/categories

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

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

データタイプ:文字列

sys_id カテゴリが要求されているカタログの sys_id。

データタイプ:文字列

表 : 32. クエリパラメーター
名前 説明
sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。

この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。

注:
異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。

データタイプ:数値

デフォルト:10000

sysparm_offset レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。

たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「sysparm_offset=sysparm_offset+sysparm_limit」を使用します。

sysparm_offset パラメーターに負の数値を渡さないでください。

データタイプ:数値

デフォルト:0

sysparm_top_level_only 親がカタログであるカテゴリのみを返します。
有効な値:
  • true:親がカタログであるカテゴリのみを返します。
  • false:すべてのカテゴリを返します。

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

sysparm_view データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。

有効な値:

  • desktop
  • mobile
  • both

sysparm_fields パラメーターが優先されます (指定した場合)。

データタイプ:文字列

表 : 33. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 36. ステータスコード
ステータスコード 説明
200 カタログ内のカテゴリのリストを返します。クエリ結果がない場合は、空の配列が返されます。
400 要求またはカタログの sys_id が無効であることを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
count カテゴリ内のアイテムの数。

データタイプ:数値

description カテゴリの簡単な説明。

データタイプ:文字列

完全な説明 カテゴリの詳細な説明。

データタイプ:文字列

header_icon カテゴリヘッダー上で使用されるアイコン。

データタイプ:文字列

homepage_image カテゴリのホームページでこのカテゴリに表示される画像。

データタイプ:文字列

icon このカテゴリを示すために使用するアイコン。

データタイプ:文字列

サブカテゴリ カテゴリ内のサブカテゴリのリスト。

データタイプ:アレイ

"subcategories": [
  "sys_id": "String",
  "title": "String
]
subcategories.sys_id サブカテゴリの sys_id。

データタイプ:文字列

subcategories.title サブカテゴリのタイトル。

データタイプ:文字列

sys_id カテゴリの sys_id。

データタイプ:文字列

title カテゴリのタイトル。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "title": "Can We Help You?",
      "description": "Your IT gateway. Report issues and submit requests.\n\t\t",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "29f8ffa9471211002ee987e8dee4905e.iix",
      "count": 14,
      "subcategories": [],
      "sys_id": "e15706fc0a0a0aa7007fc21e1ab70c2f"
    },
    {
      "title": "Departmental Services",
      "description": "Services offered by different departments in the organization",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "6fb4a1d95f2211001c9b2572f2b47748.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "95fc11615f1211001c9b2572f2b477c6"
    },
    {
      "title": "Desktops",
      "description": "Desktop computers for your work area.",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "1bface31475211002ee987e8dee49095.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "900682363731300054b6a3549dbe5d5f"
    }
  ]
}

Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}

指定されたカタログの利用可能な情報を取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}

デフォルトの URL:/api/sn_sc/servicecatalog/catalogs/{sys_id}

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

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

データタイプ:文字列

sys_id 取得するカタログの sys_id。

データタイプ:文字列

表 : 38. クエリパラメーター
名前 説明
sysparm_view アイテムを表示できるデバイス:
  • desktop:デスクトップ上。
  • mobile:モバイルデバイス上。
  • both:デスクトップとモバイルデバイスの両方。

データタイプ:文字列

表 : 39. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 42. ステータスコード
ステータスコード 説明
200 要求が正常に完了し、指定されたカタログの利用可能な情報を返すことを示します。
400 次のいずれかの理由により要求が無効であることを示します。
  • ユーザーにカタログへのアクセス権がありません。
  • 無効な sys_id。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
カテゴリ カタログ内のカテゴリを記述するオブジェクトのリスト。

データタイプ:アレイ

"categories": [
  "description": "String",
  "header_image": "String",
  "sys_id": "String",
  "title": "String
]
categories.description カテゴリの説明。

データタイプ:文字列

categories.header_image カテゴリヘッダー画像。

データタイプ:文字列

categories.sys_id 一意のカテゴリ識別子 (sys_id)。

データタイプ:文字列

categories.title カテゴリのタイトル。

データタイプ:文字列

description カタログの説明

データタイプ:文字列

desktop_image デスクトップビューでカタログとともに表示される画像のソース。

データタイプ:文字列

has_categories カタログにカテゴリが含まれているかどうかを示すフラグ。
可能な値:
  • true:カタログにカテゴリが含まれています。
  • false:カタログにカテゴリは含まれていません。

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

has_items カテゴリ内にアイテムがあるかどうかを示すフラグ。
可能な値:
  • true:カタログにアイテムが関連付けられています。
  • false:カタログにアイテムが関連付けられていません。

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

sys_id 一意のカタログ sys_id。

データタイプ:文字列

title カタログタイトル。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.comaqsw" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Customer Service",
    "sys_id": "65bcd377c3011200b12d9f2974d3aea0",
    "has_categories": true,
    "categories": [
      {
        "header_image": "",
        "sys_id": "4cb69d19c3921200b0449f2974d3ae69",
        "description": null,
        "title": "Services"
      },
      {
        "header_image": "",
        "sys_id": "1b8611d5c3921200b0449f2974d3ae12",
        "description": null,
        "title": "Support"
      }
    ],
    "has_items": true,
    "description": "Customer Service",
    "desktop_image": ""
  }
}

Service Catalog - GET /sn_sc/servicecatalog/categories/{sys_id}

指定されたカタログの利用可能な情報を取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}

デフォルトの URL:/api/sn_sc/servicecatalog/categories/{sys_id}

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

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

データタイプ:文字列

sys_id 情報を返すカテゴリの sys_id。

データタイプ:文字列

表 : 44. クエリパラメーター
名前 説明
sysparm_view データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。

有効な値:

  • desktop
  • mobile
  • both

sysparm_fields パラメーターが優先されます (指定した場合)。

データタイプ:文字列

表 : 45. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 48. ステータスコード
ステータスコード 説明
200 成功。要求が正常に処理されました。
400 次のいずれかの理由により要求が無効であることを示します。
  • ユーザーにカテゴリへのアクセス権がありません。
  • 無効な sys_id。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
child_categories このカテゴリに属する子カテゴリを記述するオブジェクトのリスト。

データタイプ:アレイ

"child_categories": [
  "count": Number,
  "isParentCategory": "String",
  "parent": "String",
  "subcategories": [Array],
  "sys_id": "String",
  "title": "String"
]
child_categories.count 子カテゴリのアイテムの数。

データタイプ:数値

child_categories.isParentCategory これが親カテゴリかどうかを示すフラグ。
可能な値:
  • true:親カテゴリです。
  • false:親カテゴリではありません。

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

child_categories.parent 子カテゴリの親の sys_id。

データタイプ:文字列

child_categories.subcategories この子カテゴリのサブカテゴリを記述するオブジェクトのリスト。

データタイプ:アレイ

"subcategories": [
  "sys_id": "String",
  "title": "String"
]
child_categories.subcategories.sys_id 子サブカテゴリの sys_id。

データタイプ:文字列

child_categories.subcategories.title 子サブカテゴリのタイトル。

データタイプ:文字列

child_categories.sys_id 子カテゴリの sys_id。

データタイプ:文字列

child_categories.title 子カテゴリのタイトル。

データタイプ:文字列

description カテゴリの短い説明。

データタイプ:文字列

full_description カテゴリの詳細な説明。

データタイプ:文字列

header_icon カテゴリがトップレベルのカテゴリにリストされている場合、カテゴリヘッダーの横に表示されるアイコンのソース。

データタイプ:文字列

homepage_image カテゴリのホームページ画像のソース。

データタイプ:文字列

icon カテゴリがサブカテゴリとしてリストされている場合、カテゴリ名の横に表示される小さなアイコンのソース。

データタイプ:文字列

sys_id カテゴリの sys_id。

データタイプ:文字列

title カテゴリのタイトル。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "title": "Office",
    "description": "Office services such as printing, supplies requisition\n\t\t\tand document shipping and delivery.\n\t\t",
    "full_description": null,
    "icon": "",
    "header_icon": "",
    "homepage_image": "498b0271475211002ee987e8dee490ea.iix",
    "sys_id": "109cdff8c6112276003b17991a09ad65",
    "child_categories": [
      {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services",
        "count": 16,
        "parent": "109cdff8c6112276003b17991a09ad65",
        "subcategories": [],
        "isParentCategory": false
      }
    ]
  }
}

Service Catalog - GET /sn_sc/servicecatalog/items

指定されたパラメーターに基づいて、カタログアイテムのリストを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items

デフォルトの URL:/api/sn_sc/servicecatalog/items

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

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

データタイプ:文字列

表 : 50. クエリパラメーター
名前 説明
sysparm_catalog アイテムのカタログ sys_id。このパラメーターを使用して、特定のカタログ内のアイテムを見つけます。

データタイプ:文字列

sysparm_category アイテムのカテゴリ sys_id。このパラメーターを使用して、特定のカテゴリ内のカタログアイテムを見つけます。

データタイプ:文字列

sysparm_limit 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。

この制限は、ACL 評価の前に適用されます。アクセスできるレコードが含まれているのにレコードが何も返されない場合は、アクセスできるレコードが最初に返されるようにレコードの順序を並べ替えます。

注:
異常に大きい sysparm_limit 値はシステムパフォーマンスに影響する可能性があります。

データタイプ:数値

デフォルト:10000

sysparm_offset レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。

たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「sysparm_offset=sysparm_offset+sysparm_limit」を使用します。

sysparm_offset パラメーターに負の数値を渡さないでください。

データタイプ:数値

デフォルト:0

sysparm_text カテゴリアイテムを検索するための特定のテキスト。たとえば、sysparm_text="iPhone"sysparm_text="Mobile devices" などです。

データタイプ:文字列

sysparm_type アイテムのタイプ。

有効な検索値:

  • レコードプロデューサー
  • 注文ガイド
他の値が渡された場合、その情報は無視されます。

データタイプ:文字列

sysparm_view データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。

有効な値:

  • desktop
  • mobile
  • both

sysparm_fields パラメーターが優先されます (指定した場合)。

データタイプ:文字列

表 : 51. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 54. ステータスコード
ステータスコード 説明
200 指定されたパラメーターに基づいて、カタログとアイテムのリストを返します。有効なクエリの結果にアイテムがない場合、応答の本文には空の結果アレイのみが含まれます。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

パラメーター 説明
catalogs このアイテムを含むカタログを記述するオブジェクトのリスト。

データタイプ:アレイ

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
catalogs.sys_id カタログの sys_id。

データタイプ:文字列

catalogs.title カタログタイトル。

データタイプ:文字列

category category

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

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id カテゴリの sys_id。

データタイプ:文字列

category.title カテゴリのタイトル。

データタイプ:文字列

content_type コンテンツのタイプ。

データタイプ:文字列

description アイテムの詳細な説明。

データタイプ:文字列

icon アイテム名の横に表示される小さなアイコンのソース。

データタイプ:文字列

kb_article アイテムに関連付けられたナレッジベースの記事。

データタイプ:文字列

local_currency 現地通貨の国通貨コード。

データタイプ:文字列

localized_price local_currency で定義された通貨で表されるアイテムの価格。

データタイプ:文字列

localized_recurring_price local_currency で定義された通貨で表される定期料金の価格。

データタイプ:文字列

name アイテムの名前。

データタイプ:文字列

order アイテムが属する事前定義された順序。

データタイプ:数値

画像 アイテムに表示する画像へのパス。

データタイプ:文字列

price price_currency で定義された通貨で表されるアイテムの価格。

データタイプ:文字列

price_currency アイテムの価格が表わされる国の通貨コード。

データタイプ:文字列

recurring_frequency 定期料金が適用される頻度 (日次、月次、年次など)。アイテムに料金がない場合は null です。

データタイプ:文字列

recurring_price アイテムに関連付けられた定期料金の金額。

データタイプ:文字列

recurring_price_currency 定期料金が表わされる国の通貨コード。

データタイプ:文字列

short_description アイテムの簡単な説明。

データタイプ:文字列

show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。
可能な値:
  • true:名前と値のペアが応答パラメーターで返されます。
  • false:名前と値のペアが応答パラメーターで返されません。

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

show_quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの数量を表示します。
  • false:買い物かご内のアイテムの数量を表示しません。

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

sys_class_name レコードが属するテーブル (sc_cat_item_producer など)。

データタイプ:文字列

sys_id アイテムの sys_id。

データタイプ:文字列

type アイテムのタイプ。

データタイプ:文字列

url アイテムの URL。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": [
    {
      "short_description": null,
      "kb_article": "",
      "icon": "images/icons/catalog_item.gifx",
      "description": "<p class=\"p1\"><font size=\"2\"><span class=\"s1\">Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.</span></font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "",
      "url": "",
      "sys_id": "011f117a9f3002002920bde8132e7020",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Retire a Standard Change Template",
      "category": {
        "sys_id": "00728916937002002dcef157b67ffb6d",
        "title": "Template Management"
      },
      "order": 30
    },
    {
      "short_description": null,
      "kb_article": "",
      "icon": "4cc3ec3d471211002ee987e8dee490d0.iix",
      "description": "<p><font size=\"3\" color=\"#808080\" face=\"arial,helvetica,sans-serif\">A role delegator may delegate any role they have to any member of the specified group</font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "ed44b5804f889200086eeed18110c7ca.iix",
      "url": "",
      "sys_id": "01205b180a0a0b3000b6efd641d24b75",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Grant role delegation rights within a group",
      "category": {
        "sys_id": "496a3a7e0a0a0bc00089b39df14eb56e",
        "title": "Role Delegation"
      },
      "order": 100
    }
  ]
}

Service Catalog - GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

指定された代理人ユーザーが、指定されたサービスカタログアイテムに対する取得権を持っているかどうかを確認します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

デフォルトの URL:/api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

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

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

データタイプ:文字列

item_sys_id 指定されたユーザーが取得権を持っているかどうかを確認するためのサービスカタログアイテムの sys_id。サービスカタログ [sc_catalog] テーブルにあります。

データタイプ:文字列

user_sys_id 指定されたサービスカタログアイテムに対する取得権を持っているかどうかを確認するユーザーの sys_id。ユーザー [sys_users] テーブルにあります。

データタイプ:文字列

表 : 56. クエリパラメーター
名前 説明
なし
表 : 57. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)

名前 説明
result 指定されたユーザーが、指定されたサービスカタログアイテムに対する取得権を持っているかどうかを示すフラグ。
有効な値:
  • true:ユーザーは取得権を持っています。
  • false:ユーザーは取得権を持っていません。

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

Service Catalog - GET /sn_sc/servicecatalog/items/{sys_id}

指定されたカタログアイテムを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}

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

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

データタイプ:文字列

sys_id 返すカタログアイテムの sys_id。

データタイプ:文字列

表 : 62. クエリパラメーター
名前 説明
sysparm_view データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。

有効な値:

  • desktop
  • mobile
  • both

sysparm_fields パラメーターが優先されます (指定した場合)。

データタイプ:文字列

表 : 63. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 66. ステータスコード
ステータスコード 説明
200 要求が正常に完了し、カタログアイテムの詳細を返すことを示します。
400 次のいずれかの理由により要求が無効であることを示します。
  • ユーザーにカタログアイテムへのアクセス権がありません。
  • 無効な sys_id。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
catalogs このアイテムを含むカタログを記述するオブジェクトのリスト。

データタイプ:アレイ

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
catalogs.sys_id カタログの sys_id。

データタイプ:文字列

catalogs.title カタログタイトル。

データタイプ:文字列

カテゴリ このアイテムを含むカテゴリを記述するオブジェクトのリスト。

データタイプ:アレイ

"categories": [{
  "active": Boolean,
  "category": {Object},
  "sys_id": "String",
  "title": "String"
}]
categories.active カテゴリがアクティブかどうかを示すフラグ。
可能な値:
  • true:カテゴリはアクティブです。
  • false:カテゴリは非アクティブです。

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

categories.category 関連するカテゴリを記述します。

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

"category": {
  "active": Boolean,
  "sys_id": "String",
  "title": "String"
}
categories.category.active カテゴリがアクティブかどうかを示すフラグ。
可能な値:
  • true:カテゴリはアクティブです。
  • false:カテゴリは非アクティブです。

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

categories.category.sys_id カテゴリの sys_id。

データタイプ:文字列

categories.category.title カテゴリのタイトル。

データタイプ:文字列

categories.sys_id categories.category で指定されたカテゴリの親カテゴリ。

データタイプ:文字列

category アイテムが属するプライマリカテゴリ。

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

"category": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id プライマリカテゴリの sys_id。

データタイプ:文字列

category.title プライマリカテゴリのタイトル。

データタイプ:文字列

client_script カタログアイテムで定義されているすべてのカタログクライアントスクリプトのリスト。

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

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
client_script.onChange アイテムに関連付けられた onChange クライアントスクリプトのリスト。

データタイプ:アレイ

client_script.onSubmit アイテムに関連付けられた onSubmit クライアントスクリプトのリスト。

データタイプ:アレイ

client_script.onLoad アイテムに関連付けられた onLoad クライアントスクリプトのリスト。

データタイプ:アレイ

content_type コンテンツのタイプ。

データタイプ:文字列

data_lookup カタログアイテムで定義されたデータルックアップのリスト。

データタイプ:アレイ

description アイテムの詳細な説明。

データタイプ:文字列

icon アイテム名の横に表示される小さなアイコンのソース。

データタイプ:文字列

kb_article アイテムに関連付けられたナレッジベースの記事。

データタイプ:文字列

local_currency 現地通貨の国通貨コード。

データタイプ:文字列

localized_price local_currency で定義された通貨で表されるアイテムの価格。

データタイプ:文字列

localized_recurring_price local_currency で定義された通貨で表される定期料金の価格。

データタイプ:文字列

name アイテムの名前。

データタイプ:文字列

order アイテムの注文の数。

データタイプ:数値

画像 アイテムに表示する画像のファイル名。

データタイプ:文字列

price price_currency で定義された通貨で表されるアイテムの価格。

データタイプ:文字列

price_currency アイテムの価格が表わされる国の通貨コード。

データタイプ:文字列

recurring_frequency 定期料金が適用される頻度 (日次、月次、年次など)。

データタイプ:文字列

recurring_price アイテムに関連付けられた定期料金の金額。

データタイプ:文字列

recurring_price_currency 定期料金が表わされる国の通貨コード。

データタイプ:文字列

short_description アイテムの簡単な説明。

データタイプ:文字列

show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。
可能な値:
  • true:価格設定の名前と値のペアが応答パラメーターで返されます。
  • false:価格設定の名前と値のペアが応答パラメーターで返されません。

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

show_quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの数量を表示します。
  • false:買い物かご内のアイテムの数量を表示しません。

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

sys_class_name このレコードが属するテーブルの名前。

データタイプ:文字列

sys_id アイテムの sys_id。

データタイプ:文字列

type アイテムのタイプ。

データタイプ:文字列

ui_policy アイテムに関連付けられた UI ポリシーのリスト。

データタイプ:アレイ

url アイテム画像の URL。

データタイプ:文字列

variables アイテムに関連付けられた利用可能な変数のリスト。

データタイプ:アレイ

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec" \
  --request GET \
  --header "Accept:application/json" \
  --user "username":"password"
{
  "result": {
    "short_description": "Apple iPad 3",
    "kb_article": "",
    "icon": "e6b3bc0647311200e0ef563dbb9a71fc.iix",
    "description": "\n\t\t\t<p>\n\t\t\t\t<font size=\"3\">\n\t\t\t\t\t<span style=\"color: gray;\">\n\t\t\t\t\t\tiPad with Retina display Wi-Fi 16GB - Black </span>\n\t\t\t\t</font>\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<span style=\"color: gray;\">Key Features:</span>\n\t\t\t</p>\n\t\t\t<ul><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Retina display (2048x1536 resolution)</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">16GB storage</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Wi-Fi enabled</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Built-in speaker, microphone and camera</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Up to 10 hours battery life</span>\n\t\t\t\t</li></ul>",
    "show_price": true,
    "recurring_price": "$0.00",
    "type": "catalog_item",
    "show_quantity": true,
    "local_currency": "USD",
    "sys_class_name": "pc_hardware_cat_item",
    "picture": "5b977690cb921200f2de77a4634c9c6a.iix",
    "url": "",
    "sys_id": "060f3afa3731300054b6a3549dbe5d3e",
    "recurring_price_currency": "USD",
    "content_type": "",
    "localized_price": "$600.00",
    "price": "$600.00",
    "catalogs": [
      {
        "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
      }
    ],
    "recurring_frequency": null,
    "name": "Apple iPad 3",
    "localized_recurring_price": "$0.00",
    "category": {
      "sys_id": "b06546f23731300054b6a3549dbe5dd8",
      "title": "Tablets"
    },
    "price_currency": "USD",
    "order": 0,
    "categories": [
      {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "active": true,
        "category": {
          "sys_id": "b06546f23731300054b6a3549dbe5dd8",
          "active": true,
          "title": "Tablets"
        },
        "title": "Hardware"
      }
    ],
    "variables": [],
    "ui_policy": [],
    "client_script": {
      "onChange": [],
      "onSubmit": [],
      "onLoad": []
    },
    "data_lookup": []
  }
}

Service Catalog - GET /sn_sc/servicecatalog/wishlist

ログインしているユーザーのウィッシュリスト内のアイテムのリストを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/wishlist

デフォルトの URL:/api/sn_sc/servicecatalog/wishlist

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

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

データタイプ:文字列

表 : 68. クエリパラメーター
名前 説明
なし
表 : 69. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)

名前 説明
cart_id ウィッシュリストの買い物かごの sys_id。

データタイプ:文字列

items ウィッシュリストの買い物かご内のアイテムを記述するオブジェクトのリスト。

データタイプ:アレイ

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created_by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_descriptions": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
items.cart_item_id アイテムの sys_id。items.sys_id と同じです。

データタイプ:文字列

items.catalog_item_id ウィッシュリストの買い物かご内のこのアイテムに対するカタログ識別子の sys_id。items.item_id と同じです。

データタイプ:文字列

items.created_by 最初にウィッシュリストの買い物かごにアイテムを入れたユーザー。

データタイプ:文字列

items.created_on アイテムが最初にウィッシュリストの買い物かごに入れられた日時。

データタイプ:文字列

items.delivery_time アイテムの配送にかかる時間。

データタイプ:文字列

items.item_id ウィッシュリストの買い物かご内のこのアイテムに対する一意のカタログ識別子 (sys_id)。items.catalog_item_id と同じです。

データタイプ:文字列

items.item_name アイテムの名前。

データタイプ:文字列

items.localized_price 現地通貨で表されるアイテムの価格。

データタイプ:文字列

items.localized_recurring_price 現地通貨で表される定期料金の価格。

データタイプ:文字列

items.name アイテムの名前。

データタイプ:文字列

items.order_guide アイテムが関連付けられている注文ガイド。

データタイプ:文字列

items.picture アイテムに表示する画像へのパス。

データタイプ:文字列

items.price アイテムの価格。

データタイプ:文字列

items.quantity ウィッシュリストの買い物かご内のこのアイテムの数。

データタイプ:文字列

items.recurring_frequency 定期料金が適用される頻度 (日次、月次、年次など)。このアイテムに定期料金がない場合は Null です。

データタイプ:文字列

items.recurring_price アイテムに関連付けられた定期料金の金額。

データタイプ:文字列

items.recurring_subtotal このアイテムの定期料金の小計 (recurring_price x quantity)。

データタイプ:数値

items.recurring_subtotal_price このアイテムの定期料金の小計 (recurring_price x quantity)。

データタイプ:文字列

items.short_description アイテムの簡単な説明。

データタイプ:文字列

items.show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。このパラメーターが「false」に設定されている場合、価格設定の名前と値のペアが応答パラメーターで返されません。

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

items.show_quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。

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

items.show_recurring_price 買い物かご内で定期料金を表示するかどうかを示すフラグ。

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

items.subtotal このアイテムの小計 - セントを含まない (price x quantity)。

データタイプ:数値

items.subtotal_price このアイテムの小計 - セントを含む (price x quantity)。

データタイプ:文字列

items.sys_class_name 関連アイテムレコードが属する子クラス。

データタイプ:文字列

items.sys_id アイテムの一意の識別子 (sys_id)。items.cart_item_id と同じです。

データタイプ:文字列

items.updated_by ウィッシュリストの買い物かご内のこのアイテムを更新したユーザー。

データタイプ:文字列

items.updated_on アイテムがウィッシュリストに入れられた日時。

データタイプ:文字列

items.variables アイテムに関連付けられた変数の名前と値のペア。

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

cURL 要求

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
  "result": {
    "cart_id": "3a68c46013f12300027879d96144b0ce",
    "items": [
      {
        "updated_on": "2018-11-16 05:54:41",
        "catalog_item_id": "774906834fbb4200086eeed18110c737",
        "short_description": "Macbook Pro",
        "recurring_subtotal_price": "$100.00",
        "delivery_time": "5 Days 0 seconds",
        "sys_class_name": "sc_cat_item",
        "sys_id": "3b8d887113b5a300027879d96144b0c2",
        "price": "$1,499.00",
        "recurring_frequency": "Annually",
        "subtotal_price": "$1,499.00",
        "variables": {
          "Adobe Photoshop": "false",
          "Adobe Acrobat": "false",
          "Optional Software": "true",
          "Additional software requirements": "",
          "Eclipse IDE": "true"
        },
        "quantity": "1",
        "item_id": "774906834fbb4200086eeed18110c737",
        "recurring_price": "$100.00",
        "show_price": true,
        "item_name": "Developer Laptop (Mac)",
        "cart_item_id": "3b8d887113b5a300027879d96144b0c2",
        "recurring_subtotal": 100,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "4e4efd444f889200086eeed18110c7e6.iix",
        "created_on": "2018-11-16 05:54:41",
        "localized_price": "$1,499.00",
        "subtotal": 1499,
        "show_recurring_price": true,
        "name": "Developer Laptop (Mac)",
        "updated_by": "admin",
        "localized_recurring_price": "$100.00",
        "order_guide": ""
      }
    ]
  }
}

Service Catalog - GET /sn_sc/servicecatalog/wishlist/{cart_item_id}

ウィッシュリストの買い物かごに保存されている指定されたアイテムの詳細を取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}

デフォルトの URL:/api/sn_sc/servicecatalog/wishlist/{cart_item_id}

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

表 : 73. パスパラメーター
名前 説明
cart_item_id 取得するウィッシュリストの買い物かごのアイテムの sys_id。

データタイプ:文字列

表 : 74. クエリパラメーター
名前 説明
なし
表 : 75. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 78. ステータスコード
ステータスコード 説明
200 成功。要求が正常に処理されました。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404 失敗した要求を示します。買い物かごのアイテム ID が正しくないか、ウィッシュリストの買い物かごにアイテムが存在しません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
cart_item_id アイテムの sys_id。

データタイプ:文字列

catalog_item_id ウィッシュリストの買い物かご内のこのアイテムに対するカタログ識別子の sys_id。

データタイプ:文字列

delivery_time アイテムの配送にかかる時間。

データタイプ:文字列

item_name アイテムの名前。

データタイプ:文字列

localized_price 現地通貨で表されるアイテムの価格。

データタイプ:文字列

localized_recurring_price 現地通貨で表される定期料金の価格。

データタイプ:文字列

price アイテムの価格。

データタイプ:文字列

quantity ウィッシュリストの買い物かご内のこのアイテムの数。

データタイプ:文字列

recurring_frequency 定期料金が適用される頻度 (日次、月次、年次など)。このアイテムに定期料金がない場合は Null です。

データタイプ:文字列

recurring_price アイテムに関連付けられた定期料金の金額。

データタイプ:文字列

variables アイテムに関連付けられた変数の名前と値のペア。

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

cURL 要求

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
    "variables": {
      "Adobe Photoshop": "",
      "Adobe Acrobat": "",
      "Optional Software": "",
      "Additional software requirements": ""
    },
    "quantity": "1",
    "localized_price": "$1,100.00",
    "price": "$1,100.00",
    "recurring_frequency": "Annually",
    "localized_recurring_price": "$100.00",
    "recurring_price": "$100.00",
    "item_name": "Standard Laptop &",
    "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
    "delivery_time": "5 Days"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/cart/checkout

2 ステップ精算プロセスが有効かどうかに基づいて、現在の買い物かごの精算を取得して処理します。

1 ステップ精算の場合、メソッドは買い物かごをチェックアウト (保存) し、要求番号と要求注文 ID を返します。2 ステップ精算の場合、メソッドは買い物かごの注文ステータスと、2 ステップ精算に必要なすべての情報を返します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/checkout

デフォルトの URL:/api/sn_sc/servicecatalog/cart/checkout

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

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

データタイプ:文字列

表 : 80. クエリパラメーター
名前 説明
なし
表 : 81. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 84. ステータスコード
ステータスコード 説明
200 要求が正常に完了したことを示します。合計と小計の情報、および買い物かご内のアイテムに関する情報を返します。

1 ステップ精算の場合、メソッドは買い物かごをチェックアウト (保存) し、要求番号と要求注文 ID を返します。2 ステップ精算の場合、メソッドは買い物かごの注文ステータスと、2 ステップ精算に必要なすべての情報を返します。

400 買い物かごが空でチェックアウトできないことを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

パラメーター 説明
cart_id 買い物かごの sys_id。

データタイプ:文字列

delivery_address 買い物かごのアイテムの配送先住所。

データタイプ:文字列

<recurring_frequency> 買い物かご内で特定の発生頻度で繰り返されるアイテムのリスト。可能な値には次のようなものがあります。
  • daily
  • monthly
  • yearly
  • none (定期料金なし)

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

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label 関連する定期料金の頻度。アイテムに定期料金がない場合、このパラメーターには「null」が含まれます。

データタイプ:文字列

<recurring_frequency>.items 指定された繰り返し発生頻度カテゴリに関連付けられた各アイテムの詳細を含むオブジェクトのアレイ。

データタイプ:アレイ

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id この買い物かご内のアイテムの sys_id。

データタイプ:文字列

<recurring_frequency>.items.catalog_item_id アイテムのカタログ sys_id。

データタイプ:文字列

<recurring_frequency>.items.created.by 最初に買い物かごにアイテムを入れたユーザー。

データタイプ:文字列

<recurring_frequency>.items.created_on アイテムが最初に買い物かごに入れられた日付。

データタイプ:文字列

<recurring_frequency>.items.delivery_time 指定されたアイテムの配送にかかる時間。

データタイプ:文字列

<recurring_frequency>.items.item_id アイテムの sys_id。

データタイプ:文字列

<recurring_frequency>.items.item_name 指定されたアイテムの名前。

データタイプ:文字列

<recurring_frequency>.items.localized_price 現地通貨でのアイテムの価格。

データタイプ:文字列

<recurring_frequency>.items.localized_recurring_price 指定されたアイテムの定期料金 (現地通貨)。

データタイプ:文字列

<recurring_frequency>.items.name アイテム名。

データタイプ:文字列

<recurring_frequency>.items.order_guide このアイテムが関連付けられている注文ガイドの名前。このアイテムが注文ガイドに関連付けられていない場合、このパラメーターには空の文字列が含まれます。

データタイプ:文字列

<recurring_frequency>.items.picture アイテムの画像のファイル名。

データタイプ:文字列

<recurring_frequency>.items.price アイテムの価格です。

データタイプ:文字列

<recurring_frequency>.items.quantity 買い物かご内の指定されたアイテムの数。

データタイプ:文字列

<recurring_frequency>.items.recurring_frequency 指定されたアイテムに対して定期料金が請求される頻度。アイテムに定期料金がない場合、このパラメーターには「null」が含まれます。

データタイプ:文字列

<recurring_frequency>.items.recurring_price 指定されたアイテムの定期料金。

データタイプ:文字列

<recurring_frequency>.items.recurring_subtotal アイテムの定期料金の小計 (recurring_price x quantity)。

データタイプ:数値

<recurring_frequency>.items.recurring_subtotal_price アイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.items.short_description アイテムの短い説明。

データタイプ:文字列

<recurring_frequency>.items.show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの価格を表示します。
  • false:買い物かご内のアイテムの価格を表示しません。

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

<recurring_frequency>.items.show_quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの数量を表示します。
  • false:買い物かご内のアイテムの数量を表示しません。

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

<recurring_frequency>.items.show_recurring_price 買い物かご内で定期料金を表示する必要があるかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の定期料金を表示します。
  • false:買い物かご内の定期料金を表示しません。

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

<recurring_frequency>.items.subtotal アイテム数の小計。

データタイプ:数値

<recurring_frequency>.items.subtotal_price アイテムの小計 (price x quantity)。

データタイプ:文字列

<recurring_frequency>.items.sys_class_name アイテムのシステム分類名。

データタイプ:文字列

<recurring_frequency>.items.sys_id アイテムレコードの sys_id。

データタイプ:文字列

<recurring_frequency>.items.updated_by 最初に買い物かごに入れた後にアイテムを更新したユーザー。

データタイプ:文字列

<recurring_frequency>.items.updated_on アイテムが最初に買い物かごに入れられたか、更新された最終日時。

データタイプ:文字列

<recurring_frequency>.items.variables アイテム変数の名前/値ペアのリスト。

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

<recurring_frequency>.show_subtotal_price 関連する定期料金カテゴリの小計を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の小計を表示します。
  • false:買い物かご内の小計を表示しません。

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

<recurring_frequency>.subtotal_price 関連する繰り返し発生頻度カテゴリに関するすべてのアイテムのコスト小計。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。subtotal_recurring_frequency と同じです。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_price 関連する繰り返し発生頻度カテゴリ内のアイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.subtotal_title show_subtotal_pricetrue に設定されている場合、買い物かごに表示される関連するサブタイトルのテキスト。

データタイプ:文字列

<recurring_frequency>.total_title 関連する繰り返し発生頻度カテゴリの合計タイトルに表示するテキスト。

データタイプ:文字列

requested_for アイテムの注文対象ユーザーの sys_id。

データタイプ:文字列

requested_for_user 他のユーザーの代わりにアイテムを要求したユーザー。

データタイプ:文字列

show_subtotal_price 買い物かご内で小計の価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の小計を表示します。
  • false:買い物かご内の小計を表示しません。

データタイプ:文字列

special_instructions アイテムに関して顧客により提供された指示。

データタイプ:文字列

subtotal_price 買い物かご内のすべてのアイテムの小計 (ドル単位)。

データタイプ:文字列

subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。<recurring_frequency>.subtotal_recurring_frequency と同じです。

データタイプ:文字列

subtotal_recurring_price 買い物かご内にあるすべてのアイテムの繰り返し発生頻度料金の小計。

データタイプ:文字列

subtotal_title 小計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

total_title 合計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "delivery_address": "",
    "special_instructions": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "requested_for_user": "System Administrator",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:34:15",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "requested_for": "6816f79cc0a8016401c5a33be04be441",
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/cart/submit_order

現在のチェックアウトタイプ (1 ステップまたは 2 ステップ) に基づいて、ユーザーの買い物かごをチェックアウトします。

1 ステップ精算の場合、メソッドは買い物かごをチェックアウト (保存) し、要求番号と要求注文 ID を返します。2 ステップ精算の場合、メソッドは買い物かごの注文ステータスと、2 ステップ精算に必要なすべての情報を返します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/submit_order

デフォルトの URL:/api/sn_sc/servicecatalog/cart/submit_order

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

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

データタイプ:文字列

表 : 86. クエリパラメーター
名前 説明
なし
表 : 87. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

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

ステータスコード

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

表 : 90. ステータスコード
ステータスコード 説明
200 要求が正常に完了し、買い物かご内のアイテムが正常にチェックアウトされたことを示します。

1 ステップ精算の場合、メソッドは買い物かごをチェックアウト (保存) し、要求番号と要求注文 ID を返します。2 ステップ精算の場合、メソッドは買い物かごの注文ステータスと、2 ステップ精算に必要なすべての情報を返します。

400 ユーザーの買い物かごが空であることを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
parent_id 利用可能な場合、要求の作成元の親レコードの sys_id。詳細については、「 要求の親マッピングの構成」を参照してください。

データタイプ:文字列

parent_table 親テーブルの名前。

データタイプ:文字列

request_id 生成された注文要求の sys_id。

データタイプ:文字列

request_number 生成された要求の番号。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order " \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
  "result": {
    "request_number": "REQ0010010",
    "request_id": "f89ed597db21120064301150f0b8f5ff"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart

指定されたアイテムを現在のユーザーのカートに追加します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart

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

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

データタイプ:文字列

sys_id 現在のカートに追加するアイテムの sys_id。

データタイプ:文字列

表 : 92. クエリパラメーター
名前 説明
なし
表 : 93. 要求本文パラメーター (XML または JSON)
名前 Description (説明)
sysparm_also_request_for 指定されたアイテムを注文する他のユーザーのユーザー sys_id のカンマ区切り文字列。ユーザー sys_id はユーザー [sys_user] テーブルにあります。
  • アイテムを受け取る追加ユーザーを 50 人を超えて指定することはできません。
  • リスト内のいずれかのユーザーがアイテムの対象ではない場合、要求全体が却下されます。
  • 関連アイテムに requested_for 変数が設定されていない場合、要求は却下されます。
  • 関連アイテムに requested_for 変数が設定されていても、 [追加要求の有効化] 変数が設定されていないか、呼び出し元ユーザーに適切なロールがない場合、要求は却下されます。
sysparm_quantity 必須です。アイテムの数量。負の値にすることはできません。

データタイプ:数値

sysparm_requested_for 指定されたアイテムを注文するユーザーのSys_id。ユーザー [sys_user] テーブルにあります。

データタイプ:文字列

変数 すべての必須の買い物かごアイテム変数の名前と値のペア。必須の変数は、関連するフォームで定義されます。

データタイプ:文字列

ヘッダー

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

表 : 94. 要求ヘッダー
ヘッダー 説明
なし
表 : 95. 応答ヘッダー
ヘッダー 説明
なし

ステータスコード

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

表 : 96. ステータスコード
ステータスコード 説明
200 成功。要求が正常に処理されました。
400 次のエラーが発生する可能性があります。
  • 無効な数量値 (Invalid quantity value):sysparm_quantity パラメーターが指定されていないか、無効な値が含まれていることを示します。
  • セキュリティ上の制約により、アイテムを注文できません (Security constraints prevent ordering of Item):パスパラメーターで指定された買い物かごのアイテムの sys_id が無効であるか、ユーザーにアイテムへのアクセス権がないことを示します。
  • 必須変数が必要です (Mandatory Variables are required): 1 つ以上の必須変数が要求で指定されていないことを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
cart_id 買い物かごの sys_id。

データタイプ:文字列

items 買い物かご内のすべてのアイテムの詳細。

データタイプ:アレイ

"items":[
  {
    "cart_item_id":"String",
    "catalog_item_id":"String",
    "item_name":"String",
    "localized_recurring_price":"String",
    "localized_price":"String",
    "price":"String",
    "quantity":"String",
    "recurring_frequency":"String",
    "recurring_price":"String"
  }
]
items.cart_item_id アイテムの sys_id。

データタイプ:文字列

items.catalog_item_id アイテムのカタログ sys_id。

データタイプ:文字列

items.item_name アイテムの名前。

データタイプ:文字列

items.localized_price ユーザーの現地通貨でのアイテムの価格。

データタイプ:文字列

items.localized_recurring_price ユーザーの現地通貨でのアイテムの定期的な価格。

データタイプ:文字列

items.price 基本価格。

データタイプ:文字列

items.quantity 買い物かご内のアイテムの数量。

データタイプ:文字列

items.recurring_frequency 定期的な価格が適用される頻度。

データタイプ:文字列

items.recurring_price 定期的な価格。

データタイプ:文字列

subtotal 買い物かご内のアイテムの小計。

データタイプ:文字列

サンプル cURL 要求と応答

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart" \
--request POST \
--header "Accept:application/json" \
--data "{ 'sysparm_quantity' : '1',
  'variables' : {
    'acrobat' : 'true'
  }
}" \
--user "username":"password"
{
  "result": {
    "cart_id": "0951c597db21120064301150f0b8f5cf",
    "subtotal": "$1,599.98",
    "items": [
      {
        "catalog_item_id": "0d08837237153000158bbfc8bcbe5d02",
        "quantity": "1",
        "localized_price": "$799.99",
        "price": "$799.99",
        "recurring_frequency": "Monthly",
        "localized_recurring_price": "$30.00",
        "recurring_price": "$29.00",
        "item_name": "Apple iPhone 5",
        "cart_item_id": "ac61c597db21120064301150f0b8f5f9"
      }
    ]
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist

指定されたアイテムをウィッシュリストのカートに追加します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist

デフォルトの URL:/api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist

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

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

データタイプ:文字列

sys_id ウィッシュリストに追加するアイテムの sys_id。

データタイプ:文字列

表 : 98. クエリパラメーター
名前 説明
なし
表 : 99. 要求本文パラメーター (XML または JSON)
名前 説明
なし

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 102. ステータスコード
ステータスコード 説明
200 成功。要求が正常に処理されました。
400 失敗した要求を示します。要求データが無効であるか、ユーザーがアイテムをウィッシュリストに追加できません。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
なし

cURL 要求

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist" \
 --request POST \
 --header "Accept:application/json" \
 --header "Content-Type:application/json" \
 --data "{\"sysparm_quantity\":\"1\"}" \
 --user "username":"password"
{
  "result": {
    "cart_id": "02a559a7c3b02200d68d3b0ac3d3ae5d",
    "items": [
      {
        "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
        "variables": {
          "Adobe Photoshop": "",
          "Adobe Acrobat": "",
          "Optional Software": "",
          "Additional software requirements": ""
        },
        "quantity": "1",
        "localized_price": "$1,100.00",
        "price": "$1,100.00",
        "recurring_frequency": "Annually",
        "localized_recurring_price": "$100.00",
        "recurring_price": "$100.00",
        "item_name": "Standard Laptop &",
        "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
        "delivery_time": "5 Days"
      }
    ]
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide

チェックアウトが要求されたコンテンツのアレイを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide

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

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

データタイプ:文字列

sys_id 情報を返すチェックアウトガイドの sys_id。

データタイプ:文字列

表 : 104. クエリパラメーター
名前 説明
なし
表 : 105. 要求本文パラメーター (XML または JSON)
名前 説明
items チェックアウトが要求されたアイテムを記述するオブジェクトのリスト。
データタイプ:アレイ
"items": [{
  "sys_id": "String",
  "sysparm_quantity": "String",
  "variables": {Object}
}]
items.sys_id 必須です。カタログアイテムの sys_id です。

データタイプ:文字列

items.sysparm_quantity アイテムの数。

データタイプ:文字列

デフォルト:1

items.variables アイテムに関連付けられた変数の名前と値のペア。

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

デフォルト:変数なし

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 108. ステータスコード
ステータスコード 説明
200 要求が正常に完了したことを示します。
  • 2 ステップではない (Is not two-step):アイテムがカートに追加され、買い物かごの内容が返されます。
  • 2 ステップ (Is two-step): 精算後に要求番号と要求 sys_id を返します。
400 要求が無効であることを示します。次のいずれかの理由が考えられます。
  • 送信された 1 つ以上のアイテムが存在しません。
  • ユーザーに 1 つ以上のアイテムへのアクセス権がありません。
  • 1 つ以上のアイテムの必須変数が回答されていません(必須として定義された変数のみが優先されます)。
  • 送信された数量値が、正の整数ではありません。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

表 : 109. 2 ステップ精算が false の場合に応答本文で返される要素
名前 説明
cart_id 買い物かごの sys_id。

データタイプ:文字列

items 買い物かご内のすべてのアイテムの詳細を含むオブジェクトのリスト。

データタイプ:アレイ

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "delivery_time": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "variables": {Object}
}]
items.cart_item_id 買い物かご内のアイテムの sys_id。

データタイプ:文字列

items.catalog_item_id 買い物かご内のカタログアイテムの sys_id。

データタイプ:文字列

items.delivery_time アイテムの配送にかかる時間。

データタイプ:文字列

items.item_name 買い物かご内のアイテムの名前。

データタイプ:文字列

items.localized_price 現地通貨でのアイテムの価格。

データタイプ:文字列

items.localized_recurring_price 現地通貨でのアイテムの定期的な価格。

データタイプ:文字列

items.price アイテムの価格です。

データタイプ:文字列

items.quantity 買い物かご内のアイテムの数。

データタイプ:文字列

items.recurring_frequency アイテムの繰り返し発生頻度。

データタイプ:文字列

items.recurring_price アイテムの定期的な価格。

データタイプ:文字列

items.variables 買い物かご内のアイテムに関連付けられた名前と値のペア。

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

parent_id 要求の作成元の親レコードの sys_id (利用可能な場合)。詳細については、「 要求の親マッピングの構成」を参照してください。

データタイプ:文字列

parent_table 親テーブルの名前 (大文字と小文字を区別)。

データタイプ:文字列

request_number 要求レコード番号。

データタイプ:文字列

request_id 要求の sys_id。

データタイプ:文字列

subtotal_price 買い物かごの小計。

データタイプ:文字列

subtotal_price 現在の頻度ブロックの小計。

データタイプ:文字列

subtotal_recurring_frequency 買い物かごの繰り返し発生頻度の小計。

データタイプ:文字列

subtotal_recurring_frequency 現在の頻度ブロックの繰り返し発生頻度の小計。

データタイプ:文字列

subtotal_recurring_price 買い物かごの定期的な価格の小計。

データタイプ:文字列

subtotal_recurring_price 現在の頻度ブロックの定期的な価格の小計。

データタイプ:文字列

total_title ページの合計フィールドのタイトル。

データタイプ:文字列

total_title 現在の頻度ブロックの合計フィールドのタイトル。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide" \
--request POST \
--header "Accept:application/json"  \
--header "Content-Type:application/json" \
--data "{\"items\":[{
  \"sys_id\":\"04b7e94b4f7b4200086eeed18110c7fd\",
  \"variables\":{
    \"acrobat\":\"true\",
    \"Additional_software_requirements\":\"MS Office 2007\"
  },
  \"sysparm_quantity\":\"3\"
},
{
  \"sys_id\":\"e1be6dcb4f7b4200086eeed18110c74c\"
},
{
  \"sys_id\":\"186d917a6fab7980575967ddbb3ee4f2\",
  \"variables\":{
    \"new_email\":\"abel.tuter@example.com\"
  }
},
{
  \"sys_id\":\"8b3ae7fedc1be1004ece5c08239e522b\"
},
{
  \"sys_id\":\"962967674ff38200086eeed18110c7e7\",
  \"variables\":{
    \"ergonomic_office\":\"Office chair should have lumbar support\"
  }
}]}" \
--user "username":"password"
<!--Case-1: if two-step is false:-->
{
  "result": {
    "cart_id": "0d8c7a32c3211200d68d3b0ac3d3aeba",
    "subtotal_price": "$3,350.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$300.00",
    "total_title": "Total",
    "monthly": {
      "subtotal_price": "$50.00",
      "subtotal_recurring_frequency": "Monthly",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "90af095bcd38798071a208d710d1b64f",
          "variables": {},
          "quantity": "1",
          "localized_price": "$50.00",
          "price": "$50.00",
          "recurring_frequency": "Monthly",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Belkin iPad Mini Case",
          "cart_item_id": "cb6e485fc3211200d68d3b0ac3d3ae35",
          "delivery_time": "2 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "none": {
      "subtotal_price": "-",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "186d917a6fab7980575967ddbb3ee4f2",
          "variables": {
            "Preferred Email address": "abel.tuter@example.com"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "New Email Account",
          "cart_item_id": "17c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "global.Workflow"
        },
        {
          "catalog_item_id": "8b3ae7fedc1be1004ece5c08239e522b",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Corp VPN",
          "cart_item_id": "97c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "e1be6dcb4f7b4200086eeed18110c74c",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "External Monitor",
          "cart_item_id": "d3c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "962967674ff38200086eeed18110c7e7",
          "variables": {
            "Please describe any ergonomic requirements\n\t\t": "Office chair should have lumbar support"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Desk Set Up",
          "cart_item_id": "d7c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "false",
      "subtotal_title": "Subtotal"
    },
    "yearly": {
      "subtotal_price": "$3,300.00",
      "subtotal_recurring_frequency": "Annually",
      "subtotal_recurring_price": "$300.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
          "variables": {
            "Adobe Photoshop": "",
            "Adobe Acrobat": "true",
            "Optional Software": "",
            "Additional software requirements": "MS Office 2007"
          },
          "quantity": "3",
          "localized_price": "$1,100.00",
          "price": "$1,100.00",
          "recurring_frequency": "Annually",
          "localized_recurring_price": "$100.00",
          "recurring_price": "$100.00",
          "item_name": "Standard Laptop",
          "cart_item_id": "9fc5241fc3211200d68d3b0ac3d3ae7e",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Case-2: if two-step is true:
{
  "result": {
    "request_number": "REQ0010001",
    "request_id": "82a7e89fc3211200d68d3b0ac3d3ae0a"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

指定されたアイテムの要求を委任できない (別のユーザーから要求された) ユーザーのリストを返します。

このエンドポイントを、Service Catalog API - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cartService Catalog API - POST /sn_sc/servicecatalog/items/{sys_id}/order_now などのエンドポイントを呼び出す前に呼び出して、他のユーザーに代わってサービスカタログアイテムを要求することができます。これらの呼び出しは、関連アイテムについて許可されていないユーザーを渡すと失敗します。このエンドポイントを使用すると、アイテムを注文したり、買い物かごへのアイテムの追加を試行したりするエンドポイントを呼び出す前に、ユーザーのリストを確認できます。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

デフォルトの URL:/api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

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

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

データタイプ:文字列

item_sys_id 指定されたユーザーが取得権を持っているかどうかを確認するためのサービスカタログアイテムの sys_id。サービスカタログ [sc_catalog] テーブルにあります。

データタイプ:文字列

表 : 111. クエリパラメーター
名前 説明
なし
表 : 112. 要求本文パラメーター (XML または JSON)
名前 説明
sysparm_also_request_for 有効なユーザー sys_id のカンマ区切り文字列。エンドポイントは、これらのユーザーが指定されたサービスカタログアイテムに対する取得権限を持っていることを確認します。ユーザー [sys_user] テーブルにあります。

データタイプ:文字列

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 115. ステータスコード
ステータスコード 説明
200 成功。要求が正常に処理されました。
400 要求は失敗しました。処理の要求が正しくありません。エラーの詳細については、返される結果のメッセージを参照してください。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
エラーコード エラーに関連付けられた番号。エンドポイントが失敗した場合にのみ返されます。

データタイプ:文字列

errMsg エンドポイントが失敗したときに発生したエラーの説明。
invalidUsers 指定されたカタログアイテムを要求できないユーザーの名前。

データタイプ:アレイ

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"
{
  "result": {
    "invalidUsers": [
      "Abel Tuter"
    ]
  }
}

cURL 要求

curl "https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"
{
  "result": {
    "errCode": "42202",
    "errMsg": "This item cannot be submitted for multiple people as it is not configured with Requested For"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/order_now

指定されたカタログアイテムを注文します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}/order_now

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

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

データタイプ:文字列

sys_id サービスカタログアイテムの sys_id。カタログアイテム [sc_cat_item] テーブルにあります。

データタイプ:文字列

表 : 117. クエリパラメーター
名前 説明
なし
表 : 118. 要求本文パラメーター (XML または JSON)
名前 Description (説明)
sysparm_also_request_for 指定されたアイテムを注文する他のユーザーのユーザー sys_id のカンマ区切り文字列。ユーザー sys_id はユーザー [sys_user] テーブルにあります。
  • アイテムを受け取る追加ユーザーを 50 人を超えて指定することはできません。
  • リスト内のいずれかのユーザーがアイテムの対象ではない場合、要求全体が却下されます。
  • 関連アイテムに requested_for 変数が設定されていない場合、要求は却下されます。
  • 関連アイテムに requested_for 変数が設定されていても、 [追加要求の有効化] 変数が設定されていないか、呼び出し元ユーザーに適切なロールがない場合、要求は却下されます。
sysparm_quantity 必須です。アイテムの数量。負の値にすることはできません。

データタイプ:数値

sysparm_requested_for 指定されたアイテムを注文するユーザーのSys_id。ユーザー [sys_user] テーブルにあります。
glide.sc.req_for.roles プロパティと glide.sc.req_for.roles.default プロパティの設定によって、ユーザーがアイテムを要求できるレベルが決まります。
  • glide.sc.req_for.roles プロパティに値が指定されている場合、システムは、ユーザーが他のユーザーの情報を要求するために指定されたロールを持っているかどうかを確認します。
  • glide.sc.req_for.roles プロパティ値が空で、glide.sc.req_for.roles.defaultプロパティ値が deny の場合、ユーザーは他のユーザーのためにアイテムを要求できません。
  • glide.sc.req_for.roles プロパティ値が空で、glide.sc.req_for.roles.defaultプロパティ値が allow の場合、すべてのユーザーが他のユーザーのアイテムを要求できます。

データタイプ:文字列

変数 すべての必須の買い物かごアイテム変数の名前と値のペア。必須の変数は、関連するフォームで定義されます。

データタイプ:文字列

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)

名前 説明
number 生成された要求の番号。
parent_id 要求の作成元の親レコードの sys_id (利用可能な場合)。詳細については、「 要求の親マッピングの構成」を参照してください。

データタイプ:文字列

parent_table 利用可能な場合、要求の作成元の親テーブルの名前。

データタイプ:文字列

request_id 注文要求の sys_id。

データタイプ:文字列

request_number 要求番号。

データタイプ:文字列

sys_id 注文の sys_id。

データタイプ:文字列

table 要求のテーブル名。

データタイプ:文字列

サンプル cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  sysparm_quantity: 1,
  variables: {
    replacement: 'Yes',
    originalnumber: '1640000',
    data_plan: '500MB'
  }
}" \
--user "username":"password"
{
  "result": {
    "sys_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "number": "REQ0010012",
    "request_number": "REQ0010012",
    "request_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "table": "sc_request"
  }
}

Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer

レコードを作成し、作成されたレコードにアクセスするためのテーブル API の相対パスとリダイレクト URL を返します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}/submit_producer

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

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

データタイプ:文字列

sys_id レコードプロデューサーを作成するテーブルの sys_id。

データタイプ:文字列

表 : 123. クエリパラメーター
名前 説明
sysparm_view データをレンダリングする UI ビュー。応答で返されるフィールドを指定します。

有効な値:

  • desktop
  • mobile
  • both

sysparm_fields パラメーターが優先されます (指定した場合)。

データタイプ:文字列

表 : 124. 要求本文パラメーター (XML または JSON)
名前 説明
variables 定義するプロデューサーレコードの変数の名前と値のペア。

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 127. ステータスコード
ステータスコード 説明
200 要求が成功したことを示し、作成されたレコードにアクセスするためのテーブル API と URL で構成される応答オブジェクトを返します。
400 要求メッセージが正しくないため、要求が処理されません。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404 要求されたリソースが見つかりません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
number レコードプロデューサーに関連付けられたチケットの番号。

データタイプ:文字列

parent_id 利用可能な場合、要求の作成元の親レコードの sys_id。詳細については、「 要求の親マッピングの構成」を参照してください。

データタイプ:文字列

parent_table 親テーブルの名前。

データタイプ:文字列

record 新しく作成されたレコードプロデューサーのテーブル API 相対パス。

データタイプ:文字列

redirect_portal_url サービスポータルのリダイレクト先の URL。

データタイプ:文字列

redirect_to リダイレクト値

データタイプ:文字列

redirect_url 作成されたレコードプロデューサーにアクセスするためのリダイレクト URL。

データタイプ:文字列

sys_id 作成されたレコードの sys_id。

データタイプ:文字列

table 要求が行われたテーブルの名前。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'variables':{'urgency':'2','comments':'This is sample incident'}}" \
--user "username":"password"
{
  "result": {
    "sys_id": "6baf4e1ddbba2300e890f71fbf961963",
    "number": "INC0010006",
    "parent_id": null,
    "record": "api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963",
    "redirect_portal_url": "",
    "parent_table": "task",
    "redirect_url": "incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess",
    "table": "incident",
    "redirect_to": ""
  }
}

Service Catalog - POST /sn/sc/servicecatalog/variables/{sys_id}/display_value

指定された変数の表示値を返します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value

デフォルトの URL:/api/sn_sc/servicecatalog/variables/{sys_id}/display_value

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

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

データタイプ:文字列

sys_id 表示値を返す変数の sys_id。

データタイプ:文字列

表 : 129. クエリパラメーター
名前 説明
なし
表 : 130. 要求本文パラメーター (XML または JSON)
名前 説明
sysparm_value 返される表示値を含むレコードの sys_id。

データタイプ:文字列

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)

名前 説明
result 変数の表示値。

データタイプ:文字列

cURL 要求


 curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"sysparm_value\":\"62826bf03710200044e0bfc8bcbe5df1\"}" \ 
--user "username":"password" 
{
  "result": "Abel Tuter (Architect)"
}

Service Catalog - PUT /sn_sc/servicecatalog/cart/{cart_item_id}

ログインしているユーザーの買い物かご内の指定されたアイテムを更新します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

デフォルトの URL:/api/sn_sc/servicecatalog/cart/{cart_item_id}

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

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

データタイプ:文字列

cart_item_id 更新する買い物かごアイテムの sys_id。

データタイプ:文字列

表 : 135. クエリパラメーター
名前 説明
なし
表 : 136. 要求本文パラメーター (XML または JSON)
名前 説明
sysparm_quantity 必須です。買い物かごを更新するアイテムの数量。

データタイプ:文字列

variables アイテムに必須の変数が指定されている場合は必須です。すべての必須変数の名前と値のペアで構成されるオブジェクト。

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

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 139. ステータスコード
ステータスコード 説明
201 要求が正常に完了し、アイテムがカートに追加されたことを示します。
400 次の 3 つのエラーが発生する可能性があります。
  • 無効な数量値 (Invalid quantity value):sysparm_quantity パラメーターが指定されていないか、無効な値が含まれていることを示します。
  • セキュリティ上の制約により、アイテムを注文できません (Security constraints prevent ordering of Item):パスパラメーターで指定されたアイテム ID が無効であるか、ユーザーにアイテムへのアクセス権がないことを示します。
  • 必須変数が必要です (Mandatory Variables are required):1 つ以上の必須変数値が要求で指定されていないことを示します。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前 説明
cart_id 買い物かごの sys_id。

データタイプ:文字列

<recurring_frequency> 買い物かご内の特定の繰り返し発生頻度があるアイテムを記述します。
可能な値には次のようなものがあります。
  • daily
  • monthly
  • yearly
  • none (定期料金なし)

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

"<recurring_frequency>": {
  "frequency_label": "String",
  "items": [Array],
  "show_subtotal_price": "String",
  "subtotal_price": "String",
  "subtotal_recurring_frequency": "String",
  "subtotal_recurring_price": "String",
  "subtotal_title": "String",
  "total_title": "String"
}
<recurring_frequency>.frequency_label 関連する定期料金の頻度。アイテムに定期料金がない場合、このパラメーターには「null」が含まれます。

データタイプ:文字列

<recurring_frequency>.items 指定された繰り返し発生頻度カテゴリに関連付けられた各アイテムを記述するオブジェクトのリスト。

データタイプ:アレイ

"items": [{
  "cart_item_id": "String",
  "catalog_item_id": "String",
  "created.by": "String",
  "created_on": "String",
  "delivery_time": "String",
  "item_id": "String",
  "item_name": "String",
  "localized_price": "String",
  "localized_recurring_price": "String",
  "name": "String",
  "order_guide": "String",
  "picture": "String",
  "price": "String",
  "quantity": "String",
  "recurring_frequency": "String",
  "recurring_price": "String",
  "recurring_subtotal": Number,
  "recurring_subtotal_price": "String",
  "short_description": "String",
  "show_price": Boolean,
  "show_quantity": Boolean,
  "show_recurring_price": Boolean,
  "subtotal": Number,
  "subtotal_price": "String",
  "sys_class_name": "String",
  "sys_id": "String",
  "updated_by": "String",
  "updated_on": "String",
  "variables": {Object}
}]
<recurring_frequency>.items.cart_item_id この買い物かご内のアイテムの sys_id。

データタイプ:文字列

<recurring_frequency>.items.catalog_item_id アイテムのカタログ sys_id。

データタイプ:文字列

<recurring_frequency>.items.created.by 最初に買い物かごにアイテムを入れたユーザー。

データタイプ:文字列

<recurring_frequency>.items.created_on アイテムが最初に買い物かごに入れられた日付。

データタイプ:文字列

<recurring_frequency>.items.delivery_time 指定されたアイテムの配送にかかる時間。

データタイプ:文字列

<recurring_frequency>.items.item_id アイテム sys_id。

データタイプ:文字列

<recurring_frequency>.items.item_name 指定されたアイテムの名前。

データタイプ:文字列

<recurring_frequency>.items.localized_price アイテムの価格 (現地通貨)。

データタイプ:文字列

<recurring_frequency>.items.localized_recurring_price 指定されたアイテムの定期料金 (現地通貨)。

データタイプ:文字列

<recurring_frequency>.items.name アイテム名。

データタイプ:文字列

<recurring_frequency>.items.order_guide このアイテムが関連付けられている注文ガイドの名前。このアイテムが注文ガイドに関連付けられていない場合、このパラメーターには空の文字列が含まれます。

データタイプ:文字列

<recurring_frequency>.items.picture アイテムの画像のファイル名。

データタイプ:文字列

<recurring_frequency>.items.price アイテムの価格です。

データタイプ:文字列

<recurring_frequency>.items.quantity 買い物かご内の指定されたアイテムの数。

データタイプ:文字列

<recurring_frequency>.items.recurring_frequency 指定されたアイテムに対して定期料金が請求される頻度。

データタイプ:文字列

デフォルト:Null

<recurring_frequency>.items.recurring_price 指定されたアイテムの定期料金。

データタイプ:文字列

<recurring_frequency>.items.recurring_subtotal アイテムの定期料金の小計 (recurring_price x quantity)。

データタイプ:数値

<recurring_frequency>.items.recurring_subtotal_price アイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.items.short_description アイテムの短い説明。

データタイプ:文字列

<recurring_frequency>.items.show_price 買い物かご内でアイテムの価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの価格を表示します。
  • false:買い物かご内のアイテムの価格を表示しません。

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

<recurring_frequency>.items.show.quantity 買い物かご内でアイテムの数量を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内のアイテムの数量を表示します。
  • false:買い物かご内のアイテムの数量を表示しません。

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

<recurring_frequency>.items.show_recurring_price 買い物かご内で定期料金を表示する必要があるかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の定期料金を表示します。
  • false:買い物かご内の定期料金を表示しません。

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

<recurring_frequency>.items.subtotal アイテム数の小計。

データタイプ:数値

<recurring_frequency>.items.subtotal_price アイテムの小計 (price x quantity)。

データタイプ:文字列

<recurring_frequency>.items.sys_class_name アイテムのシステム分類名。

データタイプ:文字列

<recurring_frequency>.items.sys_id アイテムの sys_id。

データタイプ:文字列

<recurring_frequency>.items.updated_by 最初に買い物かごに入れた後にアイテムを更新したユーザー。

データタイプ:文字列

<recurring_frequency>.items.updated_on アイテムが最初に買い物かごに入れられたか、更新された最終日時。

データタイプ:文字列

<recurring_frequency>.items.variables アイテム変数の名前と値のペア。

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

<recurring_frequency>.show_subtotal_price 関連する定期料金カテゴリの小計を表示するかどうかを示すフラグ。

データタイプ:文字列

<recurring_frequency>.subtotal_price 関連する繰り返し発生頻度カテゴリに関するすべてのアイテムのコスト小計。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。

データタイプ:文字列

<recurring_frequency>.subtotal_recurring_price 関連する繰り返し発生頻度カテゴリ内のアイテムの定期料金の小計。

データタイプ:文字列

<recurring_frequency>.subtotal_title show_subtotal_pricetrue に設定されている場合、買い物かごに表示される関連するサブタイトルのテキスト。

データタイプ:文字列

<recurring_frequency>.total_title 関連する繰り返し発生頻度カテゴリの合計タイトルに表示するテキスト。

データタイプ:文字列

show_subtotal_price 買い物かご内で小計の価格を表示するかどうかを示すフラグ。
可能な値:
  • true:買い物かご内の小計を表示します。
  • false:買い物かご内の小計を表示しません。

データタイプ:文字列

subtotal_price 買い物かご内のすべてのアイテムの小計。

データタイプ:文字列

subtotal_recurring_frequency 小計の繰り返し発生頻度のタイプ (日次、月次など)。<recurring_frequency>.subtotal_recurring_frequency と同じです。

データタイプ:文字列

subtotal_recurring_price 買い物かご内にあるすべてのアイテムの繰り返し発生頻度料金の小計。

データタイプ:文字列

subtotal_title 小計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

total_title 合計フィールドのタイトルとして買い物かごに表示するテキスト。

データタイプ:文字列

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065" \
--request PUT \
--header "Accept:application/json" \
--data "{\"sysparm_quantity\": \"2\" }" \
--user "username":"password"
{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$2,397.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$2,397.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:21:08",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$1,598.00",
          "variables": {},
          "quantity": "2",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 1598,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Service Catalog - PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide

注文ガイドについて記述されたニーズに基づいて、アイテムのリストを取得します。

URL 形式

バージョニングされた URL:/api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide

デフォルトの URL:/api/sn_sc/servicecatalog/items/{sys_id}/submit_guide

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

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

データタイプ:文字列

sys_id アイテムを取得する注文ガイドの sys_id。注文ガイド [sc_cat_item_guide] テーブルにあります。

データタイプ:文字列

表 : 141. クエリパラメーター
名前 説明
なし
表 : 142. 要求本文パラメーター (XML または JSON)
名前 説明
variables アイテムに対して要求された変数。各変数は、名前と値のペアで構成される JSON オブジェクトです。

データタイプ:アレイ

ヘッダー

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

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

デフォルト: application/json

Content-Type 要求本文のデータ形式。サポートされるタイプ:application/json または application/xml

デフォルト: application/json

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

ステータスコード

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

表 : 145. ステータスコード
ステータスコード 説明
200 要求が正常に完了したことを示します。渡された変数リストに基づいて、アイテムのリストを返します。結果セットにアイテムが含まれていない場合は、空の配列が返されます。
400 要求が無効であることを示します。次のいずれかの理由が考えられます。
  • ユーザーにアイテムへのアクセス権がありません。
  • 1 つ以上のアイテムの必須変数が回答されていません(必須として定義された変数のみが優先されます)。
401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500 選択されたオプションに基づいてアイテムを計算中に内部エラーが発生しました。

応答本文のパラメーター (JSON または XML)

名前 説明
catalogs アイテムが属するカタログのオブジェクトのリストと、各カタログタイトルおよびカタログの sys_id。

データタイプ:アレイ

"catalogs": [{
  "sys_id": "String",
  "title": "String"
}]
catalogs.sys_id カタログの sys_id。

データタイプ:文字列

catalogs.title カタログタイトル。

データタイプ:文字列

category category

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

"catalogs": {
  "sys_id": "String",
  "title": "String"
}
category.sys_id カテゴリの sys_id。

データタイプ:文字列

category.title カテゴリのタイトル。

データタイプ:文字列

client_script カタログアイテムで定義されているすべてのカタログクライアントスクリプトのリスト。

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

"client_script": {
  "onChange": [Array],
  "onLoad": [Array],
  "onSubmit": [Array]
}
client_script.onChange アイテムに関連付けられた onChange クライアントスクリプトのリスト。

データタイプ:アレイ

client_script.onLoad アイテムに関連付けられた onLoad クライアントスクリプトのリスト。

データタイプ:アレイ

client_script.onSubmit アイテムに関連付けられた onSubmit クライアントスクリプトのリスト。

データタイプ:アレイ

data_lookup カタログアイテムで定義されたデータルックアップ。

データタイプ:アレイ

description カタログアイテムの完全な説明。

データタイプ:文字列

icon カタログアイテムの横にアイコンとして表示される画像のパス。

データタイプ:文字列

name カタログアイテムの名前。

データタイプ:文字列

short_description サービスカタログホームページや検索結果ページのテキスト、またはカタログアイテムの注文フォームのタイトル。

データタイプ:文字列

show_price 価格の詳細を表示するかどうかを示します。true の場合、次の詳細を返します。
  • local_currency
  • localized_price
  • localized_recurring_price
  • price
  • price_currency
  • recurring_frequency
  • recurring_price
  • recurring_price_currency

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

sys_id カタログアイテムの sys_id です。

データタイプ:文字列

type アイテムタイプ。
可能な値:
  • カタログアイテム
  • 注文ガイド
  • レコードプロデューサーアイテム

データタイプ:文字列

variables カタログアイテムに関連付けられたすべての変数の名前と値のペア。

データタイプ:アレイ

ui_policy カタログアイテムで定義されているすべてのカタログ UI ポリシーのリスト。

データタイプ:アレイ

cURL 要求

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"variables\":{
    \"hiring_manager\":\"6816f79cc0a8016401c5a33be04be441\",
    \"hiring_group\":\"221f3db5c6112284009f4becd3039cc9\",
    \"remote\":\"No\",
    \"standard_package\":\"No\",
    \"laptop_type\":\"developer\"
  }
}" \
--user "username":"password"
{
  "result": [
    {
      "short_description": "Lenovo - Carbon x1",
      "icon": "1195c2084f889200086eeed18110c74a.iix",
      "description": "<p class=\"p1\"><font size=\"3\" color=\"#808080\"><span class=\"s1\">x1 Carbon</span></font></p>\n<p class=\"p1\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile. </span></font></p>\n<p class=\"p2\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">Technical Specs:</span></font></p>\n<ul class=\"ul1\"><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Intel core i5 processor</span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">512GB solid state drive (SSD) </span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Backlit keyboard</span></font></li></ul>",
      "show_price": true,
      "recurring_price": "$100.00",
      "type": "catalog_item",
      "local_currency": "USD",
      "sys_id": "04b7e94b4f7b4200086eeed18110c7fd",
      "recurring_price_currency": "USD",
      "localized_price": "$1,100.00",
      "price": "$1,100.00",
      "catalogs": [
       {
         "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
       }
      ],
      "recurring_frequency": "Annually",
      "name": "Standard Laptop",
      "localized_recurring_price": "$100.00",
      "category": {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "title": "Hardware"
      },
      "price_currency": "USD",
      "show_quantity": false,
      "quantity": "1",
      "order": "100",
      "variables": [
        {
          "label": "Optional Software",
          "type": 0,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "container_start",
          "render_label": true,
          "read_only": false,
          "children": [
            {
              "label": "Adobe Acrobat",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "acrobat",
              "attributes": "edge_encryption_enabled=true",
              "id": "90b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            },
            {
              "label": "Adobe Photoshop",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "photoshop",
              "attributes": "edge_encryption_enabled=true",
              "id": "a8b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            }
          ],
          "name": "optional_label",
          "attributes": "edge_encryption_enabled=true",
          "id": "10b72d4b4f7b4200086eeed18110c700",
          "value": "",
          "help_text": "",
          "max_length": 0
        },
        {
          "label": "Additional software requirements",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "Additional_software_requirements",
          "attributes": "edge_encryption_enabled=true",
          "id": "a8b72d4b4f7b4200086eeed18110c702",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "e1be6dcb4f7b4200086eeed18110c74c",
      "short_description": "LG IPS 27\" Monitor",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "External Monitor",
      "icon": "08569a4c4f889200086eeed18110c77b.iix",
      "description": "<p><font size=\"2\"><span style=\"color: #485563;\"><br /> <font size=\"3\" color=\"#808080\">The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor. </font></span></font></p>\n<p><font size=\"2\" color=\"#808080\">Item Specs:</font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Screen Size: 27"</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Resolution: 1920 x 1080</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Aspect Ratio: 16:9</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Brightness: 250 cd/m2</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Supports Split Screen</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "2c0b59874f7b4200086eeed18110c71f",
        "title": "Peripherals"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "200",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "186d917a6fab7980575967ddbb3ee4f2",
      "short_description": "New Email Creation",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "New Email Account",
      "icon": "b630e97e6fab7980575967ddbb3ee4d2.iix",
      "description": "<p style=\"font-size: 13px;\"><font size=\"4\"><span style=\"color: #485563;\">Service Overview:</span></font></p>\n\t<p style=\"font-size: 13px;\"><font size=\"3\">Creation of a new email account within our Microsoft Exchange environment.  Creation of your email address will also create your Active Directory account. </font></p>\n\t<p> </p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "300",
      "variables": [
        {
          "label": "Preferred Email address",
          "type": 6,
          "mandatory": true,
          "displayvalue": "",
          "friendly_type": "single_line_text",
          "display_type": "Single Line Text",
          "render_label": true,
          "read_only": false,
          "name": "new_email",
          "attributes": "edge_encryption_enabled=true",
          "id": "65865e474fbb4200086eeed18110c7dd",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "8b3ae7fedc1be1004ece5c08239e522b",
      "short_description": "Remote access to Internal Corporate Systems\n\t\t",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Corp VPN",
      "icon": "11dc8df74f778200086eeed18110c78e.iix",
      "description": "<p><font size=\"3\"><span style=\"color: #485563;\">Corp VPN Account</span></font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\">Corp VPN provides VPN (Virtual Private Network) access to all Internal Corporate Systems and to IP Restricted Customer Instances</font></li><li style=\"color: #485563;\"><font size=\"2\">By utilizing Corp VPN, users will be provided a similar experience to being within one of the Corporate office locations, while offsite</font></li></ul>\n<p><font size=\"2\"><span style=\"color: #485563;\"> </span></font></p>\n<p><font size=\"2\"><span style=\"color: #485563;\">Please reference the <span style=\"color: #485563;\">CORP VPN </span><span style=\"color: #485563;\">Installation</span><span style=\"color: #485563;\"> and Support Documentation</span> for instructions on installation, usage and FAQ’s. For all other questions, please contact <span style=\"color: #485563;\">IT Support.</span></span></font></p>\n<p> </p>\n<p><span style=\"font-size: 10pt; font-family: tahoma, arial, helvetica, sans-serif;\"><br /><br /></span></p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "d2f7cae4c611227a018ddc481b34e099",
        "title": "Security and Access"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "600",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "962967674ff38200086eeed18110c7e7",
      "short_description": "Desk Set Up for New Hires or Employee Moves\n\t\t",
      "catalogs": [
        {
          "sys_id": "",
          "title": "Service Catalog"
        }
      ],
      "name": "Desk Set Up",
      "icon": "aa6b08ff4ff38200086eeed18110c7ed.iix",
      "description": "<p><font size=\"3\" face=\"arial, helvetica, sans-serif\">The facilities organization will set up your new desk with the following configuration:</font></p>\n<ul><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Docking Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Power Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Phone</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Office Chair</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "",
        "title": null
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "900",
      "variables": [
        {
          "label": "Please describe any ergonomic requirements\n\t\t",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "ergonomic_office",
          "attributes": "edge_encryption_enabled=true",
          "id": "b0b9ab674ff38200086eeed18110c755",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    }
  ]
}