Product Catalog オープン API

Product Catalog Open API は、製品カタログ、製品オファリング、および製品仕様を作成および取得するためのエンドポイントを提供します。

この API を使用して、外部システムと Now Platform の間で製品カタログ情報を管理します。Product Catalog オープン API は、TM Forum Product Catalog Management API REST 仕様の ServiceNow® 実装です。この実装は、TMF620 Product Catalog Management API REST Specification Version 4 (2021 年 8 月) に基づいています。

この API は、ServiceNow Store で入手可能な Product Catalog Advanced アプリケーションに含まれています。

この API は sn_prd_pm_adv 名前空間内で提供されます。

呼び出し元ユーザーには、sn_prd_pm_adv.catalog_integrator ロールが必要です。

この API は、次のテーブルのデータを作成および更新します。

• 特性 [sn_prd_pm_characteristic]
• 特性オプション [sn_prd_pm_characteristic_option]
• 製品オファリング [sn_prd_pm_product_offering]
• 製品オファリングカタログ [sn_prd_pm_product_offering_catalog]
• 製品オファリング特性 [sn_prd_pm_product_offering_characteristic]
• 製品仕様 [sn_prd_pm_product_specification]
• 仕様関係 [sn_prd_pm_specification_relationship]

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/catalog

すべての製品オファリングカタログのリストを取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/catalog

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

表 : 1. パスパラメーター

名前	説明
なし

表 : 2. クエリパラメータ

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。 データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：20 最大：100 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値

表 : 3. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 4. 要求ヘッダー

ヘッダー	説明
なし

表 : 5. 応答ヘッダー

ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値は items 3-5 です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

表 : 6. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。考えられる理由： 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
description	製品オファリングカタログの説明。 データタイプ：文字列
id	製品オファリングカタログ [sn_prd_pm_product_offering_catalog] テーブルの製品オファリングカタログの sys_id。 データタイプ：文字列
name	製品オファリングカタログの名前。 データタイプ：文字列

cURL 要求

この例では、すべての製品オファリングカタログを取得します。

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/catalog" \
--user 'username':'password'

応答本文。

