製品インベントリオープン API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：74分

    • Product Inventory Open API は、製品インベントリを作成および取得するためのエンドポイントを提供します。

    この API を使用して、外部システムと Now Platform間の製品インベントリ情報を管理します。

    この API は、 ServiceNow Store で利用可能で、 sn_prd_invt 名前空間で実行される Product Inventory Advanced アプリケーションに含まれています。

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

    この API は、次のテーブルのデータを作成および更新します。
    • 製品特性 [sn_prd_invt_product_characteristics]
    • 製品インベントリ [sn_prd_invt_product_inventory]
    • 製品モデル [cmdb_model]
    • 製品モデル特性 [sn_prd_pm_product_model_characteristic]

    Product Inventory Open API は、TM Forum Product Inventory Management API REST 仕様のServiceNow®実装です。この実装は、 TMF637 Product Inventory Management API REST 仕様リリース 19 (2019 年 8 月) に基づいています。Product Inventory Open API は、TM フォーラムによって適合性認定を受けています。

    TMF 準拠ロゴ

    製品インベントリオープン API - GET /sn_prd_invt/product

    すべての製品インベントリレコードとそれに関連する子製品インベントリを取得します。

    URL 形式

    デフォルト URL: api/sn_prd_invt/product

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

    表 : 1. パスパラメーター
    名前 説明
    なし
    表 : 2. クエリパラメーター
    名前 説明
    顧客 顧客別に製品在庫をフィルタリングします。このパラメーターの値と一致する顧客sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:顧客別にフィルタリングしません。
    フィールド 応答で返すフィールドのリスト。無効なフィールドは無視されます。

    データタイプ：文字列

    デフォルト:すべてのフィールドを返します。
    補償限度額 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト値：20

    最大:100
    オフセット レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。

    データタイプ：数値

    デフォルト：0
    ロケーション 場所別に製品在庫をフィルタリングします。このパラメーターの値と一致する場所sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:場所でフィルタリングしません。
    ステータス ステータス別に製品在庫をフィルタリングします。このパラメーターの値と一致するステータスの製品在庫のみが応答に返されます。

    データタイプ：文字列

    デフォルト:ステータスでフィルタリングしません。
    表 : 3. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    なし
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    Content-Range ページネーションされた呼び出しで返されるコンテンツの範囲。

    たとえば、 offset=2 で limit=3 の場合、 Content-Range ヘッダーの値は アイテム 3 から 5 です。
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。
    リンク クエリ結果間を移動するための次のリンクが含まれています。
    • 第 1
    • 最終
    • 次へ
    • 前へ
    X-合計-数 ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

    ステータスコード

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

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

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

    名前 説明
    href 製品インベントリレコードへの相対リンク。

    データタイプ：文字列
    ID 製品インベントリのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    ロケーション 製品の場所。

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

    "place": {
  "id": "String",
  "name": "String"
}
    place.id 製品に関連付けられた場所レコードのSys_id。

    データタイプ：文字列

    テーブル：場所 (cmn_location)
    place.name 場所の名前。

    データタイプ：文字列
    製品特性 製品特性のリスト。

    製品特性の詳細については、「 」を参照してください。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id 製品オファリングの初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] または [external_id] フィールド内。
    productOffering.internalId 製品オファリングの初期バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] の [internal_version] フィールド内
    productOffering.internalVersion 製品オファリングのバージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド内。
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.version 製品オファリングの外部バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_version フィールド内。
    製品価格 空のアレイを返します。

    データタイプ：アレイ
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    可能な値:child

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id 製品仕様の初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの [initial_version] または [external_id] フィールド内。
    productSpecification.internalId 製品仕様の初期バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド内。
    productSpecification.internalVersion 製品仕様のバージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールドにあります。
    productSpecification.version 製品仕様の外部バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド内。
    リソースの実現 製品を実現するリソース。実現リソースは、この製品インベントリの子製品インベントリです。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    有効な値:child

    データタイプ：文字列
    実現サービス 製品を実現するサービス。実現サービスは、この製品インベントリの子製品インベントリです。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    有効な値:child

    データタイプ：文字列
    関連パーティー 製品インベントリレコードに関連付けられたアカウントまたは顧客連絡先のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • 利用者
    • カスタマー
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

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

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

    応答本文。

    [
   {
      "id": "037fd87ec3603010abc8b5183c40ddf2",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Example Company",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Routing and Configuration PI0000318",
      "productSpecification": {
         "id": "aec57e981bb420106ba59acf034bcb08",
         "name": "Routing and Configuration",
         "version": "",
         "internalVersion": "1",
         "internalId": "aec57e981bb420106ba59acf034bcb08"
      },
      "status": "Active",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering",
         "version": "",
         "internalVersion": "1",
         "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "product": "ce0b52c7532520103b6bddeeff7b12f5",
      "place": {
         "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
         "name": "100 South Charles Street, Baltimore,MD"
      },
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "9b2fa60b536520103b6bddeeff7b1233",
            "name": "Route Target"
         }
      ],
      "productPrice": [],
      "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
      "billingAccount": "Not Specified."
   }
]

    製品インベントリオープン API - GET /sn_prd_invt/product/{id}

    指定された製品インベントリレコードと、関連付けられた子製品インベントリレコードのsys_idsを取得します。

    URL 形式

    デフォルト URL: /api/sn_prd_invt/product/{id}

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

    表 : 7. パスパラメーター
    名前 説明
    ID 取得するプロダクトインベントリレコードのSys_idまたはexteranl_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    表 : 8. クエリパラメーター
    名前 説明
    顧客 顧客別に製品在庫をフィルタリングします。このパラメーターの値と一致する顧客sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:顧客に申告しません。
    フィールド 応答で返すフィールドのリスト。無効なフィールドは無視されます。

    データタイプ：文字列

    デフォルト:すべてのフィールドが返されます。
    ロケーション 場所別に製品在庫をフィルタリングします。このパラメーターの値と一致する場所sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:場所でフィルタリングしません。
    ステータス ステータス別に製品在庫をフィルタリングします。このパラメーターの値と一致するステータスの製品在庫のみが応答に返されます。

    データタイプ：文字列

    デフォルト:ステータスでフィルタリングしません。
    表 : 9. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    なし
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。

    ステータスコード

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

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

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

    名前 説明
    href 製品インベントリレコードへの相対リンク。

    データタイプ：文字列
    ID 製品インベントリレコードのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    ロケーション 製品の場所。

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

    "place": {
  "id": "String",
  "name": "String"
}
    place.id 製品に関連付けられた場所レコードのSys_id。

    データタイプ：文字列

    テーブル：場所 (cmn_location)
    place.name 場所の名前。

    データタイプ：文字列
    製品特性 製品特性のリスト。

    製品特性の詳細については、「 」を参照してください。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id 製品オファリングの初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] または [external_id] フィールド内。
    productOffering.internalId 製品オファリングの初期バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] の [internal_version] フィールド内
    productOffering.internalVersion 製品オファリングのバージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド内。
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.version 製品オファリングの外部バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_version フィールド内。
    製品価格 空のアレイを返します。

    データタイプ：アレイ
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    可能な値:child

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id 製品仕様の初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの [initial_version] または [external_id] フィールド内。
    productSpecification.internalId 製品仕様の初期バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド内。
    productSpecification.internalVersion 製品仕様のバージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールドにあります。
    productSpecification.version 製品仕様の外部バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド内。
    リソースの実現 製品を実現するリソース。実現リソースは、この製品インベントリの子製品インベントリです。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    有効な値:child

    データタイプ：文字列
    実現サービス 製品を実現するサービス。実現サービスは、この製品インベントリの子製品インベントリです。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    有効な値:child

    データタイプ：文字列
    関連パーティー 製品インベントリレコードに関連付けられたアカウントまたは顧客連絡先のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id 製品インベントリレコードに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • 利用者
    • カスタマー
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

    この例では、指定された製品インベントリを取得します。

    curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'

    出力：

    {
   "id": "037fd87ec3603010abc8b5183c40ddf2",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Example Company",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "Routing and Configuration PI0000318",
   "productSpecification": {
      "id": "aec57e981bb420106ba59acf034bcb08",
      "name": "Routing and Configuration",
      "version": "",
      "internalVersion": "1",
      "internalId": "aec57e981bb420106ba59acf034bcb08"
   },
   "status": "Active",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "version": "",
      "internalVersion": "1",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "product": "ce0b52c7532520103b6bddeeff7b12f5",
   "place": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD"
   },
   "productCharacteristic": [],
   "productRelationship": [
     {
       "productId": "2702912bffff5610a82effffffffff88",
       "relationshipType": "child"
     },
     {
       "productId": "e2a11de7ffff5610a82effffffffff96",
       "relationshipType": "child"
     }
   ],
   "realizingService": [],
   "realizingResource": [
      {
         "id": "9b2fa60b536520103b6bddeeff7b1233",
         "name": "Route Target"
      }
   ],
   "productPrice": [],
   "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
   "billingAccount": "Not Specified."
}

    製品インベントリオープン API - GET /sn_prd_invt/productinventory

    すべての製品在庫のリストを取得します。

    重要:
    Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは 製品インベントリオープン API - GET /sn_prd_invt/product です。

    URL 形式

    デフォルト URL: api/sn_prd_invt/productinventory

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

    表 : 13. パスパラメーター
    名前 説明
    なし
    表 : 14. クエリパラメーター
    名前 説明
    顧客 顧客別に製品在庫をフィルタリングします。このパラメーターの値と一致する顧客sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:顧客別にフィルタリングしません。
    フィールド 応答で返すフィールドのリスト。無効なフィールドは無視されます。

    データタイプ：文字列

    デフォルト:すべてのフィールドが返されます。
    補償限度額 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。

    データタイプ：数値

    デフォルト値：20

    最大:100
    オフセット レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。

    データタイプ：数値

    デフォルト：0
    ロケーション 場所別に製品在庫をフィルタリングします。このパラメーターの値と一致する場所sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列

    デフォルト:場所でフィルタリングしません。
    ステータス ステータス別に製品在庫をフィルタリングします。このパラメーターの値と一致するステータスの製品在庫のみが応答に返されます。

    データタイプ：文字列

    デフォルト:インベントリステータスではフィルタリングしません。
    表 : 15. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    なし
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    Content-Range ページネーションされた呼び出しで返されるコンテンツの範囲。

    たとえば、 offset=2 で limit=3 の場合、 Content-Range ヘッダーの値は アイテム 3 から 5 です。
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。
    リンク クエリ結果間を移動するための次のリンクが含まれています。
    • 第 1
    • 最終
    • 次へ
    • 前へ
    X-合計-数 ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

    ステータスコード

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

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

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

    名前 説明
    ID 製品インベントリのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    ロケーション 製品に関連付けられた場所。

    データタイプ：文字列
    製品特性 製品特性のリスト。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
  "id": "String",
  "name": "String"
}
    productOffering.id 製品オファリングのSys_id。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String"
}
    productSpecification.id 製品仕様のSys_id。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification]
    リソースの実現 リソースの実現。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    データタイプ：文字列
    実現サービス サービスを実現する。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    データタイプ：文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • consumer
    • 顧客
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

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

    curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'

    応答本文。

    [
   {
      "id": "075072aec3a83010abc8b5183c40dd44",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Firewall Administration PI0000300",
      "productSpecification": {
         "id": "31c5caff07266010a7955b7e0ad3006b",
         "name": "Firewall Administration"
      },
      "status": "Active",
      "productOffering": {
         "id": "",
         "name": ""
      },
      "place": {
         "id": "920cf6ac73d423002728660c4cf6a799",
         "name": "200 South James street,Atlanta, GA"
      },
      "productCharacteristic": [
         {
            "name": "Firewall Administration CPE Type",
            "valueType": "Choice",
            "value": "Physical"
         },
         {
            "name": "Configuration and Policy backup",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE ID",
            "valueType": "Single Line Text",
            "value": "CPE123456789"
         },
         {
            "name": "Remote CLI troubleshoot support",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE Model",
            "valueType": "Choice",
            "value": "9300 series"
         }
      ],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system"
         }
      ]
   },
   {
      "id": "0303a8ea74418510f877ca57242ff96d",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "SD-WAN Edge Device PI0001114",
      "productSpecification": {
         "id": "39b627aa53702010cd6dddeeff7b1202",
         "name": "SD-WAN Edge Device"
      },
      "status": "Installation Pending",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering"
      },
      "place": "",
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         }
      ],
      "realizingResource": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router"
         }
      ]
   }
]

    製品インベントリオープン API - GET /sn_prd_invt/productinventory/{inventoryId}

    製品インベントリを取得します。

    重要:
    Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは 製品インベントリオープン API - GET /sn_prd_invt/product/{id} です。

    URL 形式

    デフォルト URL: /api/sn_prd_invt/productinventory/{inventoryId}

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

    表 : 19. パスパラメーター
    名前 説明
    インベントリ ID 取得する製品インベントリのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    表 : 20. クエリパラメーター
    名前 説明
    顧客 顧客別に製品在庫をフィルタリングします。このパラメーターの値と一致する顧客sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列
    フィールド 応答で返すフィールドのリスト。無効なフィールドは無視されます。

    データタイプ：文字列

    デフォルト:すべてのフィールドが返されます。
    ロケーション 場所別に製品在庫をフィルタリングします。このパラメーターの値と一致する場所sys_idまたは外部 ID を持つ製品オファリングのみが応答に返されます。

    データタイプ：文字列
    ステータス ステータス別に製品在庫をフィルタリングします。このパラメーターの値と一致するステータスの製品在庫のみが応答に返されます。

    データタイプ：文字列
    表 : 21. 要求本文パラメーター (JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    なし
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。

    ステータスコード

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

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

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

    名前 説明
    ID 製品インベントリのSys_id

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    ロケーション 製品に関連付けられた場所。

    データタイプ：文字列
    製品特性 製品特性のリスト。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
  "id": "String",
  "name": "String"
}
    productOffering.id 製品オファリングのSys_id。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String"
}
    productSpecification.id 製品仕様のSys_id。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification]
    リソースの実現 リソースの実現。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    データタイプ：文字列
    実現サービス サービスを実現する。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    データタイプ：文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • 利用者
    • カスタマー
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

    この例では、SD-WAN サービスパッケージの製品インベントリを取得します。

    curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'

    出力：

    {
   "id": "074450fc74918d10f877ca57242ff9e3",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "SD-WAN Service Package PI0001576",
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package"
   },
   "status": "Installation Pending",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
   },
   "place": "",
   "productCharacteristic": [],
   "productRelationship": [
      {
         "id": "a74490fc74918d10f877ca57242ff942",
         "name": "SD-WAN Edge Device PI0001582",
         "relationshipType": "Bundles"
      },
      {
         "id": "b85414fc74918d10f877ca57242ff90e",
         "name": "SD-WAN Controller PI0001602",
         "relationshipType": "Bundles"
      },
      {
         "id": "d74490fc74918d10f877ca57242ff907",
         "name": "SD-WAN Security PI0001577",
         "relationshipType": "Bundles"
      }
   ],
   "realizingService": [],
   "realizingResource": []
}

    製品インベントリオープン API - POST /sn_prd_invt/product

    プロダクトインベントリレコードを作成します。

    このエンドポイントを使用して、製品インベントリバンドルを作成することもできます。これらのバンドルの詳細については、「」を参照してください。

    URL 形式

    デフォルト URL: /api/sn_prd_invt/product

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

    表 : 25. パスパラメーター
    名前 説明
    なし
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (JSON)
    名前 説明
    名前 必須。製品インベントリの名前。

    データタイプ：文字列
    pid 外部システムからの製品インベントリの一意の識別子。

    データタイプ：文字列

    デフォルト:空白の文字列
    製品特性 製品特性のリスト。

    製品特性の詳細については、「 」を参照してください。

    データタイプ：アレイ

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列

    デフォルト:空白の文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列

    デフォルト:空白の文字列
    productOffering 必須。製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id 必須。製品オファリングのInitial_versionまたはexternal_id。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.internalVersion 製品オファリングのバージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド内。
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    デフォルト:空白の文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.version 製品オファリングの外部バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_version フィールド内。
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId productRelationship パラメーターを使用する場合は必須です。関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    有効な値は 子のみです。

    データタイプ：文字列

    デフォルト:空白の文字列
    製品仕様 製品の製品仕様。製品仕様の詳細については、「 」を参照してください。

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

    "productSpecification": {
  "id": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id 製品仕様のInitial_versionまたはexternal_id。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification]
    productSpecification.internalVersion 製品仕様のバージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールドにあります。
    productSpecification.version 製品仕様の外部バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド内。
    リソースの実現 製品を実現するリソース。実現リソースは、この製品インベントリの子製品インベントリです。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id realizingResource パラメーターを使用する場合は必須です。 実現リソースのSys_id。

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]

    データタイプ：文字列
    realizingResource.type 実現リソースのタイプ。

    有効な値:child

    データタイプ：文字列
    実現サービス 製品を実現するサービス。実現サービスは、この製品インベントリの子製品インベントリです。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id realizingService パラメーターを使用する場合は必須です。 実現サービスのSys_id。

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]

    データタイプ：文字列
    realizingService.type 実現サービスのタイプ。

    有効な値:child

    データタイプ：文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id relatedParty パラメーターを使用する場合は必須です。チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • consumer
    • 顧客
    • customer_contact

    データタイプ：文字列

    デフォルト:空白の文字列
    状況 製品の現状。
    可能な値：
    • アクティブ
    • change_pending
    • inactivation_pending
    • 非アクティブ
    • installation_pending

    データタイプ：文字列

    デフォルト:installation_pending

    ヘッダー

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

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    受容 応答本文のデータ形式。application/jsonのみをサポートしています。
    Content-Type 要求本文のデータ形式。application/jsonのみをサポートしています。
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。

    ステータスコード

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

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

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

    名前 説明
    href 製品インベントリレコードへの相対リンク。

    データタイプ：文字列
    ID 製品インベントリのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    pid 外部システムからの製品インベントリの一意の識別子。

    データタイプ：文字列
    製品特性 製品特性のリスト。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id 製品オファリングの初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの [initial_version] または [external_id] フィールド内。
    productOffering.internalId 製品オファリングの初期バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] の [internal_version] フィールド内
    productOffering.internalVersion 製品オファリングのバージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルのバージョンフィールド内。
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.version 製品オファリングの外部バージョン。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering] テーブルの external_version フィールド内。
    製品価格 空のアレイを返します。

    データタイプ：アレイ
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    有効な値:child

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id 製品仕様の初期バージョンまたは外部 ID。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの [initial_version] または [external_id] フィールド内。
    productSpecification.internalId 製品仕様の初期バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの initial_version フィールド内。
    productSpecification.internalVersion 製品仕様のバージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルのバージョンフィールドにあります。
    productSpecification.version 製品仕様の外部バージョン。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification] テーブルの external_version フィールド内。
    リソースの実現 製品を実現するリソース。実現リソースは、この製品インベントリの子製品インベントリです。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    有効な値:child

    データタイプ：文字列
    実現サービス 製品を実現するサービス。実現サービスは、この製品インベントリの子製品インベントリです。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    有効な値:child

    データタイプ：文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • 利用者
    • カスタマー
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

    この例では、ユーザーの Voice over IP ソリューションの製品インベントリを作成します。

    curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
   {
      "pid": "PO-456",
      "description": "inventory description",
      "isBundle": false,
      "name": "Voice Over IP Basic instance for Jean",
      "productOffering": {
         "@referredType": "ProductOffering",
         "name": "Premium SD-WAN Offering",
         "id": "69017a0f536520103b6bddeeff7b127d"
      },
      "productCharacteristic": [],
      "productRelationship": [
         {
            "productId": "fa6d13f45b5620102dff5e92dc81c77f",
            "relationshipType": "child"
         }
      ],
      "realizingService": {
         "id": "fe6d13f45b5620102dff5e92dc81c786",
         "relationshipType": "child"
      },
      "realizingResource": {
         "id": "326d13f45b5620102dff5e92dc81c78c",
         "relationshipType": "child"
      },
      "relatedParty": [
         {
            "@referredType": "CustomerContact",
            "@type": "RelatedParty",
            "name": "Sally Thomas",
            "id": "eaf68911c35420105252716b7d40ddde"
         },
         {
            "@referredType": "Customer",
            "@type": "RelatedParty",
            "name": "Funco Intl",
            "id": "ffc68911c35420105252716b7d40dd55"
         }
      ],
      "productSpecification": {
         "@referredType": "ProductSpecification",
         "@type": null,
         "name": null,
         "id": "3ee1fdb1c3331010d216b5183c40dd81",
         "internalVersion": "1"
      },
      "bundle": false
   }
]"

    応答本文。

    {
   "pid": "PO-456",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "@referredType": "ProductOffering",
      "name": "Premium SD-WAN Offering",
      "id": "69017a0f536520103b6bddeeff7b127d",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "productCharacteristic": [],
   "productRelationship": [
      {
         "productId": "fa6d13f45b5620102dff5e92dc81c77f",
         "relationshipType": "child"
      }
   ],
   "realizingService": {
      "id": "fe6d13f45b5620102dff5e92dc81c786",
      "relationshipType": "child"
   },
   "realizingResource": {
      "id": "326d13f45b5620102dff5e92dc81c78c",
      "relationshipType": "child"
   },
   "relatedParty": [
      {
         "@referredType": "CustomerContact",
         "@type": "RelatedParty",
         "name": "Sally Thomas",
         "id": "eaf68911c35420105252716b7d40ddde"
      },
      {
         "@referredType": "Customer",
         "@type": "RelatedParty",
         "name": "Example Company",
         "id": "ffc68911c35420105252716b7d40dd55"
      }
   ],
   "productSpecification": {
      "@referredType": "ProductSpecification",
      "@type": null,
      "name": null,
      "id": "3ee1fdb1c3331010d216b5183c40dd81",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "3ee1fdb1c3331010d216b5183c40dd81"
   },
   "bundle": false,
   "productPrice": [],
   "id": "25b07475471789108761b955d36d439d",
   "href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}

    製品インベントリオープン API - POST /sn_prd_invt/productinventory

    製品インベントリを作成します。

    重要:
    Tokyoリリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは 製品インベントリオープン API - POST /sn_prd_invt/product です。

    URL 形式

    デフォルト URL: /api/sn_prd_invt/productinventory

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

    表 : 31. パスパラメーター
    名前 説明
    なし
    表 : 32. クエリパラメーター
    名前 説明
    なし
    表 : 33. 要求本文パラメーター (JSON)
    名前 説明
    名前 必須。製品インベントリの名前。

    データタイプ：文字列
    pid 外部システムからの製品インベントリの一意の識別子。

    データタイプ：文字列

    デフォルト:空白の文字列
    製品特性 製品特性のリスト。

    データタイプ：アレイ

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列

    デフォルト:空白の文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列

    デフォルト:空白の文字列
    productOffering 必須。製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id 必須。製品オファリングのSys_id。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    デフォルト:空白の文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId productRelationship パラメーターを使用する場合は必須です。関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    有効な値は 子のみです。

    データタイプ：文字列

    デフォルト:空白の文字列
    製品仕様 必須。製品の製品仕様。

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

    "productSpecification": {
  "id": "String"
}
    productSpecification.id 必須。製品仕様のSys_id。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification]
    リソースの実現 リソースの実現。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id realizingResource パラメーターを使用する場合は必須です。実現リソースのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    有効な値は 子のみです。

    データタイプ：文字列

    デフォルト:空白の文字列
    実現サービス サービスを実現する。

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

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizingService.id realizingService パラメーターを使用する場合は必須です。実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    有効な値は 子のみです。

    データタイプ：文字列

    デフォルト:空白の文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id relatedParty パラメーターを使用する場合は必須です。チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_Consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • consumer
    • 顧客
    • customer_contact

    データタイプ：文字列

    デフォルト:空白の文字列
    状況 製品の現状。
    可能な値：
    • アクティブ
    • change_pending
    • inactivation_pending
    • 非アクティブ
    • installation_pending

    データタイプ：文字列

    デフォルト:installation_pending

    ヘッダー

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

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    受容 応答本文のデータ形式。application/jsonのみをサポートしています。
    Content-Type 要求本文のデータ形式。application/jsonのみをサポートしています。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータ形式。application/jsonのみをサポートしています。

    ステータスコード

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

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

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

    名前 説明
    ID 製品インベントリのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    名前 製品インベントリの名前。

    データタイプ：文字列
    pid 外部システムからの製品インベントリの一意の識別子。

    データタイプ：文字列
    製品特性 製品特性のリスト。

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

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name 特性の名前。

    データタイプ：文字列
    productCharacteristic.value 特性の値。

    データタイプ：文字列
    productOffering 製品インベントリが関連付けられている製品オファリング。

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

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id 製品オファリングのSys_id。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    productOffering.name 製品オファリングの名前。

    データタイプ：文字列

    テーブル:製品オファリング [sn_prd_pm_product_offering]
    製品リレーションシップ 関連製品のリスト。

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

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId 関連製品のSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    productRelationship.relationshipType 関係のタイプ。

    データタイプ：文字列
    製品仕様 製品の製品仕様。

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

    "productSpecification": {
  "id": "String"
}
    productSpecification.id 製品仕様のSys_id。

    データタイプ：文字列

    テーブル:製品仕様 [sn_prd_pm_product_specification]
    リソースの実現 リソースの実現。

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

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id 実現リソースのSys_id

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingResource.type 実現リソースのタイプ。

    データタイプ：文字列
    実現サービス サービスを実現する。

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

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id 実現サービスのSys_id。

    データタイプ：文字列

    テーブル:製品インベントリ [sn_prd_invt_product_inventory]
    realizingService.type 実現サービスのタイプ。

    データタイプ：文字列
    関連パーティー チケットに関連付けられている当事者のリスト。

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

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id チケットに関連付けられたアカウントまたは顧客の連絡先のSys_id。

    データタイプ：文字列

    テーブル:アカウント [customer_account]、連絡先 [customer_contact]、またはコンシューマー [csm_consumer]
    relatedParty.@referredType 顧客のタイプ。
    可能な値：
    • 利用者
    • カスタマー
    • 顧客連絡先

    データタイプ：文字列
    状況 製品の現状。

    データタイプ：文字列

    cURL 要求

    この例では、ユーザーの Voice over IP ソリューションの製品インベントリを作成します。

    curl --location --request POST "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--header "Content-Type: application/json" \
--data-raw '[
    {
        "pid": "demoInventory",
        "description": "inventory description",
        "isBundle": false,
        "name": "Voice Over IP Basic instance for Jean",
        "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "@referredType": "ProductOffering"
        },
        "productCharacteristic": [
            {
                "name": "CPE Type",
                "valueType": "choice",
                "value": "Virtual"
            },
            {
                "name":"Routing",
                "valueType": "choice",
                "value": "Premium"
            }
        ],
        "productRelationship": [
            {
                "productId": "7e6d13f45b5620102dff5e92dc81c787",
                "relationshipType": "child"
            }
        ],
        "relatedParty": [
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "role": "User",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            }
        ],
        "productSpecification": {
            "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
            "@referredType": "ProductSpecification",
            "version": "1"
        }
    }
]'
--user 'username':'password'

    応答本文。

    {
   "pid": "demoInventory",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "@referredType": "ProductOffering"
   },
   "productCharacteristic": [
      {
         "name": "CPE Type",
         "valueType": "choice",
         "value": "Virtual"
      },
      {
         "name": "Routing",
         "valueType": "choice",
         "value": "Premium"
      }
   ],
   "productRelationship": [
      {
         "productId": "7e6d13f45b5620102dff5e92dc81c787",
         "relationshipType": "child"
      }
   ],
   "relatedParty": [
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "role": "User",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      },
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "@referredType": "ProductSpecification",
      "version": "1"
   },
   "id": "3ac715c6745d8150f877ca57242ff97a"
}