サービスカタログオープン API

Zurich API リファレンス

Release

zurich

ft:locale

ja-JP

ft:publication_title

Zurich API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

サービスカタログオープン API

リリースバージョン: Zurich

更新日 2025年07月31日

所要時間：45分

サービスカタログオープン API は、サービス仕様を作成および取得するためのエンドポイントを提供します。

この API を使用して、外部システムと ServiceNow AI Platform の間でサービスカタログ情報を管理します。サービスカタログオープン API は、TM Forum サービスカタログ API REST 仕様のServiceNow®実装です。この実装は、TMF633 Service Catalog API REST Specification Version 4 (2020 年 10 月) に基づいています。

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

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

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

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

特性 [sn_prd_pm_characteristic]
特性オプション [sn_prd_pm_characteristic_option]
サービス仕様 [sn_prd_pm_service_specification]
仕様関係 [sn_prd_pm_specification_relationship]

サービスカタログオープン:GET /servicespecification

すべてのサービス仕様のリストを取得します。

URL 形式

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

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

表 : 1. パスパラメーター
名前	説明
なし

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

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

ヘッダー

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

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

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

ステータスコード

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

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

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


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

cURL 要求

この例では、すべてのサービス仕様を取得します。

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

応答本文。

[
   {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
      "description": "SD WAN Optimization Service",
      "lastUpdate": "2022-01-23 22:48:55",
      "validFor": {
         "startDateTime": "2022-01-12",
         "endDateTime": "2027-02-11"
      },
      "serviceSpecificationRelationship": [
         {
            "id": "a1f5fe981bb420106ba59acf034bcb4f",
            "name": "Deduplication and Compression",
            "version": "1",
            "type": "rfs",
            "validFor": {
               "startDateTime": "2021-02-11",
               "endDateTime": "2027-02-11"
            }
         }
      ],
      "resourceSpecification": [],
      "serviceSpecCharacteristic": [
         {
            "name": "SSL Optimization",
            "description": "SSL Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:47:57"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "False",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "True",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "CIFS Optimization",
            "description": "CIFS Optimization Protocol",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:49:09"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "SMB1",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "SMB2",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         }
      ]
   },
   {
      "id": "31c5caff07266010a7955b7e0ad3006b",
      "name": "Firewall Administration",
      "description": "Firewall Administration",
      "lastUpdate": "2022-01-23 11:46:48",
      "validFor": {
         "startDateTime": "2021-11-22",
         "endDateTime": ""
      },
      "serviceSpecificationRelationship": [],
      "resourceSpecification": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system",
            "version": "1"
         }
      ],
      "serviceSpecCharacteristic": [
         {
            "name": "Firewall Administration CPE Model",
            "description": "Firewall Administration CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:55:37"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "2100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "4100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "7300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "9300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE Type",
            "description": "Firewall Administration CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:53:45"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Configuration and Policy backup",
            "description": "Configuration and Policy backup",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:46:02"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Weekly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Monthly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Daily",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Remote CLI troubleshoot support",
            "description": "Remote CLI troubleshoot support",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:45:38"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Standard support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Basic support",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE ID",
            "description": "Firewall Administration CPE ID",
            "valueType": "single_line_text",
            "validFor": {
               "startDatetime": "2022-02-20 00:57:50"
            },
            "productSpecCharacteristicValue": []
         }
      ]
   }
]

サービスカタログオープン:GET /servicespecification/{specificationId}

サービス仕様を取得します。

URL 形式

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

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

表 : 7. パスパラメーター
名前	説明
specificationId	取得するサービス仕様の sys_id。データタイプ：文字列テーブル:サービス仕様 [sn_prd_pm_service_specification]

表 : 8. クエリパラメーター
名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。データタイプ：文字列
state	ステータス別にサービス仕様をフィルタリングします。ステータスがこのパラメーターの値に一致する仕様のみが応答で返されます。データタイプ：文字列

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

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

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

ステータスコード

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

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


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

cURL 要求

この例では、ファイアウォールサービスのサービス仕様を取得します。

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

応答本文。

{
   "id": "31c5caff07266010a7955b7e0ad3006b",
   "name": "Firewall Administration",
   "description": "Firewall Administration",
   "lastUpdate": "2022-01-23 11:46:48",
   "validFor": {
      "startDateTime": "2021-11-22",
      "endDateTime": ""
   },
   "serviceSpecificationRelationship": [],
   "resourceSpecification": [
      {
         "id": "3546463307666010a7955b7e0ad3005d",
         "name": "Cisco Firewall Management system",
         "version": "1"
      }
   ],
   "serviceSpecCharacteristic": [
      {
         "name": "Firewall Administration CPE Model",
         "description": "Firewall Administration CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:55:37"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "2100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "4100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "7300 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "9300 series",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE Type",
         "description": "Firewall Administration CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:53:45"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Configuration and Policy backup",
         "description": "Configuration and Policy backup",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:46:02"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Weekly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Monthly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Daily",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Remote CLI troubleshoot support",
         "description": "Remote CLI troubleshoot support",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:45:38"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Standard support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Basic support",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE ID",
         "description": "Firewall Administration CPE ID",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2022-02-20 00:57:50"
         },
         "productSpecCharacteristicValue": []
      }
   ]
}