[
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

製品オファリングカタログを取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

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

表 : 7. パスパラメーター

名前	説明
catalogId	取得する製品オファリングカタログの sys_id。製品オファリングカタログ [sn_prd_pm_product_offering_catalog] テーブルにあります。 データタイプ：文字列

表 : 8. クエリパラメーター

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。 データタイプ：文字列

表 : 9. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 10. 要求ヘッダー

ヘッダー	説明
なし

表 : 11. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 12. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。ID に関連付けられたレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
description	製品オファリングカタログの説明。 データタイプ：文字列
id	製品オファリングカタログ [sn_prd_pm_product_offering_catalog] テーブルの製品オファリングカタログの sys_id。 データタイプ：文字列
name	製品オファリングカタログの名前。 データタイプ：文字列

cURL 要求

この例では、Enterprise Mobile Plan の製品オファリングカタログを取得します。

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/catalog/9919291ac34c20105252716b7d40dd0f" \
--user 'username':'password'

応答本文。

{
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/productoffering

すべての製品オファリングを取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productoffering

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

表 : 13. パスパラメーター

名前	説明
なし

表 : 14. クエリパラメータ

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： category channel description externalId id internalId internalVersion lastUpdate name productCharacteristic productOfferingPrice productOfferingTerm productSpecification prodSpecCharValueUse validFor version デフォルト：すべてのフィールドを返します。 データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：20 最大：100 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値
specification	製品仕様 sys_id で製品オファリングをフィルタリングします。指定された製品仕様 sys_id を持つ製品オファリングのみが応答で返されます。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
state	製品オファリングをステータス別にフィルタリングします。指定されたステータスの製品オファリングのみが応答で返されます。 データタイプ：文字列

表 : 15. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 16. 要求ヘッダー

ヘッダー	説明
なし

表 : 17. 応答ヘッダー

ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値は items 3-5 です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

表 : 18. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。考えられる理由： 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
category	製品が属するカテゴリのリスト。 データタイプ：オブジェクトのアレイ "category:" [ { "id": "String", "name": "String" } ]
category.id	カテゴリの id。 データタイプ：文字列
category.name	カテゴリの名前。 データタイプ：文字列
channel	製品オファリングの販売に使用するチャネル。 データタイプ：オブジェクトのアレイ "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	チャネルの説明。 データタイプ：文字列
channel.id	流通チャネル [sn_prd_pm_distribution_channel] テーブルのチャネルの sys_id。 データタイプ：文字列
channel.name	チャネルの名前。 データタイプ：文字列
description	製品オファリングの説明。 データタイプ：文字列
externalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_id。 データタイプ：文字列
id	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version または external_id。 データタイプ：文字列
internalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version。 データタイプ：文字列
internalVersion	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングのバージョン。 データタイプ：文字列
lastUpdate	製品オファリングが最後に更新された日付。 データタイプ：文字列
name	製品オファリングの名前。 データタイプ：文字列
productCharacteristic	製品特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	特性の名前。 データタイプ：文字列
productCharacteristic.value	特性の値。 データタイプ：文字列
productOfferingPrice	製品オファリングの価格情報。 データタイプ：オブジェクトのアレイ "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	製品オファリングの価格情報。 データタイプ：オブジェクト "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	製品オファリングの価格情報。 データタイプ：オブジェクト "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	製品オファリング価格の通貨コード。 データタイプ：文字列
productOfferingPrice.price.taxIncludedAmount.value	税込みの製品オファリングの価格。 データタイプ：文字列
productOfferingPrice.priceType	製品オファリング価格のタイプ (1 回払いまたは繰り返し支払い)。 有効な値： nonRecurring (1 回) recurring データタイプ：文字列
productOfferingTerm	製品オファリングの有効な契約期間。 データタイプ：文字列
productSpecification	製品の製品仕様。 データタイプ：オブジェクト "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalId	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalVersion	製品仕様のバージョン。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.version	製品仕様の external_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
prodSpecCharValueUse	製品オファリング特性。 データタイプ：オブジェクトのアレイ "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	特性の可能な値。 データタイプ：オブジェクトのアレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
prodSpecCharValueUse.description	特性の説明。 データタイプ：文字列
prodSpecCharValueUse.name	特性の名前。 データタイプ：文字列
prodSpecCharValueUse.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	特性の終了日。 データタイプ：文字列
prodSpecCharValueUse.validFor.startDateTime	特性の開始日。 データタイプ：文字列
prodSpecCharValueUse.valueType	特性の値タイプ (選択肢やメールなど)。
validFor	製品オファリングが有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	製品オファリングの終了日。 データタイプ：文字列
validFor.startDateTime	製品オファリングの開始日。 データタイプ：文字列
version	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_version。 データタイプ：文字列

cURL 要求

この例では、すべての製品オファリングを取得します。

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productoffering" \
--user 'username':'password'

応答本文：

[
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

製品オファリングを取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

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

表 : 19. パスパラメーター

名前	説明
offeringId	取得する製品オファリングの initial_version。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ：文字列

表 : 20. クエリパラメーター

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： category channel description externalId id internalId internalVersion lastUpdate name productCharacteristic productOfferingPrice productOfferingTerm productSpecification prodSpecCharValueUse validFor version デフォルト：すべてのフィールドを返します。 データタイプ：文字列
specification	製品仕様 sys_id で製品オファリングをフィルタリングします。指定された製品仕様 sys_id を持つ製品オファリングのみが応答で返されます。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
state	製品オファリングをステータス別にフィルタリングします。指定されたステータスの製品オファリングのみが応答で返されます。 データタイプ：文字列

表 : 21. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 22. 要求ヘッダー

ヘッダー	説明
なし

表 : 23. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 24. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。
400	要求が正しくありません。考えられる理由： 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。ID に関連付けられたレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
category	製品が属するカテゴリのリスト。 データタイプ：アレイ "category:" [ { "id": "String", "name": "String" } ]
category.id	カテゴリの id。 データタイプ：文字列
category.name	カテゴリの名前。 データタイプ：文字列
channel	製品オファリングの販売に使用するチャネル。 データタイプ：アレイ "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	チャネルの説明。 データタイプ：文字列
channel.id	流通チャネル [sn_prd_pm_distribution_channel] テーブルのチャネルの sys_id。 データタイプ：文字列
channel.name	チャネルの名前。 データタイプ：文字列
description	製品オファリングの説明。 データタイプ：文字列
externalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_id。 データタイプ：文字列
id	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version または external_id。 データタイプ：文字列
internalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version。 データタイプ：文字列
internalVersion	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングのバージョン。 データタイプ：文字列
lastUpdate	製品オファリングが最後に更新された日付。 データタイプ：文字列
name	製品オファリングの名前。 データタイプ：文字列
productCharacteristic	製品特性のリスト。 データタイプ：アレイ "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	特性の名前。 データタイプ：文字列
productCharacteristic.value	特性の値。 データタイプ：文字列
productOfferingPrice	製品オファリングの価格情報。 データタイプ：アレイ "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	製品オファリングの価格情報。 データタイプ：オブジェクト "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	製品オファリングの価格情報。 データタイプ：オブジェクト "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	製品オファリング価格の通貨コード。 データタイプ：文字列
productOfferingPrice.price.taxIncludedAmount.value	税込みの製品オファリングの価格。 データタイプ：文字列
productOfferingPrice.priceType	製品オファリング価格が 1 回払いまたは繰り返し支払いであるかを識別します。 有効な値： nonRecurring recurring データタイプ：文字列
productOfferingTerm	製品オファリングの有効な契約期間。 データタイプ：文字列
productSpecification	製品の製品仕様。 データタイプ：オブジェクト "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalId	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalVersion	製品仕様のバージョン。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.version	製品仕様の external_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
prodSpecCharValueUse	製品オファリング特性。 データタイプ：アレイ "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	特性の可能な値を含むアレイ。 データタイプ：アレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
prodSpecCharValueUse.description	特性の説明。 データタイプ：文字列
prodSpecCharValueUse.name	特性の名前。 データタイプ：文字列
prodSpecCharValueUse.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	特性の終了日。 データタイプ：文字列
prodSpecCharValueUse.validFor.startDateTime	特性の開始日。 データタイプ：文字列
prodSpecCharValueUse.valueType	特性の値タイプ (選択肢やメールなど)。
validFor	製品オファリングが有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	製品オファリングの終了日。 データタイプ：文字列
validFor.startDateTime	製品オファリングの開始日。 データタイプ：文字列
version	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_version。 データタイプ：文字列

cURL 要求

この例では、製品オファリングを取得します。

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productoffering/24413" \
--user 'username':'password'

応答本文：

{
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/productspecification

すべての製品仕様を取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productspecification

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

表 : 25. パスパラメーター

名前	説明
なし

表 : 26. クエリパラメータ

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： description externalId id internalId internalVersion lastUpdate name productSpecCharacteristic productSpecificationRelationship resourceSpecification serviceSpecification validFor version デフォルト：すべてのフィールドを返します。 データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：20 最大：100 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値
state	製品仕様をステータス別にフィルタリングします。指定されたステータスの製品仕様のみが応答で返されます。 データタイプ：文字列

表 : 27. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 28. 要求ヘッダー

ヘッダー	説明
なし

表 : 29. 応答ヘッダー

ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値は items 3-5 です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

表 : 30. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。考えられる理由： 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
description	仕様の説明。 データタイプ：文字列
externalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_id。 データタイプ：文字列
id	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version または external_id。 データタイプ：文字列
internalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version。 データタイプ：文字列
internalVersion	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様のバージョン。 データタイプ：文字列
lastUpdate	仕様が最後に更新された日付。 データタイプ：文字列
name	仕様の名前。 データタイプ：文字列
productSpecCharacteristic	仕様特性。 データタイプ：オブジェクトのアレイ "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	特性の説明。 データタイプ：文字列
productSpecCharacteristic.name	特性の名前。 データタイプ：文字列
productSpecCharacteristic.productSpecCharacteristicValue	特性の可能な値のリスト。 データタイプ：オブジェクトのアレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
productSpecCharacteristic.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	特性の終了日。 データタイプ：文字列
productSpecCharacteristic.validFor.startDateTime	特性の開始日。 データタイプ：文字列
productSpecCharacteristic.valueType	特性の値タイプ (選択肢やメールなど)。 データタイプ：文字列
productSpecificationRelationship	この仕様と他の製品仕様との関係。 データタイプ：オブジェクトのアレイ "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	関連仕様の ID。 データタイプ：文字列
productSpecificationRelationship.type	関係のタイプ。 データタイプ：文字列
productSpecificationRelationship.validFor	関係が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	関係の終了日。 データタイプ：文字列
productSpecificationRelationship.validFor.startDateTime	関係の開始日。 データタイプ：文字列
resourceSpecification	この製品仕様に関連するリソース仕様のリスト。 データタイプ：オブジェクトのアレイ "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	リソース仕様の initial_version または external_id。リソース仕様 [sn_prd_pm_resource_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
resourceSpecification.internalId	リソース仕様の initial_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.internalVersion	リソース仕様のバージョン。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.name	リソース仕様の名前。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.version	リソース仕様の external_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification	この製品仕様に関連するサービス仕様のリスト。 データタイプ：オブジェクトのアレイ "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	サービス仕様の initial_version または external_id。サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
serviceSpecification.internalId	サービス仕様の initial_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.internalVersion	サービス仕様のバージョン。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.name	サービス仕様の名前。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.version	サービス仕様の external_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
validFor	仕様が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	仕様の終了日。 データタイプ：文字列
validFor.startDateTime	仕様の開始日。 データタイプ：文字列
version	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_version。 データタイプ：文字列

cURL 要求

この例では、すべての製品仕様を取得します。

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productspecification" \
--user 'username':'password'

応答本文：

[
   {
      "id": "0c47f2257441c110f877ca57242ff9bd",
      "name": "SD-WAN My Device",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "0c47f2257441c110f877ca57242ff9bd",
      "description": "This is my product specification ...",
      "lastUpdate": "2022-01-14 17:57:23",
      "validFor": {
         "startDateTime": "2022-01-11",
         "endDateTime": "2027-01-10"
      },
      "serviceSpecification": [
         {
            "id": "e23ae2d01bb420106ba59acf034bcb56",
            "name": "IP Sec Tunnel",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "e23ae2d01bb420106ba59acf034bcb56"
         }
      ],
      "productSpecificationRelationship": [
         {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "1",
            "type": "Service",
            "validFor": {
               "startDateTime": "2022-01-11",
               "endDateTime": "2027-02-12"
            }
         }
      ],
      "resourceSpecification": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "493fa60b536520103b6bddeeff7b12b6"
         }
      ],
      "productSpecCharacteristic": [
         {
            "name": "New characteristic",
            "description": "This product has new spec characteristic.",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-13 06:47:43"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "TestValue",
                  "validFor": {
                     "startDateTime": "2022-01-11"
                  }
               }
            ]
         }
      ]
   }
]

