Product Catalog オープン API
Product Catalog Open API は、製品カタログ、製品オファリング、および製品仕様を作成および取得するためのエンドポイントを提供します。
この API を使用して、外部システムと ServiceNow AI 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_tmf_api 名前空間内で提供されます。
呼び出し元ユーザーには、sn_prd_pm_adv.catalog_integrator ロールが必要です。
- 特性 [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]
製品カタログオープン API - 削除 /sn_tmf_api/catalogmanagement/productOffering/{id}
指定された製品オファリングを削除します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 削除する製品オファリングのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| メッセージ | 製品仕様の削除またはアーカイブに関する失敗または成功のメッセージ。 |
cURL 要求
次の例では、ID が d6f8d9995b020210235d85cced81c7eb の製品オファリングを削除します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password'
応答本文は、削除成功のメッセージを返します。
"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"
製品カタログオープン API - 削除 /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
特定のsys_idを持つ価格明細を無効にしますが、削除はしません。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 削除する価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| メッセージ | 価格明細の非アクティブ化の成功または失敗に関するメッセージを含むステータスコード。 |
cURL 要求
次の例は、指定されたsys_idの価格表を正常に非アクティブ化または削除する方法を示しています。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request DELETE\
--user 'username':'password'
起動します応答は、成功した非アクティブ化に関する詳細を含む200ステータスコードを返します。
Status: 200 OK
"The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"
製品カタログオープン API - 削除 /sn_tmf_api/catalogmanagement/productSpecification/{id}
指定された製品仕様を削除またはアーカイブします。
- ドラフトステータスの製品仕様が正常に削除されました。応答は成功メッセージを返します。
- アーカイブ済みステータスの製品仕様は削除できません。この応答は、仕様が既にアーカイブされているというメッセージを返します。
- ドラフトステータスではなく、他の製品仕様またはオファリングに関連付けられている製品仕様はアーカイブされますが、削除はされません。この応答は、仕様がアクティブ状況からアーカイブ化済み状況に移行したことを示すメッセージを返します。
- アクティブな製品仕様またはオファリングに関連付けられている製品仕様は削除できません。応答はエラーメッセージを返します。
URL 形式
デフォルト URL: /sn_tmf_api/catalogmanagement/productSpecification/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 削除する製品仕様のSys_id。 データタイプ:文字列 表:製品仕様 [sn_prd_pm_product_specification] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| メッセージ | 製品仕様の削除またはアーカイブに関する失敗または成功のメッセージ。 |
cURL 要求
次の例では、ID が 8ef57fa05b308210235d85cced81c7d8 の製品仕様を削除します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/8ef57fa05b308210235d85cced81c7d8" \
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password'
応答本文は、成功または失敗のメッセージを返します。
"The product specification (8ef57fa05b308210235d85cced81c7d8) is successfully deleted"
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/catalog
すべての製品オファリングカタログのリストを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/catalog
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 データタイプ:文字列 デフォルト:すべてのフィールドが返されます。 |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 データタイプ:数値 デフォルト値:20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 データタイプ:数値 デフォルト:0 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Link | クエリー結果内を移動するための次のリンクが含まれています。
|
| X-Total-Count | ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。 |
| 206 | 応答で部分的なリソースが返されました (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
応答本文のパラメーター (JSON)
| 名前 | 説明 |
|---|---|
| description | 製品オファリングカタログの説明。フィールドに値が含まれている場合にのみ返されます。 データタイプ:文字列 |
| ID | 製品オファリングカタログのSys_id。 データタイプ:文字列 テーブル:製品オファリングカタログ [sn_prd_pm_product_offering_catalog] |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| 名前 | 製品オファリングカタログの名前。 データタイプ:文字列 |
| ステータス | 製品オファリングカタログのステータス。 可能な値:公開済み データタイプ:文字列 |
cURL 要求
この例では、すべての製品オファリングカタログを取得します。
curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--user 'username':'password'
応答本文。
[
{
"id": "341f4953b71a9910ff00f203ae11a9bb",
"name": "Home Internet Plan",
"lifecycleStatus": "Active",
"status": "published"
},
{
"id": "69f494792b11525047f3f3e30391bf66",
"name": "Chemical Processing",
"lifecycleStatus": "Active",
"description": " Catalog for Chemical Processing Industry",
"status": "published"
}
]
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/catalog/{id}
製品オファリングカタログを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/catalog/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 取得する製品オファリングカタログの sys_id。 データタイプ:文字列 テーブル:製品オファリングカタログ [sn_prd_pm_product_offering_catalog] |
| 名前 | 説明 |
|---|---|
| fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 データタイプ:文字列 デフォルト:すべてのフィールド。 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON)
| 名前 | 説明 |
|---|---|
| description | 製品オファリングカタログの説明。 データタイプ:文字列 |
| ID | 製品オファリングカタログのSys_id。 データタイプ:文字列 テーブル:製品オファリングカタログ [sn_prd_pm_product_offering_catalog] |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| 名前 | 製品オファリングカタログの名前。 データタイプ:文字列 |
cURL 要求
この例では、Enterprise Mobile Plan の製品オファリングカタログを取得します。
curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/69f494792b11525047f3f3e30391bf66" \
--user 'username':'password'
応答本文。
{
"id": "69f494792b11525047f3f3e30391bf66",
"name": "Chemical Processing",
"lifecycleStatus": "Active",
"description": " Catalog for Chemical Processing Industry"
}
製品カタログオープン API:GET /sn_tmf_api/catalogmanagement/productOffering
指定されたフィルター設定に基づいて、すべての製品オファリングまたは製品オファリングのサブセットを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOffering
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド:
データタイプ:文字列 デフォルト:すべてのフィールドを返します。 |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 データタイプ:数値 デフォルト値:20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 データタイプ:数値 デフォルト:0 |
| specification | 製品仕様 sys_id で製品オファリングをフィルタリングします。指定された製品仕様 sys_id を持つ製品オファリングのみが応答で返されます。 データタイプ:文字列 表:製品仕様 [sn_prd_pm_product_specification] |
| state | 製品オファリングをステータス別にフィルタリングします。指定されたステータスの製品オファリングのみが応答で返されます。 有効な値:
データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Link | クエリー結果内を移動するための次のリンクが含まれています。
|
| X-Total-Count | ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。 |
| 206 | 応答で部分的なリソースが返されました (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。HREF | 関連する製品オファリングへの相対リンク。 データタイプ:文字列 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| category | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ |
| category.id | カテゴリの ID。 データタイプ:文字列 |
| category.name | カテゴリの名前。 データタイプ:文字列 |
| channel | 製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| channel.description | チャネルの説明。 データタイプ:文字列 |
| channel.id | チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 |
| description | 製品オファリングの説明。 データタイプ:文字列 |
| displayName | 製品オファリングの表示名。 データタイプ:文字列 |
| externalId | 製品オファリングの外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 |
| lifecycleStatus | 製品オファリングの現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 デフォルト:空白の文字列 |
| name | 製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse。名前 |
特性の名前。
データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productCharacteristicです。価値 | 特性の値。 データタイプ:文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice です。価格 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。price.taxIncludedAmount | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice.price.taxIncludedAmount.unit | 製品オファリング価格の通貨コード。 データタイプ:文字列 |
| productOfferingPrice.price.taxIncludedAmount.value | 税込みの製品オファリングの価格。 データタイプ:文字列 |
| productOfferingPrice です。価格タイプ | 製品オファリング価格のタイプ (1 回払いまたは繰り返し支払い)。 可能な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間。 データタイプ:文字列 |
| productSpecification | 製品の製品仕様。 データタイプ: オブジェクト |
| productSpecificationです。身分証明書 | 製品仕様レコードのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。名前 | 製品仕様の名前。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの名前フィールド。 |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| ステータス | 製品オファリングのステータス。 可能な値:
データタイプ:文字列 |
| validFor | 製品オファリングが有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 製品オファリングの終了日。 データタイプ:文字列 フォーマット:YYY-MM-DD |
| validFor.startDateTime | 製品オファリングの開始日。 データタイプ:文字列 フォーマット:YYY-MM-DD |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
次のコード例では、最初の 2 つの製品オファリングレコードを取得します。
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'
応答本文:
[
{
"id": "7b012c4d41ea7910f8771355f12634a4",
"externalId": "7b012c4d41ea7910f8771355f12634a4",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/0361dd9fd0a63110f8770dbf976be16f",
"name": "Ultimate internet - 1Gbps Plan",
"displayName": "Ultimate internet - 1Gbps Plan",
"description": "Ultimate internet - 1Gbps Plan",
"isSellable": true,
"lifecycleStatus": "Active",
"isBundle": false,
"lastUpdate": "2025-03-08 02:07:04",
"version": "",
"internalVersion": "1",
"internalId": "0361dd9fd0a63110f8770dbf976be16f",
"validFor": {
"startDateTime": "2023-11-14",
"endDateTime": ""
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": "",
"bundledProductOffering": [],
"bundledGroupProductOffering": [],
"productSpecification": {},
"prodSpecCharValueUse": [],
"channel": "",
"category": [
{
"id": "e6f0159fd0a63110f8770dbf976be18c",
"name": "Internet"
}
],
"status": "published"
},
{
"id": "313b917843235210a82ed6085bb8f2c7",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": false,
"value": "When in use"
}
]
},
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": true,
"value": "Premium"
}
]
}
],
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
"id": "0f61dd9fd0a63110f8770dbf976be168",
"externalId": "EXT-123",
"name": "Solana Sports streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
"id": "62619d9fd0a63110f8770dbf976be180",
"externalId": "EXT-345",
"name": "Solana Movie streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2025-02-27 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "Base (10 site)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
]
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/productOffering/{id}
製品オファリングを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 取得する製品オファリングの初期バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| 名前 | 説明 |
|---|---|
| フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド:
データタイプ:文字列 デフォルト:すべてのフィールドを返します。 |
| specification | 製品仕様 sys_id で製品オファリングをフィルタリングします。指定された製品仕様 sys_id を持つ製品オファリングのみが応答で返されます。 データタイプ:文字列 表:製品仕様 [sn_prd_pm_product_specification] |
| state | 製品オファリングをステータス別にフィルタリングします。指定されたステータスの製品オファリングのみが応答で返されます。 有効な値:
データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 |
要求が正しくありません。考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。HREF | 関連する製品オファリングへの相対リンク。 データタイプ:文字列 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| category | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ |
| category.id | カテゴリの sys_id。 データタイプ:文字列 |
| category.name | カテゴリの名前。 データタイプ:文字列 |
| channel | 製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| チャンネル。形容 | チャネルの説明。 データタイプ:文字列 |
| channel.id | チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 |
| description | 製品オファリングの説明。 データタイプ:文字列 |
| displayName | 製品オファリングの表示名。 データタイプ:文字列 |
| externalId | 製品オファリングの外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 形式:YYYY-MM-DD HH-mm-SS |
| lifecycleStatus | 製品オファリングの現在のライフサイクルステータス。 可能な値:
データタイプ:文字列 デフォルト:空白の文字列 |
| 名前 | 製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse。名前 |
特性の名前。
データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productCharacteristicです。価値 | 特性の値。 データタイプ:文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice です。価格 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。税込み金額 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。taxIncludedAmount です。単位 | 製品オファリング価格の通貨コード。 データタイプ:文字列 |
| productOfferingPrice です。価格。taxIncludedAmount です。価値 | 税込みの製品オファリングの価格。 データタイプ:文字列 |
| productOfferingPrice です。価格タイプ | 製品オファリング価格が 1 回払いまたは繰り返し支払いであるかを識別します。 可能な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間。 データタイプ:文字列 |
| productSpecification | 製品の製品仕様。 データタイプ: オブジェクト |
| productSpecificationです。身分証明書 | 製品仕様レコードのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。名前 | 製品仕様の名前。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの名前フィールド。 |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| ステータス | 製品オファリングのステータス。 可能な値:
データタイプ:文字列 |
| validFor | 製品オファリングが有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 製品オファリングの終了日。 データタイプ:文字列 形式:YYYY-MM-DD |
| validFor。startDateTime | 製品オファリングの開始日。 データタイプ:文字列 形式:YYYY-MM-DD |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
cURL 要求
この例では、指定された製品オファリングを取得します。
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
--user 'username':'password'
応答本文:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": false,
"value": "When in use"
}
]
},
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": true,
"value": "Premium"
}
]
}
],
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
"id": "0f61dd9fd0a63110f8770dbf976be168",
"externalId": "EXT-123",
"name": "Solana Sports streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
"id": "62619d9fd0a63110f8770dbf976be180",
"externalId": "EXT-345",
"name": "Solana Movie streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2025-02-27 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "Base (10 site)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
製品カタログオープン API:GET /sn_tmf_api/catalogmanagement/productOfferingPrice
インスタンス内のすべての価格明細レコードを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| lastUpdate | 価格ラインの最終更新日で結果をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| 名前 | 指定された価格リストの名前に属する価格明細をフィルタリングします。 テーブル:価格リスト [sn_csm_pricing_price_list] データタイプ:文字列 |
| price.value | 特定の表示価格値で結果をフィルタリングします。 データタイプ:文字列 |
| priceList.id | 結果をフィルタリングして、指定されたsys_idの価格リストのみを返します。 テーブル:価格リスト [sn_csm_pricing_price_list] データタイプ:文字列 |
| 価格タイプ | 製品オファリングの価格設定方法別に結果をフィルタリングします。 有効な値:
データタイプ:文字列 |
| productOffering です。身分証明書 | 製品オファリングのsys_idで価格明細をフィルタリングします。 テーブル:製品オファリング [sn_prd_pm_product_offering] データタイプ:文字列 |
| unitOfMeasure です。身分証明書 | 測定単位のsys_idで価格明細をフィルタリングします。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| validFor。endDateTime | 指定された終了日時で価格明細をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| validFor。startDateTime | 指定された開始日時で価格明細をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| @type | 価格明細のタイプ。常に ProductOfferingPrice の値です。データタイプ:文字列 |
| href | インスタンス内の価格明細レコードの URL。 データタイプ:文字列 |
| ID | 価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| lastUpdate | 価格明細が最後に更新された日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| 価格 | 価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| price.units | 価格の通貨コード。たとえば、USD や EUR などです。 テーブル:通貨 [fx_currency] データタイプ:文字列 |
| price.value | 価格の値。 データタイプ:文字列(数値で表される) |
| priceList | 価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 価格リスト [sn_csm_pricing_price_list] テーブル内の価格リストSys_id。 データタイプ:文字列 |
| priceList.name | 価格リストの名前。 データタイプ:文字列 |
| priceList.@type | 価格リストのタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。常に priceList の値を持ちます。データタイプ:文字列 |
| 価格タイプ | この価格明細に関連付けられている製品オファリングの価格設定方法。 可能な値:
データタイプ:文字列 |
| productOffering | 価格明細に関連付けられている製品オファリング。 データタイプ: オブジェクト |
| productOffering.id | 製品オファリングの sys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。例: PRDOF01024。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ:文字列 |
| productOffering です。名前 | 製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| recurringChargePeriodType | この価格明細に関連付けられた製品オファリングの周期性または頻度。priceTypeが繰り返しに設定されている場合は頻度タイプを返し、それ以外の場合は空の文字列を返します。可能な値:
データタイプ:文字列 |
| unitOfMeasure | 価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure.amount | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure.id | 測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、年やバンドルなどです。データタイプ:文字列 |
| validFor | 価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日時。 データタイプ:文字列 (glide_date_time) |
| validFor.startDate | 価格明細が有効である開始日時。 データタイプ:文字列 (glide_date_time) |
cURL 要求
次の例では、インスタンスに存在する 2 つの価格明細をすべて返します。
curl "http://instance.servicenow.com/api/sn_tmf_api/ catalogmanagement/productOfferingPrice " \
--request GET\
--user 'username':'password'
応答本文。
[
{
"id": "2c4628ac7f4f9e50f8994fa63c86653c",
"name": "new Price list",
"lastUpdate": "2025-01-08 19:57:28",
"isBundle": false,
"lifecycleStatus": "Draft",
"href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/2c4628ac7f4f9e50f8994fa63c86653c",
"validFor": {
"startDateTime": "2027-03-22 22:15:58",
"endDateTime": ""
},
"productOffering": {
"id": "f2c92ac6a5260210f8774c9b4be6ce56",
"name": "Managed Connectivity Services Supreme Bundle",
"internalVersion": "1"
},
"priceType": "one_time",
"recurringChargePeriodType": "",
"unitOfMeasure": {
"id": "9a7a119953020110286eddeeff7b1238",
"amount": 1,
"units": "Month"
},
"price": {
"units": "USD",
"value": "800"
},
"priceList": {
"id": "d653246c7f4f9e50f8994fa63c86655a",
"name": "new Price list",
"@type": "priceList"
},
"@type": "ProductOfferingPrice"
},
{
"id": "dfb7ec607f8f9e50f8994fa63c866569",
"name": "new Price list",
"lastUpdate": "2025-01-08 19:57:46",
"isBundle": false,
"lifecycleStatus": "Draft",
"href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
"validFor": {
"startDateTime": "2026-05-28 22:15:58",
"endDateTime": ""
},
"productOffering": {
"id": "f2c92ac6a5260210f8774c9b4be6ce56",
"name": "Managed Connectivity Services Supreme Bundle",
"internalVersion": "1"
},
"priceType": "one_time",
"recurringChargePeriodType": "",
"unitOfMeasure": {
"id": "1eaa559953020110286eddeeff7b12c7",
"amount": 1,
"units": "Year"
},
"price": {
"units": "USD",
"value": "800"
},
"priceList": {
"id": "d653246c7f4f9e50f8994fa63c86655a",
"name": "new Price list",
"@type": "priceList"
},
"@type": "ProductOfferingPrice"
}
]
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
特定の価格明細の詳細を取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 必須。取得する価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| lastUpdate | 価格ラインの最終更新日で結果をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| 名前 | 指定された価格リストの名前に属する価格明細をフィルタリングします。 テーブル:価格リスト [sn_csm_pricing_price_list] データタイプ:文字列 |
| price.value | 特定の表示価格値で結果をフィルタリングします。 データタイプ:文字列 |
| priceList.id | 結果をフィルタリングして、指定されたsys_idの価格リストのみを返します。 テーブル:価格リスト [sn_csm_pricing_price_list] データタイプ:文字列 |
| 価格タイプ | 製品オファリングの価格設定方法別に結果をフィルタリングします。 有効な値:
データタイプ:文字列 |
| productOffering です。身分証明書 | 製品オファリングのsys_idで価格明細をフィルタリングします。 テーブル:製品オファリング [sn_prd_pm_product_offering] データタイプ:文字列 |
| unitOfMeasure です。身分証明書 | 測定単位のsys_idで価格明細をフィルタリングします。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| validFor。endDateTime | 指定された終了日時で価格明細をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| validFor。startDateTime | 指定された開始日時で価格明細をフィルタリングします。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| @type | 価格明細のタイプ。常に ProductOfferingPrice の値です。データタイプ:文字列 |
| href | インスタンス内の価格明細レコードの URL。 データタイプ:文字列 |
| ID | 価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| lastUpdate | 価格明細が最後に更新された日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| 価格 | 価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| price.units | 価格の通貨コード。たとえば、USD や EUR などです。 テーブル:通貨 [fx_currency] データタイプ:文字列 |
| price.value | 価格の値。 データタイプ:文字列(数値で表される) |
| priceList | 価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 価格リスト [sn_csm_pricing_price_list] テーブル内の価格リストSys_id。 データタイプ:文字列 |
| priceList.name | 価格リストの名前。 データタイプ:文字列 |
| priceList.@type | 価格リストのタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。常に priceList の値を持ちます。データタイプ:文字列 |
| 価格タイプ | この価格明細に関連付けられている製品オファリングの価格設定方法。 可能な値:
データタイプ:文字列 |
| productOffering | 価格明細に関連付けられている製品オファリング。 データタイプ: オブジェクト |
| productOffering.id | 製品オファリングの sys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。例: PRDOF01024。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ:文字列 |
| productOffering です。名前 | 製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| recurringChargePeriodType | この価格明細に関連付けられた製品オファリングの周期性または頻度。priceTypeが繰り返しに設定されている場合は頻度タイプを返し、それ以外の場合は空の文字列を返します。可能な値:
データタイプ:文字列 |
| unitOfMeasure | 価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure.amount | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure.id | 測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、年やバンドルなどです。データタイプ:文字列 |
| validFor | 価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日時。 データタイプ:文字列 (glide_date_time) |
| validFor.startDate | 価格明細が有効である開始日時。 データタイプ:文字列 (glide_date_time) |
cURL 要求
次の例では、ID dfb7ec60... の製品オファリング価格の詳細を返します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569" \
--request GET\
--user 'username':'password'
起動します
{
"id": "dfb7ec607f8f9e50f8994fa63c866569",
"name": "new Price list",
"lastUpdate": "2025-01-08 19:57:46",
"isBundle": false,
"lifecycleStatus": "Draft",
"href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
"validFor": {
"startDateTime": "2026-05-28 22:15:58",
"endDateTime": ""
},
"productOffering": {
"id": "f2c92ac6a5260210f8774c9b4be6ce56",
"name": "Managed Connectivity Services Supreme Bundle",
"internalVersion": "1"
},
"priceType": "one_time",
"recurringChargePeriodType": "",
"unitOfMeasure": {
"id": "1eaa559953020110286eddeeff7b12c7",
"amount": 1,
"units": "Year"
},
"price": {
"units": "USD",
"value": "800"
},
"priceList": {
"id": "d653246c7f4f9e50f8994fa63c86655a",
"name": "new Price list",
"@type": "priceList"
},
"@type": "ProductOfferingPrice"
}
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/productSpecification
すべての製品仕様レコードを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productSpecification
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド:
データタイプ:文字列 デフォルト:すべてのフィールドを返します。 |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 データタイプ:数値 デフォルト値:20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 データタイプ:数値 デフォルト:0 |
| state | 製品仕様をステータス別にフィルタリングします。指定されたステータスの製品仕様のみが応答で返されます。 指定できる値:
データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ:application/json または application/xml。 デフォルト: application/json |
| ヘッダー | 説明 |
|---|---|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Link | クエリー結果内を移動するための次のリンクが含まれています。
|
| X-Total-Count | ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。 |
| 206 | 応答で部分的なリソースが返されました (ページネーションあり)。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 |
応答本文のパラメーター (JSON)
| 名前 | 説明 |
|---|---|
| description | 仕様の説明。 データタイプ:文字列 |
| displayName | 製品仕様の表示名。 データタイプ:文字列 |
| externalId |
製品仕様の外部 ID。
データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| ID | 製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| internalId |
製品仕様のSys_idまたは内部 ID。
データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| バンドル | productSpecificationが単一の製品を表すか、製品のバンドルを表すかを示すフラグ。 可能な値: データタイプ:ブーリアン
|
| lastUpdate | 仕様が最後に更新された日付。 データタイプ:文字列 |
| lifecycleStatus | 製品仕様の現在のライフサイクル状況。 可能な値:
データタイプ:文字列 |
| name | 仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 製品仕様特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 |
| productSpecCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
|
| productSpecificationRelationship | この仕様と他の製品仕様との関係。 データタイプ:オブジェクトのアレイ |
| productSpecificationRelationship。compatibilityRelationshipType | 製品仕様の互換性関係タイプに必要な値。 互換性関係の詳細については、「 Configuring compatibility rules for horizontal relationships」を参照してください。 テーブル:互換性 [sn_compt_mgmt_compatibles] |
| productSpecificationRelationship.id | 関連仕様のSys_id。 データタイプ:文字列 |
| productSpecificationRelationship。内部 ID | 製品仕様関係のSys_id (内部 ID)。 データタイプ:文字列 |
| productSpecificationRelationship。内部バージョン | 製品仕様関係のバージョン。 データタイプ:文字列 |
| productSpecificationRelationship。名前 | 製品仕様関係の名前。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption | 製品仕様関係のカーディナリティ。 データタイプ: オブジェクト |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelDefault | 製品仕様のデフォルト値。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelLowerLimit | 購入可能な注文の最小数。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelUpperLimit | 購入可能な注文の最大数。 データタイプ:文字列 |
| productSpecificationRelationship。種類 | 製品仕様関係のタイプ。 データタイプ:文字列 |
| productSpecificationRelationship。validFor | 製品仕様関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日。 データタイプ:文字列 |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日。 データタイプ:文字列 |
| productSpecificationRelationship。バージョン | 製品仕様関係のバージョン。 データタイプ:文字列 |
| resourceSpecification | この製品仕様に関連するリソース仕様のリスト。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | リソース仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| ステータス | 製品仕様のステータス。 可能な値:
データタイプ:文字列 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日。 データタイプ:文字列 形式:YYYY-MM-DD |
| validFor。startDateTime | 仕様の開始日。 データタイプ:文字列 形式:YYYY-MM-DD |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
cURL 要求
この例では、最初の 2 つの製品仕様レコードを取得します。
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'
応答本文:
[
{
"id": "0435b48a742e4a10f877468e695efa3c",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/0435b48a742e4a10f877468e695efa3c",
"name": "Managed PoS PS",
"displayName": "Managed PoS PS",
"version": "",
"internalVersion": "1",
"internalId": "0435b48a742e4a10f877468e695efa3c",
"description": "Managed PoS PS",
"lastUpdate": "2032-09-26 20:07:12",
"lifecycleStatus": "Active",
"isBundle": false,
"validFor": {
"startDateTime": "2032-09-26",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "4",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "2",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "1",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
}
],
"name": "Number of POS Terminals",
"description": "Number of POS Terminals",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-05-31 21:43:14"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Gold",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "Bronze",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "Silver",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
}
],
"name": "Managed Service Level",
"description": "Managed Service Level",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-05-31 21:15:24"
}
}
],
"status": "published"
},
{
"id": "1a0936f840102610f87798b149fd435d",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/1a0936f840102610f87798b149fd435d",
"name": "Wi-Fi Configuration Setup Service PS",
"displayName": "Wi-Fi Configuration Setup Service PS",
"version": "",
"internalVersion": "1",
"internalId": "1a0936f840102610f87798b149fd435d",
"description": "Wi-Fi Configuration Setup Service PS",
"lastUpdate": "2025-03-13 21:01:14",
"lifecycleStatus": "Active",
"isBundle": false,
"validFor": {
"startDateTime": "2025-03-12",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [],
"resourceSpecification": [],
"productSpecCharacteristic": [],
"status": "published"
}
]
製品カタログオープン API - GET /sn_tmf_api/catalogmanagement/productSpecification/{id}
指定された製品仕様レコードを取得します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 取得する製品仕様のSys_idまたは初期バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはinitial_versionフィールド。 |
| 名前 | 説明 |
|---|---|
| fields | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド:
データタイプ:文字列 デフォルト:すべてのフィールドを返します。 |
| state | 製品仕様をステータス別にフィルタリングします。指定されたステータスの製品仕様のみが応答で返されます。 指定できる値:
データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON)
| 名前 | 説明 |
|---|---|
| description | 仕様の説明。 データタイプ:文字列 |
| displayName | 製品仕様の表示名。 データタイプ:文字列 |
| externalId |
製品仕様の外部 ID。
データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| ID | 製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| internalId |
製品仕様のSys_idまたは内部 ID。
データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| バンドル | productSpecificationが単一の製品を表すか、製品のバンドルを表すかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品仕様が最後に更新された日付。 データタイプ:文字列 |
| lifecycleStatus | 製品仕様の現在のライフサイクル状況。 有効な値:
データタイプ:文字列 デフォルト:空白の文字列 |
| 名前 | 製品仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 製品仕様特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 |
| productSpecCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 | 特性の値。 データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
|
| productSpecificationRelationship | この仕様と他の製品仕様との関係。 データタイプ:オブジェクトのアレイ |
| productSpecificationRelationship。compatibilityRelationshipType | 製品仕様の互換性関係タイプに必要な値。 互換性関係の詳細については、「 Configuring compatibility rules for horizontal relationships」を参照してください。 テーブル:互換性 [sn_compt_mgmt_compatibles] |
| productSpecificationRelationship.id | 関連仕様のSys_id。 データタイプ:文字列 |
| productSpecificationRelationship。内部 ID | 製品仕様関係のSys_id (内部 ID)。 データタイプ:文字列 |
| productSpecificationRelationship。内部バージョン | 製品仕様関係のバージョン。 データタイプ:文字列 |
| productSpecificationRelationship。名前 | 製品仕様関係の名前。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption | 製品仕様関係のカーディナリティ。 データタイプ: オブジェクト |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelDefault | 製品仕様のデフォルト値。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelLowerLimit | 購入可能な注文の最小数。 データタイプ:文字列 |
| productSpecificationRelationship。prodSpecRelationshipOption。numberSpecRelUpperLimit | 購入可能な注文の最大数。 データタイプ:文字列 |
| productSpecificationRelationship。種類 | 製品仕様関係のタイプ。 データタイプ:文字列 |
| productSpecificationRelationship。validFor | 製品仕様関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日。 データタイプ:文字列 |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日。 データタイプ:文字列 |
| productSpecificationRelationship。バージョン | 製品仕様関係のバージョン。 データタイプ:文字列 |
| resourceSpecification | この製品仕様に関連するリソース仕様のリスト。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | リソース仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| ステータス | 製品仕様のステータス。 可能な値:
データタイプ:文字列 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日。 データタイプ:文字列 |
| validFor。startDateTime | 仕様の開始日。 データタイプ:文字列 |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
この例では、指定された製品仕様レコードを取得します。
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6" \
--header "Accept:application/json" \
--user 'username':'password'
応答本文:
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/497a39a7c3d312105acc9e62b540dd14",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v4",
"version": "",
"internalVersion": "4",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2029-04-15 20:05:37",
"lifecycleStatus": "Active",
"isBundle": true,
"validFor": {
"startDateTime": "2033-04-15",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2030-09-25",
"endDateTime": "2035-10-27"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2030-09-27",
"endDateTime": "2035-10-27"
}
},
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "2",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2029-04-03",
"endDateTime": ""
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "0.01",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "0.25",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "0.5",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "1",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "4 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "4 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.50",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.00",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "5 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "1 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "500 Mbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Yes",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "No",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-12-13 02:29:08"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Yes",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "No",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-12-13 02:30:39"
}
}
],
"status": "published"
}
製品カタログオープン API - PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}
指定された製品オファリングを更新します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 更新する製品オファリングのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| カテゴリ | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ テーブル:カテゴリ [sc_category] |
| category.id | category パラメーターを使用する場合は必須です。カテゴリの ID。 データタイプ:文字列 テーブル:カテゴリ [sc_category] |
| category.name | カテゴリの名前。 データタイプ:文字列 デフォルト:空白の文字列 |
| channel | 必須です。製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| channel.description | チャネルの説明。 データタイプ:文字列 デフォルト:空白の文字列 |
| channel.id | 必須。チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 デフォルト:空白の文字列 |
| description | 必須です。製品オファリングの説明。 データタイプ:文字列 |
| displayName | 製品オファリングの表示名。 データタイプ:文字列 |
| externalId | 製品オファリングの外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_id フィールド。 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS デフォルト:空白の文字列 |
| lifecycleStatus | 製品オファリングの現在のライフサイクルステータス。 可能な値:
データタイプ:文字列 |
| name | 必須です。製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse.name | 必須。 特性の名前。 データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristic.name | 特性の名前。 データタイプ:文字列 デフォルト:空白の文字列 |
| productCharacteristic.value | 特性の値。 データタイプ:文字列 デフォルト:空白の文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice.price | 製品オファリングの価格情報。 データタイプ:オブジェクト |
| productOfferingPrice.price.taxIncludedAmount | 製品オファリングの価格情報。 データタイプ:オブジェクト |
| productOfferingPrice.price.taxIncludedAmount.unit | 製品オファリング価格の通貨コード。 データタイプ:文字列 デフォルト:空白の文字列 |
| productOfferingPrice.price.taxIncludedAmount.value | 税込みの製品オファリングの価格。 データタイプ:文字列 デフォルト:空白の文字列 |
| productOfferingPrice.priceType | 製品オファリングタイプのタイプ。productOfferingPrice パラメーターを使用する場合は必須です。 有効な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間 。 データタイプ:文字列 デフォルト:空白の文字列 |
| productSpecification | 必須です。製品の製品仕様。 データタイプ:オブジェクト |
| productSpecification.id | 必須。製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] のsys_idフィールドまたはexternal_idフィールド |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。名前 | 製品仕様の名前。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの名前フィールド。 |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| ステータス | 製品オファリングのステータス。 可能な値:
データタイプ:文字列 |
| validFor | 必須です。製品オファリングが有効な日付範囲。 データタイプ:オブジェクト |
| validFor.endDateTime | 必須。製品オファリングの終了日時。 データタイプ:文字列 形式:YYYY-MM-DD |
| validFor.startDateTime | 必須。製品オファリングの開始日時。 データタイプ:文字列 形式:YYYY-MM-DD |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
応答本文のパラメーター (JSON)
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| カテゴリ | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ |
| category.id | カテゴリの ID。 データタイプ:文字列 |
| category.name | カテゴリの名前。 データタイプ:文字列 |
| channel | 製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| channel.description | チャネルの説明。 データタイプ:文字列 |
| channel.id | チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 |
| description | 製品オファリングの説明。 データタイプ:文字列 |
| displayName | 製品オファリングの表示名。 データタイプ:文字列 |
| externalId | 製品オファリングの外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 |
| リフトサイクルステータス | 現在のライフサイクルステータス。指定できる値:
データタイプ:文字列 デフォルト:空白の文字列 |
| 名前 | 製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse。名前 |
特性の名前。
データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productCharacteristicです。価値 | 特性の値。 データタイプ:文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice です。価格 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。税込み金額 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。taxIncludedAmount.unit | 製品オファリング価格の通貨コード。 データタイプ:文字列 |
| productOfferingPrice です。価格。taxIncludedAmount です。価値 | 税込みの製品オファリングの価格。 データタイプ:文字列 |
| productOfferingPrice です。価格タイプ | 製品オファリング価格タイプ (1 回払いまたは繰り返し支払い)。 可能な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間。 データタイプ:文字列 |
| productSpecification | 製品の製品仕様。 データタイプ: オブジェクト |
| productSpecificationです。身分証明書 | 製品仕様レコードのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。地位 | 公開済みやドラフトなど、製品仕様のステータス。 データタイプ:文字列 |
| productSpecificationです。sys_id | 製品仕様の sys_id。 データタイプ:文字列 表:製品仕様 [sn_prd_pm_product_specification] |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| ステータス | 製品オファリングのステータス。 可能な値:
データタイプ:文字列 |
| validFor | 製品オファリングが有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 製品オファリングの終了日。 データタイプ:文字列 |
| validFor。startDateTime | 製品オファリングの開始日。 データタイプ:文字列 |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
次の例では、要求本文で提供された情報を使用して、sys_id 313b917843235210a82ed6085bb8f2c7 で製品オファリングを更新します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7" \
--request PATCH\
--header "Accept:application/json" \
--user 'username':'password'
--data '{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}'
応答本文:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7",
"name": "Internet",
"displayName": "Internet",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
},
{
"id": "0f61dd9fd0a63110f8770dbf976be16c",
"name": "Solana TV shows streaming channel",
"version": "1",
"externalId": "EXT-456",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"name": "Internet",
"version": "1",
"externalId": "EXT-678",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "3"
}
},
{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "1161a4f8436b1210a82ed6085bb8f216",
"name": "Internet",
"version": "1",
"externalId": "EXT-910",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Advance (50 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
製品カタログオープン API - PATCH /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
価格明細 [sn_csm_pricing_price_list_line] テーブルの指定されたsys_idで価格明細レコードを更新します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 必須。取得する価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| @type | 必須。価格明細のタイプ。常に ProductOfferingPrice の値です。データタイプ:文字列 |
| externalId | 価格明細の外部 ID。 データタイプ:文字列 |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 必須。価格ラインが最後に更新された日付。 形式:YYYY-MM-DD データタイプ:文字列 |
| ライフサイクルステータス | 必須。製品リスト品目の現在のライフサイクル状況。 有効な値:
データタイプ:文字列 デフォルト:draft |
| 名前 | 必須。価格明細を指定する名前。 データタイプ:文字列 |
| 価格 | 必須。価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| 価格.単位 | 必須。価格明細の通貨コード。たとえば、USD や EUR などです。テーブル:通貨 [fx_currency] テーブル。 データタイプ:文字列 |
| price.value | 必須。価格の値。 データタイプ:文字列 (数値で表されます。たとえば |
| priceList | 必須。価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 必須。価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| priceList.name | 価格明細の名前。 データタイプ:文字列 |
| priceList.@type | 価格明細のタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。値は常に priceList です。データタイプ:文字列 |
| 価格タイプ | 必須。製品オファリングの価格設定方法で価格明細をフィルタリングします。 有効な値:
データタイプ:文字列 デフォルト:recurring |
| productOffering | 必須。価格明細の製品オファリング。 データタイプ: オブジェクト |
| productOffering です。身分証明書 | 必須。製品オファリングの sys_id。 テーブル:製品オファリング [sn_prd_pm_product_offering] データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。 データタイプ:文字列 (数値で表されます。たとえば |
| productOffering です。名前 | 製品オファリングの名前。 データタイプ:文字列 |
| recurringChargePeriodType | priceTypeを繰り返す場合は必須です。製品オファリングの作成時に選択されたコミットメント期間。 有効な値:
データタイプ:文字列 |
| unitOfMeasure | 必須。価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure です。量 | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure です。身分証明書 | 必須。価格品目リストテーブル内の測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、 それぞれ または バンドルです。データタイプ:文字列 |
| validFor | 必須。価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日。 データタイプ:文字列 (glide_date_time) |
| validFor.endDateTime | 価格明細が有効である終了日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 (glide_date) |
| validFor.startDate | 価格明細が有効である開始日。 データタイプ:文字列 (glide_date_time) |
| validFor.startDateTime | 価格明細が有効である開始日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 (glide_date) |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| ID | 価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| href | インスタンス内の価格明細レコードの URL。 データタイプ:文字列 |
| lastUpdate | 価格明細が最後に更新された日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| validFor | 価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日時。 データタイプ:文字列 (glide_date_time) |
| validFor.startDate | 価格明細が有効である開始日時。 データタイプ:文字列 (glide_date_time) |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| productOffering | 価格明細に関連付けられている製品オファリング。 データタイプ: オブジェクト |
| productOffering.id | 製品オファリングの sys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。例: PRDOF01024。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ:文字列 |
| productOffering です。名前 | 製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| 価格タイプ | この価格明細に関連付けられている製品オファリングの価格設定方法。 可能な値:
データタイプ:文字列 |
| recurringChargePeriodType | この価格明細に関連付けられた製品オファリングの周期性または頻度。priceTypeが繰り返しに設定されている場合は頻度タイプを返し、それ以外の場合は空の文字列を返します。可能な値:
データタイプ:文字列 |
| unitOfMeasure | 価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure.amount | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure.id | 測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、年やバンドルなどです。データタイプ:文字列 |
| 価格 | 価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| price.units | 価格の通貨コード。たとえば、USD や EUR などです。 テーブル:通貨 [fx_currency] データタイプ:文字列 |
| price.value | 価格の値。 データタイプ:文字列(数値で表される) |
| priceList | 価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 価格リスト [sn_csm_pricing_price_list] テーブル内の価格リストSys_id。 データタイプ:文字列 |
| priceList.name | 価格リストの名前。 データタイプ:文字列 |
| priceList.@type | 価格リストのタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。常に priceList の値を持ちます。データタイプ:文字列 |
| @type | 常に ProductOfferingPrice の値です。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。データタイプ:文字列 |
| state | この価格明細に関連付けられている価格リストのステータス。 データタイプ:文字列 |
| externalId | この価格明細の外部 ID。 データタイプ:文字列 |
cURL 要求
次の例では、製品オファリング価格が ID 3ddd0...は有効です。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request patch\
--user 'username':'password'
--data {
"validFor": {
"endDateTime": "2024-06-25 15:15:58"
}
}
応答本文:
{
"validFor": {
"endDateTime": "2024-06-25 15:15:58"
},
"id": "994d5d364f8b5210f899f61d20ce0b7c",
"name": "new Price list",
"lastUpdate": "2025-01-16 00:15:32",
"href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
"lifecycleStatus": "Draft"
}
製品カタログオープン API - PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
指定された製品仕様を更新します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| ID | 更新する製品オファリングのSys_id。 データタイプ:文字列 表:製品仕様 [sn_prd_pm_product_specification] |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| description | 必須です。仕様の説明。 データタイプ:文字列 |
| externalId | 必須。 製品仕様の外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_id フィールド。 |
| ID | 製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| internalId | 必須。 製品仕様のSys_idまたは内部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| バンドル | productSpecificationが単一の製品を表すか、製品のバンドルを表すかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 仕様が最後に更新された日付。 データタイプ:文字列 デフォルト:空白の文字列 |
| name | 必須です。仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 仕様特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 |
| productSpecCharacteristicです。名前 | 必須。特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。endDateTime | 特性の終了日時 形式:YYYY-MM-DD HH:mm:SS。例: データタイプ:文字列 |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日時 形式:YYYY-MM-DD HH:mm:SS。例: データタイプ:文字列 |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
デフォルト値:空の文字列 |
| productSpecificationRelationship | 仕様と他の製品仕様との関係の詳細。 データタイプ:オブジェクトのアレイ |
| productSpecificationRelationship。身分証明書 | 関連仕様の ID。 データタイプ:文字列 |
| productSpecificationRelationship。種類 | productSpecificationRelationship パラメーターを使用する場合は必須です。関係のタイプ。 有効な値:
データタイプ:文字列 |
| productSpecificationRelationship。validFor | 関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日。 形式:YYYY-MM-DD HH:mm:SS。例: データタイプ:文字列 |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日。 形式:YYYY-MM-DD 00:00:00。例: データタイプ:文字列 |
| resourceSpecification | 必須。この製品仕様に関連するリソース仕様の詳細。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | 必須。リソース仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| validFor | 必須です。仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日時。 形式:YYYY-MM-DD 00:00:00。例: データタイプ:文字列 |
| validFor。startDateTime | 仕様の開始日時。 形式:YYYY-MM-DD 00:00:00。例: データタイプ:文字列 |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 要求が正常に処理されました。 |
| 400 | 要求が正しくありません。考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| description | 仕様の説明。 データタイプ:文字列 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 |
| ID | 製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| internalId | 必須。 製品仕様のSys_idまたは内部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| lastUpdate | 仕様が最後に更新された日付。 形式:YYYY-MM-DD 00:00:00。 データタイプ:文字列 |
| name | 仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 仕様の特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 |
| productSpecCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。endDateTime | 特性の終了日時 形式:YYYY-MM-DD 00:00:00。 データタイプ:文字列 |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日時 形式:YYYY-MM-DD 00:00:00。 データタイプ:文字列 |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
|
| productSpecificationRelationship | この仕様と他の製品仕様との関係。 データタイプ:オブジェクトのアレイ |
| productSpecificationRelationship。身分証明書 | 関連仕様のSys_id。 データタイプ:文字列 |
| productSpecificationRelationship。種類 | 関係のタイプ。 データタイプ:文字列 |
| productSpecificationRelationship。validFor | 関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日とタイプ。 形式:YYYY-MM-DD データタイプ:文字列 |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日とタイプ。 形式:YYYY-MM-DD データタイプ:文字列 |
| resourceSpecification | この製品仕様に関連するリソース仕様のリスト。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | リソース仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日時。 形式:YYYY-MM-DD HH:mm:SS。 データタイプ:文字列 |
| validFor。startDateTime | 仕様の開始日時。 形式:YYYY-MM-DD HH:mm:SS。 データタイプ:文字列 |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
次の例では、製品仕様 ID d6f8d9995b020210235d85cced81c7eb を要求本文で指定された情報で更新します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \
--request PATCH\
--header "Accept:application/json" \
--user 'username':'password'
--data '{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
応答本文:
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
製品カタログオープン API - POST /sn_tmf_api/catalogmanagement/catalog
製品オファリングカタログを作成します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/catalog
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| description | 製品オファリングカタログの説明。 データタイプ:文字列 デフォルト:空白の文字列 |
| externalId | 外部システムからの製品オファリングカタログの一意の識別子。 データタイプ:文字列 デフォルト:空白の文字列 |
| name | 必須です。製品オファリングカタログの名前。 データタイプ:文字列 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 要求が正常に処理されました。 |
| 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。
|
応答本文のパラメーター (JSON)
| 名前 | 説明 |
|---|---|
| description | 製品オファリングカタログの説明。 データタイプ:文字列 |
| ID | 製品オファリングカタログのSys_id データタイプ:文字列 テーブル:製品オファリングカタログ [sn_prd_pm_product_offering_catalog] |
| 名前 | 製品オファリングカタログの名前。 データタイプ:文字列 |
cURL 要求
この例では、製品オファリングカタログを作成します。
curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "testId",
"name": "Catalog",
"description": "Description"
}'
--user 'username':'password'
応答本文:
{
"id": "45715d02c3510110bc0526083c40dd6b",
"description": "Description",
"name": "Catalog1"
}
製品カタログオープン API - POST /sn_tmf_api/catalogmanagement/productOffering
製品オファリングおよび関連付けられた製品オファリングバンドルを作成します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOffering
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| カテゴリ | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ |
| category.id | category パラメーターを使用する場合は必須です。カテゴリの ID。 データタイプ:文字列 テーブル:カテゴリ [sc_category] |
| category.name | カテゴリの名前。 データタイプ:文字列 テーブル:カテゴリ [sc_category] |
| チャネル | 必須です。製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| channel.description | チャネルの説明。 データタイプ:文字列 |
| channel.id | 必須。チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 |
| 説明 | 必須です。製品オファリングの説明。 データタイプ:文字列 |
| displayName | 製品オファリングの表示名。 データタイプ:文字列 |
| externalId | 外部システムからの製品オファリングの一意の識別子。 データタイプ:文字列 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| lifecycleStatus | 現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| name | 必須です。製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse。名前 |
特性の名前。
データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristic.name | 特性の名前。 データタイプ:文字列 |
| productCharacteristic.value | 特性の値。 データタイプ:文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice.price | 製品オファリングの価格情報。 データタイプ:オブジェクト |
| productOfferingPrice.price.taxIncludedAmount | 製品オファリングの価格情報。 データタイプ:オブジェクト |
| productOfferingPrice.price.taxIncludedAmount.unit | 製品オファリング価格の通貨コード。 データタイプ:文字列 フォーマット:ISO 4217 |
| productOfferingPrice.price.taxIncludedAmount.value | 税込みの製品オファリングの価格。 データタイプ:文字列 |
| productOfferingPrice.priceType | productOfferingPrice パラメーターを使用する場合は必須です。製品オファリング価格タイプ (1 回払いまたは繰り返し支払い)。 有効な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間 (12 か月、24 か月、not_applicableなど)。 データタイプ:文字列 |
| productSpecification | 必須です。製品の製品仕様。 データタイプ:オブジェクト |
| productSpecification.id | 必須。製品仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのinitial_versionフィールドまたはexterna_idフィールド。 |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。名前 | 製品仕様の名前。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの名前フィールド。 |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| validFor | 必須です。製品オファリングが有効な日付範囲。 データタイプ:オブジェクト |
| validFor.endDateTime | 製品オファリングの終了日。 データタイプ:文字列 形式:YYYY-MM-DD |
| validFor.startDateTime | 製品オファリングの開始日。 データタイプ:文字列 形式:YYYY-MM-DD |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。考えられる理由:
|
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| bundledGroupProductOffering | 製品オファリングの子グループ。これらは階層的なサブグループ化を示しています。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。bundledGroupProductOfferingOption | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限と上限を指定する数値の範囲。 データタイプ: オブジェクト |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの下限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledGroupProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる製品オファリングの上限。 データタイプ:文字列 |
| bundledGroupProductOffering。bundledProductOffering | バンドルに関連付けられた製品オファリングの子グループ。以下で指定する bundledProductOffering と同じ形式です。 データタイプ:オブジェクトのアレイ |
| bundledGroupProductOffering。身分証明書 | バンドルされたグループレコードのSys_id。親製品オファリングまたはグループに複数のグループが含まれている場合に便利です。 データタイプ:文字列 テーブル:製品オファリングの関係グループ [sn_prd_pm_product_offering_relationship_group] |
| bundledGroupProductOffering。名前 | 子製品オファリングのグループの名前。 データタイプ:文字列 |
| bundledProductOffering | 製品オファリングバンドルに含まれる製品オファリングのリスト。製品オファリングバンドルは、含まれている製品オファリングのすべての属性を継承します。 データタイプ:オブジェクトのアレイ |
| bundledProductOffering。bundledProductOfferingOption | 製品オファリングのデフォルト数や製品オファリングの上下の調達制約などの製品バンドルオプション。 データタイプ: オブジェクト |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferDefault | 関連するバンドル製品オファリングの一部として調達する必要がある製品オファリングのデフォルト数。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferLowerLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の下限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。bundledProductOfferingOption。numberRelOfferUpperLimit | 関連するバンドル製品オファリングの一部として調達できる関連製品オファリングの数の上限。 データタイプ:文字列 可能な値:0 からバインド解除。 |
| bundledProductOffering。externalId | 製品オファリング関係の外部 ID。 製品オファリングの関係の詳細については、「 Create product offering relationships」を参照してください。 データタイプ:文字列 |
| bundledProductOffering。HREF | 関連する製品オファリングへの相対リンク。 データタイプ:文字列 |
| bundledProductOffering。身分証明書 | バンドルされた製品オファリングの Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] |
| bundledProductOffering。名前 | 製品オファリングバンドルの名前。 データタイプ:文字列 |
| bundledProductOffering。バージョン | 製品オファリングのカタログバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| category | 製品が属するカテゴリのリスト。 データタイプ:オブジェクトのアレイ |
| category.id | カテゴリの ID。 データタイプ:文字列 |
| category.name | カテゴリの名前。 データタイプ:文字列 |
| channel | 製品オファリングの販売に使用するチャネル。 データタイプ:オブジェクトのアレイ |
| チャンネル。形容 | チャネルの説明。 データタイプ:文字列 |
| channel.id | チャネルのSys_id。 データタイプ:文字列 テーブル:流通チャネル [sn_prd_pm_distribution_channel] |
| channel.name | チャネルの名前。 データタイプ:文字列 |
| description | 製品オファリングの説明。 データタイプ:文字列 |
| externalId | 製品オファリングの外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_id フィールド。 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| id | 必須。製品オファリングの初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのinitial_versionフィールドまたはexternal_idフィールド。 |
| internalId | 製品オファリングレコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| internalVersion | 製品オファリングのバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| バンドル | 製品オファリングがバンドルであるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| 販売可能 | 関連付けられた製品オファリングを単独で販売できるか、または製品オファリングバンドルの一部にする必要があるかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 製品オファリングが最後に更新された日付。 データタイプ:文字列 |
| lifecycleStatus | 製品オファリングの現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 デフォルト:空白の文字列 |
| name | 製品オファリングの名前。 データタイプ:文字列 |
| prodSpecCharValueUse | 製品オファリング特性。 データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。形容 | 特性の説明。 データタイプ:文字列 |
| prodSpecCharValueUse。名前 |
特性の名前。
データタイプ:文字列 |
| prodSpecCharValueUse。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| prodSpecCharValueUse。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| prodSpecCharValueUse。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| prodSpecCharValueUse。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| prodSpecCharValueUse。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| prodSpecCharValueUse。値タイプ | prodSpecCharValueUse.productSpecCharacteristicValue.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productCharacteristic | 製品特性のリスト。 データタイプ:オブジェクトのアレイ |
| productCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productCharacteristicです。価値 | 特性の値。 データタイプ:文字列 |
| productOfferingCharacteristic | 製品オファリングの特徴的な品質または特徴的な機能。特性は、モバイル計画ランクなど、設計時 (カタログオーサリング) に固定された不連続値を取ることができます。これらの特性は、通常、在庫レベルでは変更できません。 製品オファリング特性の詳細については、「 Create product characteristics and characteristic options」を参照してください。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecification | 製品オファリング特性に関連付けられた特性値のリスト。 データタイプ:オブジェクトのアレイ |
| productOfferingCharacteristic。characteristicValueSpecificationです。isDefault | 関連する特性値が関連する特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。必須か | 関連する特性値が関連する特性に必須かどうかを示すフラグ。 可能な値:
データタイプ:ブーリアン デフォルト値:false |
| productOfferingCharacteristic。characteristicValueSpecificationです。価値 | 関連する製品仕様特性に割り当てられた番号またはテキスト。 たとえば、次のようになります。 データタイプ:文字列 |
| productOfferingCharacteristic。名前 | 関連付けられた製品オファリング特性の名前。 データタイプ:文字列 |
| productOfferingCharacteristic。値タイプ | productOfferingCharacteristic.characteristicValueSpecification.valueパラメーターのデータタイプ。 可能な値:
データタイプ:文字列 |
| productOfferingPrice | 製品オファリングの価格情報。 データタイプ:オブジェクトのアレイ |
| productOfferingPrice です。価格 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。税込み金額 | 製品オファリングの価格情報。 データタイプ: オブジェクト |
| productOfferingPrice です。価格。taxIncludedAmount.unit | 製品オファリング価格の通貨コード。 データタイプ:文字列 |
| productOfferingPrice です。価格。taxIncludedAmount です。価値 | 税込みの製品オファリングの価格。 データタイプ:文字列 |
| productOfferingPrice です。価格タイプ | 製品オファリング価格タイプ (1 回払いまたは繰り返し支払い)。 可能な値:
データタイプ:文字列 |
| productOfferingTerm | 製品オファリングの有効な契約期間。 データタイプ:文字列 |
| productSpecification | 製品の製品仕様。 データタイプ: オブジェクト |
| productSpecificationです。身分証明書 | 製品仕様レコードのSys_id。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部 ID | 製品仕様レコードの Sys_id ID または内部 ID。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] フィールド。 |
| productSpecificationです。内部バージョン | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド。 |
| productSpecificationです。バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
| ステータス | 製品オファリングのステータス。 可能な値:
データタイプ:文字列 |
| validFor | 製品オファリングが有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 製品オファリングの終了日。 データタイプ:文字列 |
| validFor。startDateTime | 製品オファリングの開始日。 データタイプ:文字列 |
| バージョン | 製品オファリングの外部バージョン。 データタイプ:文字列 テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [external_version] フィールド。 |
この例では、製品オファリングを作成します。
curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--header "Content-Type: application/json" \
--header "Accept:application/json" \
--data-raw '{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-345",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}'
--user 'username':'password'
応答本文:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-345",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
}
製品カタログオープン API - POST /sn_tmf_api/catalogmanagement/productOfferingPrice
価格明細 [sn_csm_pricing_price_list_line] テーブルに新しい価格明細レコードを作成します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| @type | 必須。価格明細のタイプ。常に ProductOfferingPrice の値です。データタイプ:文字列 |
| externalId | 価格明細の外部 ID。 データタイプ:文字列 |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 必須。価格ラインが最後に更新された日付。 形式:YYYY-MM-DD データタイプ:文字列 |
| ライフサイクルステータス | 必須。製品リスト品目の現在のライフサイクル状況。 有効な値:
データタイプ:文字列 デフォルト:draft |
| 名前 | 必須。価格明細を指定する名前。 データタイプ:文字列 |
| 価格 | 必須。価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| 価格.単位 | 必須。価格明細の通貨コード。たとえば、USD や EUR などです。テーブル:通貨 [fx_currency] テーブル。 データタイプ:文字列 |
| price.value | 必須。価格の値。 データタイプ:文字列 (数値で表されます。たとえば |
| priceList | 必須。価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 必須。価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| priceList.name | 価格明細の名前。 データタイプ:文字列 |
| priceList.@type | 価格明細のタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。値は常に priceList です。データタイプ:文字列 |
| 価格タイプ | 必須。製品オファリングの価格設定方法で価格明細をフィルタリングします。 有効な値:
データタイプ:文字列 デフォルト:recurring |
| productOffering | 必須。価格明細の製品オファリング。 データタイプ: オブジェクト |
| productOffering です。身分証明書 | 必須。製品オファリングの sys_id。 テーブル:製品オファリング [sn_prd_pm_product_offering] データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。 データタイプ:文字列 (数値で表されます。たとえば |
| productOffering です。名前 | 製品オファリングの名前。 データタイプ:文字列 |
| recurringChargePeriodType | priceTypeを繰り返す場合は必須です。製品オファリングの作成時に選択されたコミットメント期間。 有効な値:
データタイプ:文字列 |
| unitOfMeasure | 必須。価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure です。量 | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure です。身分証明書 | 必須。価格品目リストテーブル内の測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、 それぞれ または バンドルです。データタイプ:文字列 |
| validFor | 必須。価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日。 データタイプ:文字列 (glide_date_time) |
| validFor.endDateTime | 価格明細が有効である終了日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 (glide_date) |
| validFor.startDate | 価格明細が有効である開始日。 データタイプ:文字列 (glide_date_time) |
| validFor.startDateTime | 価格明細が有効である開始日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 (glide_date) |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 考えられる理由:
|
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| ID | 価格明細のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| href | インスタンス内の価格明細レコードの URL。 データタイプ:文字列 |
| lastUpdate | 価格明細が最後に更新された日時。 形式:YYYY-MM-DD HH:mm:ss データタイプ:文字列 |
| validFor | 価格明細が有効な期間。 データタイプ: オブジェクト |
| validFor.endDate | 価格明細が有効である終了日時。 データタイプ:文字列 (glide_date_time) |
| validFor.startDate | 価格明細が有効である開始日時。 データタイプ:文字列 (glide_date_time) |
| バンドル | 価格明細が単一の製品の一部であるか、製品のバンドルであるかを示すフラグ。 有効な値:
データタイプ:ブーリアン |
| lifecycleStatus | 価格明細の現在のライフサイクルステータス。 有効な値:
データタイプ:文字列 |
| productOffering | 価格明細に関連付けられている製品オファリング。 データタイプ: オブジェクト |
| productOffering.id | 製品オファリングの sys_id。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| productOffering です。内部バージョン | 製品オファリングの内部バージョン番号。例: PRDOF01024。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。データタイプ:文字列 |
| productOffering です。名前 | 製品オファリングの名前。製品オファリング [sn_prd_pm_product_offering] テーブルにあります。 データタイプ:文字列 |
| 価格タイプ | この価格明細に関連付けられている製品オファリングの価格設定方法。 可能な値:
データタイプ:文字列 |
| recurringChargePeriodType | この価格明細に関連付けられた製品オファリングの周期性または頻度。priceTypeが繰り返しに設定されている場合は頻度タイプを返し、それ以外の場合は空の文字列を返します。可能な値:
データタイプ:文字列 |
| unitOfMeasure | 価格明細に関連付けられた測定単位の詳細。 データタイプ: オブジェクト |
| unitOfMeasure.amount | 測定単位の金額。 データタイプ:数値 |
| unitOfMeasure.id | 測定単位のSys_id。 テーブル:価格明細 [sn_csm_pricing_price_list_line] データタイプ:文字列 |
| unitOfMeasure です。単位 | 価格明細に関連付けられた測定単位のタイプ。たとえば、年やバンドルなどです。データタイプ:文字列 |
| 価格 | 価格明細の表示価格の詳細。 データタイプ: オブジェクト |
| price.units | 価格の通貨コード。たとえば、USD や EUR などです。 テーブル:通貨 [fx_currency] データタイプ:文字列 |
| price.value | 価格の値。 データタイプ:文字列(数値で表される) |
| priceList | 価格明細に関連付けられた価格リスト情報。 データタイプ: オブジェクト |
| priceList.id | 価格リスト [sn_csm_pricing_price_list] テーブル内の価格リストSys_id。 データタイプ:文字列 |
| priceList.name | 価格リストの名前。 データタイプ:文字列 |
| priceList.@type | 価格リストのタイプ。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。常に priceList の値を持ちます。データタイプ:文字列 |
| @type | 常に ProductOfferingPrice の値です。サブクラス化する場合、これによりサブクラスの拡張可能な名前が定義されます。データタイプ:文字列 |
| state | この価格明細に関連付けられている価格リストのステータス。 データタイプ:文字列 |
| externalId | この価格明細の外部 ID。 データタイプ:文字列 |
cURL 要求
次の例では、要求本文で指定されたデータに従って新しい価格明細レコードを作成し、価格明細 [sn_csm_pricing_price_list_line] テーブルに挿入します。
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
--request POST\
--user 'username':'password'
--data {
"name": "new Price list",
"validFor": {
"startDateTime": "2024-05-28 15:15:58",
"endDateTime": "2025-06-28 15:15:58"
},
"priceType": "recurring",
"recurringChargePeriodType": "monthly",
"lastUpdate": "2023-09-23 00:00:00",
"isBundle": false,
"lifecycleStatus": "Draft",
"unitOfMeasure": {
"id": "1eaa559953020110286eddeeff7b12c7",
"amount": 1,
"units": "Year"
},
"price": {
"unit": "USD",
"value": "800"
},
"productOffering": {
"id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
"name": "Maintenance Fee",
"internalVersion": "1"
},
"priceList": {
"name": "new price list",
"@type": "priceList"
},
"externalId": "test123",
"@type": "ProductOfferingPrice"
}
応答本文。この新しい価格明細レコードには一意の ID が割り当てられます。応答本文は、 href 応答パラメーターを使用して、この情報と新しいレコードへの URL を返します。
{
"name": "new Price list",
"validFor": {
"startDateTime": "2024-05-28 15:15:58",
"endDateTime": "2025-06-28 15:15:58"
},
"priceType": "recurring",
"recurringChargePeriodType": "monthly",
"lastUpdate": "2023-09-23 00:00:00",
"isBundle": false,
"lifecycleStatus": "Draft",
"unitOfMeasure": {
"id": "1eaa559953020110286eddeeff7b12c7",
"amount": 1,
"units": "Year"
},
"price": {
"unit": "USD",
"value": "800"
},
"productOffering": {
"id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
"name": "Maintenance Fee",
"internalVersion": "1"
},
"priceList": {
"id": "194d5d364f8b5210f899f61d20ce0b7a",
"name": "new Price list",
"@type": "priceList"
},
"externalId": "test123",
"@type": "ProductOfferingPrice",
"id": "994d5d364f8b5210f899f61d20ce0b7c",
"state": "draft",
"href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
}
製品カタログオープン API - POST /sn_tmf_api/catalogmanagement/productSpecification
指定された値で製品仕様レコードを作成します。
URL 形式
デフォルト URL: /api/sn_tmf_api/catalogmanagement/productSpecification
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| description | 必須です。仕様の説明。 データタイプ:文字列 |
| externalId | 外部システムからの製品仕様の一意の識別子。 データタイプ:文字列 デフォルト:空白の文字列 |
| id | 必須。製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのinitial_versionまたはexternal_id。 |
| internalId | 必須。 製品仕様のSys_idまたは内部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| lastUpdate | 仕様が最後に更新された日付。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| name | 必須です。仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 仕様特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 デフォルト:空白の文字列 |
| productSpecCharacteristicです。名前 | 必須。特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue | 必須。 特性の可能な値のリスト。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 | 必須。 特性の値。 データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。endDateTime | 特性の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
デフォルト:空白の文字列 |
| productSpecificationRelationship | この仕様と他の製品仕様との関係。 データタイプ:アレイ |
| productSpecificationRelationship。身分証明書 | 関連仕様の ID。 データタイプ:文字列 デフォルト:空白の文字列 |
| productSpecificationRelationship。種類 | productSpecificationRelationship パラメーターを使用する場合は必須です。関係のタイプ。 有効な値:
データタイプ:文字列 |
| productSpecificationRelationship。validFor | 関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| resourceSpecification | 必須。この製品仕様に関連するリソース仕様。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | 必須。リソース仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| validFor | 必須です。仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| validFor。startDateTime | 仕様の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS。例: デフォルト:空白の文字列 |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
ヘッダー
次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| ヘッダー | 説明 |
|---|---|
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 201 | 要求が正常に処理されました。 |
| 400 | 要求が正しくありません。考えられる理由:
|
応答本文のパラメーター
| 名前 | 説明 |
|---|---|
| description | 仕様の説明。 データタイプ:文字列 |
| href | リソースレコードへの相対リンク。 データタイプ:文字列 デフォルト:空白の文字列 |
| ID | 製品仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| internalId | 必須。 製品仕様のSys_idまたは内部 ID。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド。 |
| internalVersion | 製品仕様のバージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールド。 |
| バンドル | productSpecificationが単一の製品を表すか、製品のバンドルを表すかを示すフラグ。 有効な値:
データタイプ:ブーリアン デフォルト値:false |
| lastUpdate | 仕様が最後に更新された日付。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| lifecycleStatus | 製品仕様の現在のライフサイクルステータス。 可能な値:
データタイプ:文字列 デフォルト:空白の文字列 |
| 名前 | 仕様の名前。 データタイプ:文字列 |
| productSpecCharacteristic | 仕様特性。 データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。形容 | 特性の説明。 データタイプ:文字列 |
| productSpecCharacteristicです。名前 | 特性の名前。 データタイプ:文字列 |
| productSpecCharacteristicです。productSpecCharacteristicValue |
特性の可能な値のリスト。
データタイプ:オブジェクトのアレイ |
| productSpecCharacteristicです。productSpecCharacteristicValue。isDefault | 関連する特性値が特性のデフォルト値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。必須か | 関連する特性値が特性の必須値であるかどうかを示すフラグ。 可能な値:
デフォルト値:false |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor | 特性が有効になった日時。 データタイプ: オブジェクト |
| productSpecCharacteristicです。productSpecCharacteristicValue。validFor。startDateTime | 特性値が有効になる開始日時。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。productSpecCharacteristicValue。価値 |
特性の値。
データタイプ:文字列 |
| productSpecCharacteristicです。validFor | 特性が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecCharacteristicです。validFor。endDateTime | 特性の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。validFor。startDateTime | 特性の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecCharacteristicです。値タイプ | 特性の値タイプ (選択肢やメールなど)。複合型または非複合型にすることができます。 データタイプ:文字列 指定できる値:
|
| productSpecificationRelationship | この仕様と他の製品仕様との関係。 データタイプ:オブジェクトのアレイ |
| productSpecificationRelationship。身分証明書 | 関連仕様のSys_id。 データタイプ:文字列 |
| productSpecificationRelationship。種類 | 関係のタイプ。 データタイプ:文字列 |
| productSpecificationRelationship。validFor | 関係が有効な日付範囲。 データタイプ: オブジェクト |
| productSpecificationRelationship。validFor。endDateTime | 関係の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| productSpecificationRelationship。validFor。startDateTime | 関係の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| resourceSpecification | この製品仕様に関連するリソース仕様のリスト。 データタイプ:オブジェクトのアレイ |
| resourceSpecification です。身分証明書 | リソース仕様の Sys_id ID または外部 ID。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| resourceSpecification です。内部 ID | リソース仕様レコードの初期バージョン (sys_id)。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの initial_version フィールド。 |
| resourceSpecification です。内部バージョン | リソース仕様のバージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルのバージョンフィールド。 |
| resourceSpecification です。名前 | リソース仕様の名前。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] |
| resourceSpecification です。バージョン | リソース仕様の外部バージョン。 データタイプ:文字列 テーブル:リソース仕様 [sn_prd_pm_resource_specification] テーブルの external_version フィールド。 |
| serviceSpecification | この製品仕様に関連するサービス仕様のリスト。 データタイプ:オブジェクトのアレイ |
| serviceSpecificationです。身分証明書 | サービス仕様の初期バージョンまたは外部 ID。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのsys_idフィールドまたはexternal_idフィールド。 |
| serviceSpecificationです。内部 ID | サービス仕様の初期バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの initial_version フィールド。 |
| serviceSpecificationです。内部バージョン | サービス仕様のバージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルのバージョンフィールド。 |
| serviceSpecificationです。名前 | サービス仕様の名前。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] |
| serviceSpecificationです。バージョン | サービス仕様の外部バージョン。 データタイプ:文字列 テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト |
| validFor。endDateTime | 仕様の終了日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| validFor。startDateTime | 仕様の開始日。 データタイプ:文字列 形式:YYYY-MM-DD HH:mm:SS |
| バージョン | 製品仕様の外部バージョン。 データタイプ:文字列 テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド。 |
この例では、指定した値で製品仕様レコードを作成します。
curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
--user 'username':'password'
応答本文。
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'