サービスカタログを開く - POST /servicespecification

サービス仕様を作成します。

URL 形式

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

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

表 : 13. パスパラメーター
名前	説明
なし

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

表 : 15. 要求本文パラメーター (JSON)
名前	説明
description	必須です。仕様の説明。データタイプ：文字列
externalId	サービス仕様の外部 ID。 externalId と id の両方が指定されている場合は、同じ仕様を参照する必要があります。データタイプ：文字列デフォルト：空白の文字列テーブル:サービス仕様 [sn_prd_pm_service_specification]
ID	サービス仕様のinitial_versionまたはexternal_id。id が指定されていない場合、このエンドポイントは version=1 で新しい仕様を作成します。id が指定されている場合、このエンドポイントは当該仕様の新しいバージョンを作成します。 externalId と id の両方が指定されている場合は、同じ仕様を参照する必要があります。データタイプ：文字列デフォルト：空白の文字列
internalVersion	サービス仕様のバージョン。データタイプ：文字列デフォルト：空白の文字列テーブル:サービス仕様 [sn_prd_pm_service_specification]
lastUpdate	仕様が最後に更新された日付。データタイプ：文字列デフォルト：空白の文字列
name	必須です。仕様の名前。データタイプ：文字列
resourceSpecification	必須です。このサービス仕様のリソース仕様。データタイプ：オブジェクトのアレイ `"resourceSpecification": [ { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	必須。リソース仕様のinitial_versionまたはexternal_id。データタイプ：文字列
resourceSpecification.internalVersion	リソース仕様のexternal_version。データタイプ：文字列デフォルト：空白の文字列
resourceSpecification.name	リソース仕様の名前。データタイプ：文字列デフォルト：空白の文字列
resourceSpecification.version	リソース仕様のバージョン。データタイプ：文字列デフォルト：空白の文字列
serviceSpecificationRelationship	仕様と他のサービス仕様との関係の詳細。データタイプ：オブジェクトのアレイ `"serviceSpecificationRelationship": [ { "id": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	serviceSpecificationRelationship パラメーターを使用する場合は必須です。関連仕様の initial_version または external_id。データタイプ：文字列
serviceSpecificationRelationship.internalVersion	関連仕様のバージョン。データタイプ：文字列デフォルト：空白の文字列
serviceSpecificationRelationship.relationshipType	serviceSpecificationRelationship パラメーターを使用する場合は必須です。関係のタイプ。有効な値： bundles composed_of データタイプ：文字列
serviceSpecificationRelationship.validFor	関係が有効な日付範囲。データタイプ：オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
serviceSpecificationRelationship.validFor.endDateTime	関係の終了日。データタイプ：文字列デフォルト：空白の文字列
serviceSpecificationRelationship.validFor.startDateTime	関係の開始日。データタイプ：文字列デフォルト：空白の文字列
serviceSpecificationRelationship.version	関連仕様のexternal_version。データタイプ：文字列デフォルト：空白の文字列
specCharacteristic	仕様特性。データタイプ：オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	必須。特性の可能な値。データタイプ：オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	必須です。特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列デフォルト：空白の文字列
specCharacteristic.name	必須です。特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ：オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。データタイプ：文字列デフォルト：空白の文字列
specCharacteristic.validFor.startDateTime	特性の開始日。データタイプ：文字列デフォルト：空白の文字列
specCharacteristic.valueType	必須。特性の値タイプ (選択肢やメールなど)。データタイプ：文字列
validFor	必須です。仕様が有効な日付範囲。データタイプ：オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	仕様の終了日。データタイプ：文字列デフォルト：空白の文字列
validFor.startDateTime	仕様の開始日。データタイプ：文字列デフォルト：空白の文字列
バージョン	サービス仕様の外部バージョン。バージョンは、指定されたバージョンチェーンに対して一意である必要があります。データタイプ：文字列デフォルト：空白の文字列テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの external_version フィールド。
@type	必須です。仕様のタイプ。有効な値： CustomerFacingServiceSpecification ResourceFacingServiceSpecification データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


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

cURL 要求

この例では、ファイアウォールサービスのサービス仕様を作成します。

curl "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "7655",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}" \
--user 'username':'password'

応答本文。

{
   "id": "21a7ee64c32310105253716b8d40dd60",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}