Product Catalog オープン API - GET /sn_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

指定された製品仕様を取得します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

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

表 : 31. パスパラメーター

名前	説明
specificationId	取得する製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列

表 : 32. クエリパラメーター

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： description externalId id internalId internalVersion lastUpdate name productSpecCharacteristic productSpecificationRelationship resourceSpecification serviceSpecification validFor version デフォルト：すべてのフィールドを返します。 データタイプ：文字列
state	製品仕様をステータス別にフィルタリングします。指定されたステータスの製品仕様のみが応答で返されます。 データタイプ：文字列

表 : 33. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 34. 要求ヘッダー

ヘッダー	説明
なし

表 : 35. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 36. ステータスコード

ステータスコード	説明
200	要求が正常に処理されました。
400	要求が正しくありません。考えられる理由： 無効なパスパラメーター 無効な URI
404	レコードが見つかりません。ID に関連付けられたレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)

名前	説明
description	仕様の説明。 データタイプ：文字列
externalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_id。 データタイプ：文字列
id	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version または external_id。 データタイプ：文字列
internalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version。 データタイプ：文字列
internalVersion	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様のバージョン。 データタイプ：文字列
lastUpdate	仕様が最後に更新された日付。 データタイプ：文字列
name	仕様の名前。 データタイプ：文字列
productSpecCharacteristic	仕様特性。 データタイプ：オブジェクトのアレイ "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	特性の説明。 データタイプ：文字列
productSpecCharacteristic.name	特性の名前。 データタイプ：文字列
productSpecCharacteristic.productSpecCharacteristicValue	特性の可能な値。 データタイプ：オブジェクトのアレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
productSpecCharacteristic.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	特性の終了日。 データタイプ：文字列
productSpecCharacteristic.validFor.startDateTime	特性の開始日。 データタイプ：文字列
productSpecCharacteristic.valueType	特性の値タイプ (選択肢やメールなど)。 データタイプ：文字列
productSpecificationRelationship	この仕様と他の製品仕様との関係。 データタイプ：オブジェクトのアレイ "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	関連仕様の ID。 データタイプ：文字列
productSpecificationRelationship.type	関係のタイプ。 データタイプ：文字列
productSpecificationRelationship.validFor	関係が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	関係の終了日。 データタイプ：文字列
productSpecificationRelationship.validFor.startDateTime	関係の開始日。 データタイプ：文字列
resourceSpecification	この製品仕様に関連するリソース仕様のリスト。 データタイプ：オブジェクトのアレイ "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	リソース仕様の initial_version または external_id。リソース仕様 [sn_prd_pm_resource_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
resourceSpecification.internalId	リソース仕様の initial_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.internalVersion	リソース仕様のバージョン。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.name	リソース仕様の名前。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.version	リソース仕様の external_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification	この製品仕様に関連するサービス仕様のリスト。 データタイプ：オブジェクトのアレイ "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	サービス仕様の initial_version または external_id。サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
serviceSpecification.internalId	サービス仕様の initial_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.internalVersion	サービス仕様のバージョン。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.name	サービス仕様の名前。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.version	サービス仕様の external_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
validFor	仕様が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	仕様の終了日。 データタイプ：文字列
validFor.startDateTime	仕様の開始日。 データタイプ：文字列
version	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_version。 データタイプ：文字列

