---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

# サービスカタログオープン API {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：83分

サービスカタログオープン API は、サービス仕様を作成および取得するためのエンドポイントを提供します。
この API を使用して、外部システムと ServiceNow AI Platformの間のサービスカタログ情報を管理します。サービスカタログオープン API は、TM Forum サービスカタログ API REST 仕様のServiceNow®実装です。この実装は、2020 年 10 月の [TMF633 サービスカタログ API REST 仕様バージョン 4](https://www.tmforum.org/resources/standard/tmf633-service-catalog-api-user-guide-v4-0-0/) に基づいています。

この API は、 ServiceNow Store で入手可能な Product Catalog Advanced アプリケーションに含まれています。  
この API のエンドポイントは、製品カタログオープン API 名の下の `sn_tmf-api` 名前空間内で提供されます。

* サービスカテゴリの作成 (POST): [サービスカタログを開く:POST /api/sn_tmf_api/catalogmanagement/serviceCategory](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#servicecat-POST-servcateg "仕様カテゴリ [sn_prd_pm_specification_category] テーブルに新しいサービスカテゴリレコードを作成します。")
* サービス仕様の作成 (POST): [サービスカタログを開く:POST /servicespecification](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#tmf_service_cat-POST-servicespec "サービス仕様を作成します。")
* サービスカテゴリを削除 (DELETE): [サービスカタログを開く - DELETE /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#servicecat-DELETE-servcateg-id "仕様カテゴリ [sn_prd_pm_specification_category] テーブル内の指定されたサービスカテゴリレコードを削除します。")
* サービスカテゴリを取得 (GET): [サービスカタログを開く:GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#servicecat-GET-servcateg-id "仕様カテゴリ [sn_prd_pm_specification_category] テーブル内の特定のサービスカテゴリレコードを取得します。")
* サービス仕様を取得 (GET): [サービスカタログを開く:GET /servicespecification/{specificationId}](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#tmf_service_cat-GET-servicespec-id "サービス仕様を取得します。")
* サービス仕様をリスト (GET): [サービスカタログを開く:GET /servicespecification](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#tmf_service_cat-GET-servicespec "すべてのサービス仕様のリストを取得します。")
* サービスカテゴリの更新 (PATCH): [サービスカタログを開く:POST /api/sn_tmf_api/catalogmanagement/serviceCategory](https://servicenow-prod.fluidtopics.net/fokxcayP8po_XbF7rh9kuQ#servicecat-POST-servcateg "仕様カテゴリ [sn_prd_pm_specification_category] テーブルに新しいサービスカテゴリレコードを作成します。")

呼び出し元ユーザーには、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\]
{#service-catalog-open-api__ul_fhn_pjj_hsb}

## サービスカタログを開く - DELETE /api/sn_tmf_api/catalogmanagement/serviceCategory/{id} {#ariaid-title2}

仕様カテゴリ \[sn_prd_pm_specification_category\] テーブル内の指定されたサービスカテゴリレコードを削除します。

### URL 形式

デフォルト URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}

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

{#servicecat-DELETE-servcateg-id__entry__2}

| 名前 | 説明 |
|-|-|
| ID | 削除するサービスカテゴリのSys_id。 テーブル:サービスカテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
[表 : 1. パスパラメーター]

{#servicecat-DELETE-servcateg-id__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 2. クエリパラメーター]

{#servicecat-DELETE-servcateg-id__entry__10}

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

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-DELETE-servcateg-id__entry__14}

| ヘッダー | 説明 |
|-|-|
| 承認 | 要求本文のデータ形式。アプリケーション/json のみをサポートします。 |
[表 : 4. 要求ヘッダー]

{#servicecat-DELETE-servcateg-id__entry__18}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#servicecat-DELETE-servcateg-id__entry__22}

| ステータスコード | 説明 |
|-|-|
| 204 | コンテンツがありません。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
[表 : 6. ステータスコード]

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

{#servicecat-DELETE-servcateg-id__entry__28}

| 名前 | 説明 |
|-|-|
| なし |   |
[ ]

### cURL 要求

次の例では、ID a1b23456c7de8a90f0123456gh789ij のサービスカテゴリを削除します。メッセージング付きのステータスコードを返します。

    curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
      --request DELETE \
      --header "Accept:application/json" \
      --user 'user:password'

## サービスカタログを開く:GET /api/sn_tmf_api/catalogmanagement/serviceCategory {#ariaid-title3}

サービスカテゴリ \[sn_prd_pm_specification_category\] テーブル内のすべてのサービスカテゴリレコードのリストを取得します。

### URL 形式

デフォルト URL: /api/sn_tmf_api/catalogmanagement/serviceCategory

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

{#servicecat-GET-servicecateg__entry__2}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 7. パスパラメーター]

{#servicecat-GET-servicecateg__entry__6}

| 名前 | 説明 |
|-|-|
| フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： * href * ID * name {#servicecat-GET-servicecateg__ul_dmv_my4_zgc} データタイプ：文字列 デフォルト:すべてのフィールドを返します |
| ID | 特定のsys_idでサービスカテゴリをフィルタリングします。 テーブル:サービスカテゴリ \[service_category\] データタイプ：文字列 |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 デフォルト値：20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。この値を使用して、レコード取得をページネーションします。負の数値は使用しないでください。 データタイプ：数値 デフォルト：0 |
[表 : 8. クエリパラメーター]

{#servicecat-GET-servicecateg__entry__16}

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

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-GET-servicecateg__entry__20}

| ヘッダー | 説明 |
|-|-|
| 承認:application/json |   |
[表 : 10. 要求ヘッダー]

{#servicecat-GET-servicecateg__entry__24}

| ヘッダー | 説明 |
|-|-|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` および `limit=3` の場合、Content-Range ヘッダーの値はアイテム `3 から 5` です。 |
| Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 |
| 「リンク」 | クエリ結果内を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#servicecat-GET-servicecateg__ul_ut4_zcp_zgc} |
| X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 |
[表 : 11. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#servicecat-GET-servicecateg__entry__34}

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

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

{#servicecat-GET-servicecateg__entry__44}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ：オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 テーブル:サービスカテゴリ \[sn_prd_pm_specification_category\]、フィールドexternal_id |
| externalIdentifier.owner | 指定された外部 ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ：文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:サービスカテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-GET-servicecateg__ul_q13_jbp_zgc} データタイプ：ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ：オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ：文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補参照のリスト。 データタイプ：オブジェクトのアレイ "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ] |
| serviceCandidate.@referredType | 値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[ ]

### cURL 要求

次の例では、GET 操作を呼び出して、サービスカテゴリ \[sn_prd_pm_specification_category\] テーブル内のすべてのサービスカテゴリレコードのリストを返します。

    curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
      --request GET \
      --header "Accept:application/json" \
      --user 'user:password'
    ``

応答本文。

    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a2a68216d9ce2a90f87718429ae503dd",
      "name": "Cloud Services",
      "serviceCandidate": [
        {
          "id": "14fbd5ead902ea90f87718429ae503f7",
          "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/14fbd5ead902ea90f87718429ae503f7",
          "version": "1",
          "name": "servicenow",
          "@referredType": "ServiceCategory"
        }
      ],
      "modelCategory": [
        {
          "id": "a1d5bc14c3031000b959fd251eba8f5f",
          "name": "Business Service"
        }
      ],
      "externalIdentifier": [
        {
          "id": "1234234312",
          "owner": "TMF200000123233"
        }
      ],
      "isRoot": "true"
    }

## サービスカタログを開く:GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{id} {#ariaid-title4}

仕様カテゴリ \[sn_prd_pm_specification_category\] テーブル内の特定のサービスカテゴリレコードを取得します。

### URL 形式

デフォルト URL: /api/sn_tmf_api/catalogmanagement/serviceCategory

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

{#servicecat-GET-servcateg-id__entry__2}

| 名前 | 説明 |
|-|-|
| ID | 取得するサービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
[表 : 13. パスパラメーター]

{#servicecat-GET-servcateg-id__entry__6}

| 名前 | 説明 |
|-|-|
| フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： * href * ID * name {#servicecat-GET-servcateg-id__ul_dmv_my4_zgc} データタイプ：文字列 デフォルト:すべてのフィールドを返します |
| limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 デフォルト値：20 最大:100 |
| オフセット | レコードの取得を開始する開始インデックス。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。この値を使用して、レコード取得をページネーションします。負の数値は使用しないでください。 データタイプ：数値 デフォルト：0 |
[表 : 14. クエリパラメーター]

{#servicecat-GET-servcateg-id__entry__14}

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

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-GET-servcateg-id__table_qnw_bdp_zgc__entry__2}

| ヘッダー | 説明 |
|-|-|
| 承認:application/json |   |
[表 : 16. 要求ヘッダー]

{#servicecat-GET-servcateg-id__table_qnw_bdp_zgc} {#servicecat-GET-servcateg-id__table_oth_bdp_zgc__entry__2}

| ヘッダー | 説明 |
|-|-|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` および `limit=3` の場合、Content-Range ヘッダーの値はアイテム `3 から 5` です。 |
| Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 |
| 「リンク」 | クエリ結果内を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#servicecat-GET-servcateg-id__ul_ut4_zcp_zgc} |
| X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 |
[表 : 17. 応答ヘッダー]

{#servicecat-GET-servcateg-id__table_oth_bdp_zgc}

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#servicecat-GET-servcateg-id__table_xwz_ncp_zgc__entry__2}

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

{#servicecat-GET-servcateg-id__table_xwz_ncp_zgc}

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

{#servicecat-GET-servcateg-id__table_d3r_4cp_zgc__entry__2}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ:オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\]、フィールド:external_id |
| externalIdentifier.owner | この ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ:文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-GET-servcateg-id__ul_q13_jbp_zgc} データタイプ:ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ:オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ：文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補のリスト。 データタイプ：オブジェクトのアレイ "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ] |
| serviceCandidate.@referredType | サービス候補の参照タイプ。値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[ ]

{#servicecat-GET-servcateg-id__table_d3r_4cp_zgc}  

### cURL 要求

次の例では、GET 操作を呼び出して、指定された ID a2a68216d9ce2a90f87718429ae503dd に従って特定のサービスカテゴリレコードを返します。

    curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
      --request GET \
      --header "Accept:application/json" \
      --user 'user:password'

応答本文。

    {
      "id": "a2a68216d9ce2a90f87718429ae503dd",
      "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a1b23456c7de8a90f0123456gh789ij",
      "name": "Cloud Services",
      "serviceCandidate": [
        {
          "id": "a1b23456c7de8a90f0123456gh789ij",
          "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/a1b23456c7de8a90f0123456gh789ij",
          "version": "1",
          "name": "servicenow",
         
## サービスカタログを開く:GET /servicespecification {#ariaid-title5}

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

### URL 形式

デフォルト URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification

### サポートされている要求パラメーター {#tmf_service_cat-GET-servicespec__section_nfr_vgy_fsb}

{#tmf_service_cat-GET-servicespec__table_ofr_vgy_fsb__entry__2}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 19. パスパラメーター]

{#tmf_service_cat-GET-servicespec__table_ofr_vgy_fsb} {#tmf_service_cat-GET-servicespec__table_pfr_vgy_fsb__entry__2}

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

{#tmf_service_cat-GET-servicespec__table_pfr_vgy_fsb} {#tmf_service_cat-GET-servicespec__table_qfr_vgy_fsb__entry__2}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 21. 要求本文パラメーター (JSON)]

{#tmf_service_cat-GET-servicespec__table_qfr_vgy_fsb}

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#tmf_service_cat-GET-servicespec__table_kqy_wgy_fsb__entry__2}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 22. 要求ヘッダー]

{#tmf_service_cat-GET-servicespec__table_kqy_wgy_fsb} {#tmf_service_cat-GET-servicespec__table_c2r_4gm_lsb__entry__2}{#tmf_service_cat-GET-servicespec__content-range-row}{#tmf_service_cat-GET-servicespec__content-type-row}{#tmf_service_cat-GET-servicespec__links-pagination-row}{#tmf_service_cat-GET-servicespec__x-total-count-descr}

| ヘッダー | 説明 |
|-|-|
| Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。 たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。 |
| Content-Type | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| 「リンク」 | クエリ結果間を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#tmf_service_cat-GET-servicespec__ul_zzk_sdm_lsb} |
| X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 |
[表 : 23. 応答ヘッダー]

{#tmf_service_cat-GET-servicespec__table_c2r_4gm_lsb}

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#tmf_service_cat-GET-servicespec__table_qbg_4cm_lsb__entry__2}{#tmf_service_cat-GET-servicespec__tmf-get-status-200-p}{#tmf_service_cat-GET-servicespec__tmf-get-status-206-entry}{#tmf_service_cat-GET-servicespec__tmf-get-status-400-entry}{#tmf_service_cat-GET-servicespec__tmf-get-status-404-entry}

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

{#tmf_service_cat-GET-servicespec__table_qbg_4cm_lsb}

### 応答本文のパラメーター (JSON) {#tmf_service_cat-GET-servicespec__section_sqv_3t3_hsb}

{#tmf_service_cat-GET-servicespec__table_hnx_3gy_fsb__entry__2}

| 名前 | 説明 |
|-|-|
| @type | 仕様のタイプ。 データタイプ：文字列 |
| description | 仕様の説明。 データタイプ：文字列 |
| externalId | サービス仕様の外部 ID。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_id フィールド内。 |
| 外部システム | `TMF633` が追加されたサービス仕様の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF633` と入力します。 データタイプ:文字列 |
| 外部システム | サービスカタログとやり取りするサードパーティまたは非ネイティブプラットフォーム。値には常に `TMF633` が追加されます。たとえば、外部システムが `ABC` の場合、外部ソースの値は `ABC-TMF633` にする必要があります。 データタイプ：文字列 |
| 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\] テーブルのバージョンフィールド。 |
| 前回の更新 | 仕様が最後に更新された日付。 データタイプ：文字列 |
| name | 仕様の名前。 データタイプ：文字列 |
| リソース仕様 | このサービス仕様のリソース仕様。 データタイプ：オブジェクトのアレイ "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 | 特性の値タイプ (選択肢やメールなど)。単純な特性または複雑な特性にすることができます。 可能な値： * 日付、住所 * 整数、日付/時刻 * Array.Integer * Array.Single Line Test * 1 行テキスト * Array.Obect * Array.Date * Array.Decimal * はい/いいえ * オブジェクト * Array.Datetime * チェックボックス * メール * 選択肢 {#tmf_service_cat-GET-servicespec__ul_f2n_cyl_pgc} データタイプ：文字列 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" } |
| validFor.endDateTime | 仕様の終了日。 データタイプ：文字列 |
| validFor.startDateTime | 仕様の開始日。 データタイプ：文字列 |
| version | サービス仕様の外部バージョン。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_version フィールド。 |
[ ]

{#tmf_service_cat-GET-servicespec__table_hnx_3gy_fsb}  

### cURL 要求 {#tmf_service_cat-GET-servicespec__example_cmv_y2j_hsb}

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

    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",
           "externalSystem": "Salesforce - TMF633",
          "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": ""
                      }
                   }
                ]
             }
          ]
          "externalSource": "ABC-TMF633"
       },
       {
          "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": ""
                      }
                   }
                ]
        "externalSource": "ABC-TMF633"
             },
             {
                "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} {#ariaid-title6}

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

### URL 形式

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

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

{#tmf_service_cat-GET-servicespec-id__entry__2}

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

{#tmf_service_cat-GET-servicespec-id__table_pfr_vgy_fsb__entry__2}

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

{#tmf_service_cat-GET-servicespec-id__table_pfr_vgy_fsb} {#tmf_service_cat-GET-servicespec-id__entry__12}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 27. 要求本文パラメーター (JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#tmf_service_cat-GET-servicespec-id__table_kqy_wgy_fsb__entry__2}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 28. 要求ヘッダー]

{#tmf_service_cat-GET-servicespec-id__table_kqy_wgy_fsb} {#tmf_service_cat-GET-servicespec-id__table_sc4_cgy_ksb__entry__2}

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

{#tmf_service_cat-GET-servicespec-id__table_sc4_cgy_ksb}

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#tmf_service_cat-GET-servicespec-id__entry__24}

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

### 応答本文のパラメーター (JSON) {#tmf_service_cat-GET-servicespec-id__section_wgn_gt3_hsb}

{#tmf_service_cat-GET-servicespec-id__table_hnx_3gy_fsb__entry__2}

| 名前 | 説明 |
|-|-|
| @type | 仕様のタイプ。 データタイプ：文字列 |
| description | 仕様の説明。 データタイプ：文字列 |
| externalId | サービス仕様の外部 ID。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_id フィールド内。 |
| 外部システム | `TMF633` が追加されたサービス仕様の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF633` と入力します。 データタイプ:文字列 |
| 外部システム | サービスカタログとやり取りするサードパーティまたは非ネイティブプラットフォーム。値には常に `TMF633` が追加されます。たとえば、外部システムが `ABC` の場合、外部ソースの値は `ABC-TMF633` にする必要があります。 データタイプ：文字列 |
| 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\] テーブルのバージョンフィールド。 |
| 前回の更新 | 仕様が最後に更新された日付。 データタイプ：文字列 |
| name | 仕様の名前。 データタイプ：文字列 |
| リソース仕様 | このサービス仕様のリソース仕様。 データタイプ：オブジェクトのアレイ "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 | 特性の値タイプ (選択肢やメールなど)。単純な特性または複雑な特性にすることができます。 可能な値： * 日付、住所 * 整数、日付/時刻 * Array.Integer * Array.Single Line Test * 1 行テキスト * Array.Obect * Array.Date * Array.Decimal * はい/いいえ * オブジェクト * Array.Datetime * チェックボックス * メール * 選択肢 {#tmf_service_cat-GET-servicespec-id__ul_f2n_cyl_pgc} データタイプ：文字列 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" } |
| validFor.endDateTime | 仕様の終了日。 データタイプ：文字列 |
| validFor.startDateTime | 仕様の開始日。 データタイプ：文字列 |
| version | サービス仕様の外部バージョン。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_version フィールド。 |
[ ]

{#tmf_service_cat-GET-servicespec-id__table_hnx_3gy_fsb}  

### 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",
       "externalSystem": "Salesforce - TMF633",
       "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": []
          }
       ],
       "externalSource": "ABC-TMF633"
    }

## サービスカテゴリオープン:PATCH /api/sn_tmf_api/catalogmanagement/serviceCategory/{id} {#ariaid-title7}

仕様カテゴリ \[sn_prd_pm_specification_category\] テーブルの指定されたレコードを更新します。

### URL 形式

デフォルト URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/ {id}

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

{#servicecat-PATCH-servcateg-id__entry__2}

| 名前 | 説明 |
|-|-|
| ID | サービスカテゴリテーブルのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
[表 : 31. パスパラメーター]

{#servicecat-PATCH-servcateg-id__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 32. クエリパラメーター]

{#servicecat-PATCH-servcateg-id__entry__10}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ：オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\]、フィールド:external_id データタイプ：文字列 |
| externalIdentifier.owner | この ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ：文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-PATCH-servcateg-id__ul_q13_jbp_zgc} データタイプ：ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ：オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ：文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補のリスト。 データタイプ:オブジェクトのアレイ "serviceCandidate": [ { "@referredType": "String", "href": "String", "id": "String", "name": "String", "version": "String" } ] |
| serviceCandidate.@referredType | 値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[表 : 33. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-PATCH-servcateg-id__entry__42}{#servicecat-PATCH-servcateg-id__accept-RESTAPI}

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

{#servicecat-PATCH-servcateg-id__entry__46}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 35. 応答ヘッダー]

### ヘッダー {#servicecat-PATCH-servcateg-id__section_evd_1kp_zgc}

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-PATCH-servcateg-id__table_fvd_1kp_zgc__entry__2}

| ヘッダー | 説明 |
|-|-|
| 承認 | 要求本文のデータ形式。アプリケーション/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。アプリケーション/json のみをサポートします。 |
[表 : 36. 要求ヘッダー]

{#servicecat-PATCH-servcateg-id__table_fvd_1kp_zgc} {#servicecat-PATCH-servcateg-id__table_gvd_1kp_zgc__entry__2}

| ヘッダー | 説明 |
|-|-|
| Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 |
[表 : 37. 応答ヘッダー]

{#servicecat-PATCH-servcateg-id__table_gvd_1kp_zgc}

### ステータスコード {#servicecat-PATCH-servcateg-id__section_kpd_1kp_zgc}

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#servicecat-PATCH-servcateg-id__table_lpd_1kp_zgc__entry__2}

| ステータスコード | 説明 |
|-|-|
| 201 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 次の 1 つ以上の理由で、不正な要求タイプまたは形式が正しくない要求が検出されました: * 空のペイロード。 * 無効なペイロードです。 * 必須フィールドがありません。 {#servicecat-PATCH-servcateg-id__ul_udx_43p_zgc} |
[表 : 38. ステータスコード]

{#servicecat-PATCH-servcateg-id__table_lpd_1kp_zgc}

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

{#servicecat-PATCH-servcateg-id__table_d3r_4cp_zgc__entry__2}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ:オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\]、フィールド:external_id |
| externalIdentifier.owner | この ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ:文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-PATCH-servcateg-id__ul_xhk_xjp_zgc} データタイプ:ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ:オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ:文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補のリスト。 データタイプ:オブジェクトのアレイ "serviceCandidate": [ { "@referredType": "String", "href": "String", "id": "String", "name": "String", "version": "String" } ] |
| serviceCandidate.@referredType | 値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[ ]

{#servicecat-PATCH-servcateg-id__table_d3r_4cp_zgc}  

### cURL 要求

次の例では、サービスカテゴリの名前、バージョン、サービス候補、モデルカテゴリ、および外部識別子情報を更新します。

    curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
      --request PATCH \
      --header "Accept:application/json" \
      --header "Content-Type:application/json" \
      --data '{
        "name": "Cloud Services",
        "version": "1.0",
        "serviceCandidate": [
          {
            "id": "a1b23456c7de8a90f0123456gh789ij",
            "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
            "version": "3.2",
            "name": "Cloud Services",
            "@referredType": "ServiceCategory"
          }
        ],
        "modelCategory": [
          {
            "id": "b2d5bc14c3031000b959fd251eba8f96",
            "name": "model"
          }
        ],
        "externalIdentifier": {
          "id": "1234234312",
          "owner": "TMF200000123233"
        },
        "isRoot": true
      }' \
      --user 'user:password

応答本文。

    {
      "name": "Cloud Services",
      "version": "1.0",
      "serviceCandidate": [
        {
          "id": "a1b23456c7de8a90f0123456gh789ij",
          "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
          "version": "3.2",
          "name": "Cloud Services",
          "@referredType": "ServiceCategory"
        }
      ],
      "modelCategory": [
        {
          "id": "b2d5bc14c3031000b959fd251eba8f96",
          "name": "model"
        }
      ],
      "externalIdentifier": {
        "id": "1234234312",
        "owner": "TMF200000123233"
      },
      "isRoot": true,
      "id": "8138241b1caaaa10f87703c075c809fe",
      "href": "api/sn_tmf_api/catalogmanagement/serviceCategory/8138241b1caaaa10f87703c075c809fe"
    }

## サービスカタログを開く:POST /api/sn_tmf_api/catalogmanagement/serviceCategory {#ariaid-title8}

仕様カテゴリ \[sn_prd_pm_specification_category\] テーブルに新しいサービスカテゴリレコードを作成します。

### URL 形式

デフォルト URL: /api/sn_tmf_api/catalogmanagement/serviceCategory

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

{#servicecat-POST-servcateg__entry__2}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 39. パスパラメーター]

{#servicecat-POST-servcateg__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 40. クエリパラメーター]

{#servicecat-POST-servcateg__entry__10}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ：オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\]、フィールド:external_id データタイプ：文字列 |
| externalIdentifier.owner | この ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ：文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-POST-servcateg__ul_q13_jbp_zgc} データタイプ：ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ：オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ：文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補のリスト。 データタイプ:オブジェクトのアレイ "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ] |
| serviceCandidate.@referredType | 値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[表 : 41. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#servicecat-POST-servcateg__entry__42}

| ヘッダー | 説明 |
|-|-|
| 承認 | 要求本文のデータ形式。アプリケーション/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。アプリケーション/json のみをサポートします。 |
[表 : 42. 要求ヘッダー]

{#servicecat-POST-servcateg__entry__48}

| ヘッダー | 説明 |
|-|-|
| Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 |
[表 : 43. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#servicecat-POST-servcateg__entry__52}

| ステータスコード | 説明 |
|-|-|
| 201 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。 次の 1 つ以上の理由で、不正な要求タイプまたは形式が正しくない要求が検出されました: * 空のペイロード。 * 無効なペイロードです。 * 必須フィールドがありません。 {#servicecat-POST-servcateg__ul_udx_43p_zgc} |
[表 : 44. ステータスコード]

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

{#servicecat-POST-servcateg__table_d3r_4cp_zgc__entry__2}

| 名前 | 説明 |
|-|-|
| externalIdentifier | カテゴリの管理に関与する外部システムの識別情報。 データタイプ:オブジェクトのアレイ "externalIdentifier": [ { "id": "String", "owner": "String" } ] |
| externalIdentifier.id | サービスカテゴリの一意の識別子。この値は外部システムによって決定されます。 データタイプ：文字列 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\]、フィールド:external_id |
| externalIdentifier.owner | この ID を所有するシステム。 データタイプ：文字列 |
| href | サービスカテゴリにアクセスするためのハイパーリンク。 データタイプ:文字列 |
| ID | サービスカテゴリのSys_id。 テーブル:仕様カテゴリ \[sn_prd_pm_specification_category\] データタイプ：文字列 |
| isRoot | カテゴリがカテゴリのルートであるかどうかを示すフラグ。 有効な値： * true:カテゴリはカテゴリのルートです。 * false:カテゴリはカテゴリのルートではありません。 {#servicecat-POST-servcateg__ul_b2c_v1q_zgc} データタイプ:ブーリアン |
| モデルカテゴリ | サービスカテゴリに関連付けられたモデルカテゴリのリスト。 データタイプ:オブジェクトのアレイ "modelCategory": [ { "id": "String", "name": "String" } ] |
| modelCategory.id | モデルカテゴリのSys_id。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| modelCategory.name | モデルカテゴリの名前。 テーブル:モデルカテゴリ \[cmdb_model_category\] データタイプ：文字列 |
| name | サービスカテゴリの名前。 データタイプ:文字列 |
| サービス候補 | このカテゴリに関連付けられたサービス候補のリスト。 データタイプ:オブジェクトのアレイ "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ] |
| serviceCandidate.@referredType | 値は常に `ServiceCategory` です。 データタイプ：文字列 |
| serviceCandidate.href | サービス仕様にアクセスするためのハイパーリンク。 データタイプ：文字列 |
| serviceCandidate.id | サービス仕様のSys_id。 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] データタイプ：文字列 |
| serviceCandidate.version | サービス候補のバージョン。 データタイプ：文字列 |
[ ]

{#servicecat-POST-servcateg__table_d3r_4cp_zgc}  

### cURL 要求

次の例では、POST を呼び出して、要求本文に指定された詳細に従って新しいサービスカテゴリレコードを作成します。

    curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
      --request POST \
      --header "Accept:application/json" \
      --header "Content-Type:application/json" \
      --user 'user:password' \
      --data '{
        "name": "Cloud Services",
        "version": "1.0",
        "serviceCandidate": [
          {
            "id": "a1b23456c7de8a90f0123456gh789ij",
            "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
            "version": "3.2",
            "name": "Cloud Services",
            "@referredType": "ServiceCategory"
          }
        ],
        "modelCategory": [
          {
            "id": "b2d5bc14c3031000b959fd251eba8f96",
            "name": "model"
          }
        ],
        "externalIdentifier": {
          "id": "1234234312",
          "owner": "TMF200000123233"
        },
        "isRoot": true
      }'

応答本文。

    {
      "name": "Cloud Services",
      "version": "1.0",
      "serviceCandidate": [
        {
          "id": "a1b23456c7de8a90f0123456gh789ij",
          "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
          "version": "3.2",
          "name": "Cloud Services",
          "@referredType": "ServiceCategory"
        }
      ],
      "modelCategory": [
        {
          "id": "b2d5bc14c3031000b959fd251eba8f96",
          "name": "model"
        }
      ],
      "externalIdentifier": {
        "id": "1234234312",
        "owner": "TMF200000123233"
      },
      "isRoot": true,
      "id": "8138241b1caaaa10f87703c075c809fe",
      "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/8138241b1caaaa10f87703c075c809fe"
    }

## サービスカタログを開く:POST /servicespecification {#ariaid-title9}

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

### URL 形式

デフォルト URL: /api/sn_prd_pm_adv/catalogmanagement/servicespecification

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

{#tmf_service_cat-POST-servicespec__entry__2}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 45. パスパラメーター]

{#tmf_service_cat-POST-servicespec__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 46. クエリパラメーター]

{#tmf_service_cat-POST-servicespec__entry__10}

| 名前 | 説明 |
|-|-|
| description | 必須です。仕様の説明。 データタイプ：文字列 |
| externalId | サービス仕様の外部 ID。 externalIdとidの両方が指定されている場合は、同じ仕様を参照する必要があります。 データタイプ：文字列 デフォルト：空白の文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] |
| 外部システム | サービスカタログとやり取りするサードパーティまたは非ネイティブプラットフォーム。値には常に `TMF633` が追加されます。 たとえば、外部システムが `ABC` の場合、外部ソースの値は `ABC-TMF633` にする必要があります。 データタイプ：文字列 |
| ID | サービス仕様のinitial_versionまたはexternal_id。idが指定されていない場合、このエンドポイントはバージョン = 1 で新しい仕様を作成します。idが指定されている場合、このエンドポイントは指定された仕様の新しいバージョンを作成します。 externalIdとidの両方が指定されている場合は、同じ仕様を参照する必要があります。 データタイプ：文字列 デフォルト：空白の文字列 |
| internalVersion | サービス仕様のバージョン。 データタイプ：文字列 デフォルト：空白の文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] |
| 前回の更新 | 仕様が最後に更新された日付。 データタイプ：文字列 デフォルト：空白の文字列 |
| name | 必須です。仕様の名前。 データタイプ：文字列 |
| リソース仕様 | 必須です。このサービス仕様のリソース仕様。 データタイプ：オブジェクトのアレイ "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 パラメーターを使用する場合は必須です。関係のタイプ。 有効な値： * バンドル * composed_of {#tmf_service_cat-POST-servicespec__ul_kjr_xnx_fsb} データタイプ：文字列 |
| 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 | 特性の値タイプ (選択肢やメールなど)。単純な特性または複雑な特性にすることができます。 可能な値： * 日付、住所 * 整数、日付/時刻 * Array.Integer * Array.Single Line Test * 1 行テキスト * Array.Obect * Array.Date * Array.Decimal * はい/いいえ * オブジェクト * Array.Datetime * チェックボックス * メール * 選択肢 {#tmf_service_cat-POST-servicespec__ul_f2n_cyl_pgc} データタイプ：文字列 |
| validFor | 必須です。仕様が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" } |
| validFor.endDateTime | 仕様の終了日。 データタイプ：文字列 デフォルト：空白の文字列 |
| validFor.startDateTime | 仕様の開始日。 データタイプ：文字列 デフォルト：空白の文字列 |
| version | サービス仕様の外部バージョン。 バージョンは、指定されたバージョンチェーンに対して一意である必要があります。 データタイプ：文字列 デフォルト：空白の文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_version フィールド。 |
| @type | 必須です。仕様のタイプ。 有効な値： * CustomerFacingService仕様 * ResourceFacingServiceSpecification {#tmf_service_cat-POST-servicespec__ul_lys_rmp_fsb} データタイプ：文字列 |
[表 : 47. 要求本文パラメーター (JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#tmf_service_cat-POST-servicespec__entry__80}{#tmf_service_cat-POST-servicespec__accept-JSON-only-entry-RESTAPI}{#tmf_service_cat-POST-servicespec__content_type-JSON-only-entry-RESTAPI}

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

{#tmf_service_cat-POST-servicespec__table_sc4_cgy_ksb__entry__2}

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

{#tmf_service_cat-POST-servicespec__table_sc4_cgy_ksb}

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#tmf_service_cat-POST-servicespec__entry__90}

| ステータスコード | 説明 |
|-|-|
| 201 | 要求が正常に処理されました。 |
| 400 | 要求が正しくありません。以下のいずれかの理由が考えられます。 * 空のペイロード。 * 無効なペイロードです。必須フィールドがありません：\<フィールド名\> {#tmf_service_cat-POST-servicespec__ul_nc5_myx_fsb} |
[表 : 50. ステータスコード]

### 応答本文のパラメーター (JSON) {#tmf_service_cat-POST-servicespec__section_wwt_jt3_hsb}

{#tmf_service_cat-POST-servicespec__table_hnx_3gy_fsb__entry__2}

| 名前 | 説明 |
|-|-|
| @type | 仕様のタイプ。 データタイプ：文字列 |
| description | 仕様の説明。 データタイプ：文字列 |
| externalId | サービス仕様の外部 ID。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_id フィールド内。 |
| 外部システム | `TMF633` が追加されたサービス仕様の外部システム。 たとえば、外部システムが ABC の場合、 externalSystem に `ABC-TMF633` と入力します。 データタイプ:文字列 |
| 外部システム | サービスカタログとやり取りするサードパーティまたは非ネイティブプラットフォーム。値には常に `TMF633` が追加されます。たとえば、外部システムが `ABC` の場合、外部ソースの値は `ABC-TMF633` にする必要があります。 データタイプ：文字列 |
| 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\] テーブルのバージョンフィールド。 |
| 前回の更新 | 仕様が最後に更新された日付。 データタイプ：文字列 |
| name | 仕様の名前。 データタイプ：文字列 |
| リソース仕様 | このサービス仕様のリソース仕様。 データタイプ：オブジェクトのアレイ "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 | 特性の値タイプ (選択肢やメールなど)。単純な特性または複雑な特性にすることができます。 可能な値： * 日付、住所 * 整数、日付/時刻 * Array.Integer * Array.Single Line Test * 1 行テキスト * Array.Obect * Array.Date * Array.Decimal * はい/いいえ * オブジェクト * Array.Datetime * チェックボックス * メール * 選択肢 {#tmf_service_cat-POST-servicespec__d3120e723} データタイプ：文字列 |
| validFor | 仕様が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "endDateTime": "String", "startDateTime": "String" } |
| validFor.endDateTime | 仕様の終了日。 データタイプ：文字列 |
| validFor.startDateTime | 仕様の開始日。 データタイプ：文字列 |
| version | サービス仕様の外部バージョン。 データタイプ：文字列 テーブル:サービス仕様 \[sn_prd_pm_service_specification\] テーブルの external_version フィールド。 |
[ ]

{#tmf_service_cat-POST-servicespec__table_hnx_3gy_fsb}  

### 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\",
       \"externalSource\": \"ABC-TMF633\",
       \"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",
       "externalSource": "ABC-TMF633",
       "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"
    }