cURL 要求

この例では、製品仕様を取得します。

curl --location --request GET "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productspecification/0c47f2257441c110f877ca57242ff9bd" \
--user 'username':'password'

応答本文：

{
   "id": "0c47f2257441c110f877ca57242ff9bd",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalVersion": "1",
   "internalId": "0c47f2257441c110f877ca57242ff9bd",
   "description": "This is my product specification ...",
   "lastUpdate": "2022-01-14 17:57:23",
   "validFor": {
      "startDateTime": "2022-01-11",
      "endDateTime": "2027-01-10"
   },
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "version": "v1",
         "internalVersion": "1",
         "internalId": " a6514bd3534560102f18ddeeff7b1247",
         "type": "Service",
         "validFor": {
            "startDateTime": "2022-01-11",
            "endDateTime": "2027-02-12"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ],
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-13 06:47:43"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "TestValue",
               "validFor": {
                  "startDateTime": "2022-01-11"
               }
            }
         ]
      }
   ]
}

Product Catalog オープン API - POST /sn_prd_pm_adv/catalogmanagement/catalog

製品オファリングカタログを作成します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/catalog

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

表 : 37. パスパラメーター

名前	説明
なし

表 : 38. クエリパラメータ

名前	説明
なし

表 : 39. 要求本文パラメーター (JSON)

名前	説明
description	製品オファリングカタログの説明。 データタイプ：文字列 デフォルト：空白の文字列
externalId	外部システムからの製品オファリングカタログの一意の識別子。 データタイプ：文字列 デフォルト：空白の文字列
name	必須です。製品オファリングカタログの名前。 データタイプ：文字列

ヘッダー

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

表 : 40. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 41. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 42. ステータスコード

ステータスコード	説明
201	要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。 空のペイロード。 無効なペイロード必須フィールドがありません：<フィールド名>

応答本文のパラメーター (JSON)

名前	説明
description	製品オファリングカタログの説明。 データタイプ：文字列
id	製品オファリングカタログ [sn_prd_pm_product_offering_catalog] テーブルの製品オファリングカタログの sys_id。 データタイプ：文字列
name	製品オファリングカタログの名前。 データタイプ：文字列

cURL 要求

この例では、製品オファリングカタログを作成します。

curl --location --request POST "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
    "id": "testId",
    "name": "Catalog",
    "description": "Description"
}'
--user 'username':'password'

応答本文。

{
   "id": "45715d02c3510110bc0526083c40dd6b",
   "description": "Description",
   "name": "Catalog1"
}

Product Catalog オープン API - POST /sn_prd_pm_adv/catalogmanagement/productoffering

製品オファリングを作成します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productoffering

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

表 : 43. パスパラメーター

名前	説明
なし

表 : 44. クエリパラメータ

名前	説明
なし

表 : 45. 要求本文パラメーター (JSON)

名前	説明
category	製品が属するカテゴリのリスト。 データタイプ：オブジェクトのアレイ "category:" [ { "id": "String", "name": "String" } ]
category.id	category パラメーターを使用する場合は必須です。カテゴリの ID。 データタイプ：文字列
category.name	カテゴリの名前。 データタイプ：文字列 デフォルト：空白の文字列
channel	必須です。製品オファリングの販売に使用するチャネル。 データタイプ：アレイ "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	チャネルの説明。 データタイプ：文字列 デフォルト：空白の文字列
channel.id	必須です。流通チャネル [sn_prd_pm_distribution_channel] テーブルのチャネルの sys_id。 データタイプ：文字列
channel.name	チャネルの名前。 データタイプ：文字列 デフォルト：空白の文字列
description	必須です。製品オファリングの説明。 データタイプ：文字列
externalId	外部システムからの製品オファリングの一意の識別子。 データタイプ：文字列 デフォルト：空白の文字列
id	必須です。製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version または external_id。 データタイプ：文字列
internalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version。 データタイプ：文字列
internalVersion	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングのバージョン。 データタイプ：文字列
lastUpdate	製品オファリングが最後に更新された日付。 データタイプ：文字列 デフォルト：空白の文字列
name	必須です。製品オファリングの名前。 データタイプ：文字列
productCharacteristic	製品特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	特性の名前。 データタイプ：文字列 デフォルト：空白の文字列
productCharacteristic.value	特性の値。 データタイプ：文字列 デフォルト：空白の文字列
productOfferingPrice	製品オファリングの価格情報。 データタイプ：オブジェクトのアレイ "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	製品オファリングの価格情報。 データタイプ：オブジェクト "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	製品オファリングの価格情報。 データタイプ：オブジェクト "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	製品オファリング価格の通貨コード。 データタイプ：文字列 デフォルト：空白の文字列
productOfferingPrice.price.taxIncludedAmount.value	税込みの製品オファリングの価格。 データタイプ：文字列 デフォルト：空白の文字列
productOfferingPrice.priceType	productOfferingPrice パラメーターを使用する場合は必須です。製品オファリング価格タイプ (1 回払いまたは繰り返し支払い)。 有効な値： nonRecurring (1 回) recurring データタイプ：文字列
productOfferingTerm	製品オファリングの有効な契約期間。 データタイプ：文字列 デフォルト：空白の文字列
productSpecification	必須です。製品の製品仕様。 データタイプ：オブジェクト "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	必須です。製品仕様の initial_version または external_id。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalId	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalVersion	製品仕様のバージョン。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.version	製品仕様の external_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
prodSpecCharValueUse	製品オファリング特性。 データタイプ：オブジェクトのアレイ "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	必須です。特性の可能な値のリスト。 データタイプ：オブジェクトのアレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	必須です。特性の値。 データタイプ：文字列
prodSpecCharValueUse.description	特性の説明。 データタイプ：文字列 デフォルト：空白の文字列
prodSpecCharValueUse.name	必須です。特性の名前。 データタイプ：文字列
prodSpecCharValueUse.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	特性の終了日。 データタイプ：文字列 デフォルト：空白の文字列
prodSpecCharValueUse.validFor.startDateTime	特性の開始日。 データタイプ：文字列 デフォルト：空白の文字列
prodSpecCharValueUse.valueType	特性の値タイプ (選択肢やメールなど)。
validFor	必須です。製品オファリングが有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	製品オファリングの終了日。 データタイプ：文字列 デフォルト：空白の文字列
validFor.startDateTime	製品オファリングの開始日。 データタイプ：文字列 デフォルト：空白の文字列
version	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_version。 データタイプ：文字列

ヘッダー

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

表 : 46. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 47. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 48. ステータスコード

ステータスコード	説明
201	要求が正常に処理されました。
400	要求が正しくありません。考えられる理由： 空のペイロード。 無効なペイロード必須フィールドがありません：<フィールド名>

応答本文のパラメーター (JSON)

名前	説明
category	製品が属するカテゴリのリスト。 データタイプ：アレイ "category:" [ { "id": "String", "name": "String" } ]
category.id	カテゴリの ID。 データタイプ：文字列
category.name	カテゴリの名前。 データタイプ：文字列
channel	製品オファリングの販売に使用するチャネル。 データタイプ：オブジェクトのアレイ "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	チャネルの説明。 データタイプ：文字列
channel.id	流通チャネル [sn_prd_pm_distribution_channel] テーブルのチャネルの sys_id。 データタイプ：文字列
channel.name	チャネルの名前。 データタイプ：文字列
description	製品オファリングの説明。 データタイプ：文字列
externalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_id。 データタイプ：文字列
id	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version または external_id。 データタイプ：文字列
internalId	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの initial_version。 データタイプ：文字列
internalVersion	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングのバージョン。 データタイプ：文字列
lastUpdate	製品オファリングが最後に更新された日付。 データタイプ：文字列
name	製品オファリングの名前。 データタイプ：文字列
productCharacteristic	製品特性のリスト。 データタイプ：オブジェクトのアレイ "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	特性の名前。 データタイプ：文字列
productCharacteristic.value	特性の値。 データタイプ：文字列
productOfferingPrice	製品オファリングの価格情報。 データタイプ：オブジェクトのアレイ "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	製品オファリングの価格情報。 データタイプ：オブジェクト "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	製品オファリングの価格情報。 データタイプ：オブジェクト "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	製品オファリング価格の通貨コード。 データタイプ：文字列
productOfferingPrice.price.taxIncludedAmount.value	税込みの製品オファリングの価格。 データタイプ：文字列
productOfferingPrice.priceType	製品オファリング価格タイプ (1 回払いまたは繰り返し支払い)。 可能な値： nonRecurring (1 回) recurring データタイプ：文字列
productOfferingTerm	製品オファリングの有効な契約期間。 データタイプ：文字列
productSpecification	製品の製品仕様。 データタイプ：オブジェクト "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalId	製品仕様の initial_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.internalVersion	製品仕様のバージョン。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
productSpecification.version	製品仕様の external_version。製品仕様 [sn_prd_pm_product_specification] テーブルにあります。 データタイプ：文字列
prodSpecCharValueUse	製品オファリング特性。 データタイプ：オブジェクトのアレイ "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	特性の可能な値のリスト。 データタイプ：オブジェクトのアレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
prodSpecCharValueUse.description	特性の説明。 データタイプ：文字列
prodSpecCharValueUse.name	特性の名前。 データタイプ：文字列
prodSpecCharValueUse.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	特性の終了日。 データタイプ：文字列
prodSpecCharValueUse.validFor.startDateTime	特性の開始日。 データタイプ：文字列
prodSpecCharValueUse.valueType	特性の値タイプ (選択肢やメールなど)。
validFor	製品オファリングが有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	製品オファリングの終了日。 データタイプ：文字列
validFor.startDateTime	製品オファリングの開始日。 データタイプ：文字列
version	製品オファリング [sn_prd_pm_product_offering] テーブルの製品オファリングの external_version。 データタイプ：文字列

cURL 要求

この例では、製品オファリングを作成します。

curl --location --request POST "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productoffering" \
--header "Content-Type: application/json" \
--data-raw '{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": "",
   "internalVersion": "2",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " 39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}'
--user 'username':'password'

応答本文：

{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": null,
   "internalVersion": "5",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": null,
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": null,
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": null,
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   },
   "internalId": "fbc1c0a25b030110235d85cced81c724",
   "externalId": "d52a756b5bde0110235d85cced81c7ab"
}

Product Catalog オープン API - POST /sn_prd_pm_adv/catalogmanagement/productspecification

製品仕様を作成します。

URL 形式

デフォルトの URL：/api/sn_prd_pm_adv/catalogmanagement/productspecification

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

表 : 49. パスパラメーター

名前	説明
なし

表 : 50. クエリパラメータ

名前	説明
なし

表 : 51. 要求本文パラメーター (JSON)

名前	説明
description	必須です。仕様の説明。 データタイプ：文字列
externalId	外部システムからの製品仕様の一意の識別子。 データタイプ：文字列 デフォルト：空白の文字列
id	必須です。製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version または external_id。 データタイプ：文字列
internalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version。 データタイプ：文字列
internalVersion	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様のバージョン。 データタイプ：文字列
lastUpdate	仕様が最後に更新された日付。 データタイプ：文字列 デフォルト：空白の文字列
name	必須です。仕様の名前。 データタイプ：文字列
productSpecCharacteristic	仕様特性。 データタイプ：アレイ "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	特性の説明。 データタイプ：文字列 デフォルト：空白の文字列
productSpecCharacteristic.name	必須です。特性の名前。 データタイプ：文字列
productSpecCharacteristic.productSpecCharacteristicValue	必須です。特性の可能な値を含むアレイ。 データタイプ：アレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	必須です。特性の値。 データタイプ：文字列
productSpecCharacteristic.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	特性の終了日。 データタイプ：文字列 デフォルト：空白の文字列
productSpecCharacteristic.validFor.startDateTime	特性の開始日。 データタイプ：文字列 デフォルト：空白の文字列
productSpecCharacteristic.valueType	特性の値タイプ (選択肢やメールなど)。 データタイプ：文字列 デフォルト：空白の文字列
productSpecificationRelationship	この仕様と他の製品仕様との関係。 データタイプ：アレイ "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	関連仕様の id。 データタイプ：文字列 デフォルト：空白の文字列
productSpecificationRelationship.type	productSpecificationRelationship パラメーターを使用する場合は必須です。関係のタイプ。 有効な値： composed_of bundles データタイプ：文字列
productSpecificationRelationship.validFor	関係が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	関係の終了日。 データタイプ：文字列 デフォルト：空白の文字列
productSpecificationRelationship.validFor.startDateTime	関係の開始日。 データタイプ：文字列 デフォルト：空白の文字列
resourceSpecification	必須です。この製品仕様に関連するリソース仕様のアレイ。 データタイプ：アレイ "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	必須です。リソース仕様の initial_version または external_id。リソース仕様 [sn_prd_pm_resource_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
resourceSpecification.internalId	リソース仕様の initial_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.internalVersion	リソース仕様のバージョン。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.name	リソース仕様の名前。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.version	リソース仕様の external_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification	この製品仕様に関連するサービス仕様のリスト。 データタイプ：オブジェクトのアレイ "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	サービス仕様の initial_version または external_id。サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
serviceSpecification.internalId	サービス仕様の initial_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.internalVersion	サービス仕様のバージョン。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.name	サービス仕様の名前。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.version	サービス仕様の external_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
validFor	必須です。仕様が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	仕様の終了日。 データタイプ：文字列 デフォルト：空白の文字列
validFor.startDateTime	仕様の開始日。 データタイプ：文字列 デフォルト：空白の文字列
version	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_version。 データタイプ：文字列

ヘッダー

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

表 : 52. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 53. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

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

表 : 54. ステータスコード

ステータスコード	説明
201	要求が正常に処理されました。
400	要求が正しくありません。考えられる理由： 空のペイロード。 無効なペイロード必須フィールドがありません：<フィールド名>

応答本文のパラメーター (JSON)

名前	説明
description	仕様の説明。 データタイプ：文字列
id	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version または external_id。 データタイプ：文字列
internalId	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の initial_version。 データタイプ：文字列
internalVersion	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様のバージョン。 データタイプ：文字列
lastUpdate	仕様が最後に更新された日付。 データタイプ：文字列
name	仕様の名前。 データタイプ：文字列
productSpecCharacteristic	仕様特性。 データタイプ：アレイ "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	特性の説明。 データタイプ：文字列
productSpecCharacteristic.name	特性の名前。 データタイプ：文字列
productSpecCharacteristic.productSpecCharacteristicValue	特性の可能な値を含むアレイ。 データタイプ：アレイ "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	特性の値。 データタイプ：文字列
productSpecCharacteristic.validFor	特性が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	特性の終了日。 データタイプ：文字列
productSpecCharacteristic.validFor.startDateTime	特性の開始日。 データタイプ：文字列
productSpecCharacteristic.valueType	特性の値タイプ (選択肢やメールなど)。 データタイプ：文字列
productSpecificationRelationship	この仕様と他の製品仕様との関係。 データタイプ：アレイ "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	関連仕様の id。 データタイプ：文字列
productSpecificationRelationship.type	関係のタイプ。 データタイプ：文字列
productSpecificationRelationship.validFor	関係が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	関係の終了日。 データタイプ：文字列
productSpecificationRelationship.validFor.startDateTime	関係の開始日。 データタイプ：文字列
resourceSpecification	この製品仕様に関連するリソース仕様のリスト。 データタイプ：オブジェクトのアレイ "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	リソース仕様の initial_version または external_id。リソース仕様 [sn_prd_pm_resource_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
resourceSpecification.internalId	リソース仕様の initial_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.internalVersion	リソース仕様のバージョン。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.name	リソース仕様の名前。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
resourceSpecification.version	リソース仕様の external_version。リソース仕様 [sn_prd_pm_resource_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification	この製品仕様に関連するサービス仕様のリスト。 データタイプ：オブジェクトのアレイ "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	サービス仕様の initial_version または external_id。サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_id または external_id フィールドにあります。 データタイプ：文字列
serviceSpecification.internalId	サービス仕様の initial_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.internalVersion	サービス仕様のバージョン。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.name	サービス仕様の名前。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
serviceSpecification.version	サービス仕様の external_version。サービス仕様 [sn_prd_pm_service_specification] テーブルにあります。 データタイプ：文字列
validFor	仕様が有効な日付範囲。 データタイプ：オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	仕様の終了日。 データタイプ：文字列
validFor.startDateTime	仕様の開始日。 データタイプ：文字列
version	製品仕様 [sn_prd_pm_product_specification] テーブルの製品仕様の external_version。 データタイプ：文字列

cURL 要求

この例では、製品仕様を作成します。

curl --location --request POST "https://instance.service-now.com/api/sn_prd_pm_adv/catalogmanagement/productspecification" \
--header "Content-Type: application/json" \
--data-raw '{
   "name": "SD-WAN My Device",
   "description": "This is my product specification ...",
   "internalId": "1c3c9a325bc34110235d85cced81c7d5",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "label",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router"
      }
   ]
}'
--user 'username':'password'

応答本文。

{
   "id": "exter123",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalId": "63c3d946745d8150f877ca57242ff918",
   "description": "This is my product specification ...",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         },
         "valid": true,
         "version": "v1",
         "internalVersion": "1",
         "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ]
}