リソース在庫オープン API

リソース在庫オープン API は、リソースを作成、取得、および削除するためのエンドポイントを提供します。

この API を使用して、次のテーブルのリソースを管理します。

• ケーブル [cmdb_ci_cable]
• 機器ホルダー [cmdb_ci_equipment_holder]
• インターフェイスカード [cmdb_ci_interface_card]
• IP アドレス [cmdb_ci_ip_address]
• 論理接続 [cmdb_ci_ni_logical_path]
• ネットワークインターフェイス [cmdb_ci_ni_interface]
• ネットワークサイト [cmdb_ci_ni_site]
• 物理接続 [cmdb_ci_ni_physical_link]
• ストランド [cmdb_ci_strand]
• トポロジ [cmdb_ci_topology]
• sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。
• 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。
• 次のいずれかのテーブルを拡張する子テーブル:
  • ケーブル [cmdb_ci_cable]
  • 機器ホルダー [cmdb_ci_equipment_holder]
  • ストランド [cmdb_ci_strand]

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

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

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

この API を拡張して、必須パラメーター、要求本文の検証、およびフィールドマッピングをカスタマイズできます。詳細については、「リソースインベントリオープン API 開発者ガイド」を参照してください。

リソース在庫オープン API は、TM Forum Resource Inventory API REST 仕様の ServiceNow® 実装です。この実装は、TMF639 Resource Inventory API User Guide v4.0.1 (2020 年 7 月) に基づいています。

リソース在庫オープン API - DELETE /sn_ni_core/resource/{id}

指定されたリソースレコードを削除します。

URL 形式

デフォルトの URL：/api/sn_ni_core/resource/{id}

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

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

名前

説明

id

リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 注: IP アドレス [cmdb_ci_ip_address] テーブル内のリソースは、この API を使用して削除することはできません。 データタイプ：文字列

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

名前	説明
なし

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

名前	説明
なし

ヘッダー

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

表 : 4. 要求ヘッダー

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

表 : 5. 応答ヘッダー

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

ステータスコード

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

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

ステータスコード	説明
215	処理のため要求が正常に受信されました。要求は非同期的に完了します。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
403	禁止されています。リソースの削除に失敗しました。リソースは、その関連リソースによって必要とされる場合があります。
404	見つかりません。要求アイテムが見つかりませんでした。

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

名前	説明
なし

cURL 要求

この例では、リソースを削除します。

curl "https://instance.service-now.com/api/sn_ni_core/resource/54ada05e875c15109a9c0f65dabb3586" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

""

リソース在庫オープン API - GET /sn_ni_core/resource

すべてのリソースレコードリストを取得します。

URL 形式

デフォルトの URL：/api/sn_ni_core/resource

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

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

名前	説明
なし

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

名前	Description (説明)
@type	必須。取得するリソースのタイプのテーブル名。API 呼び出しごとに 1 つのタイプのリソースのみを取得できます。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースをフィルタリングするために使用する説明。指定された説明を持つリソースのみが応答で返されます。 データタイプ：文字列
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効な値： description href id name note place relatedParty resourceCharacteristic resourceRelationship resourceSpecification startOperatingDate デフォルト：すべてのフィールドを返します。 データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：20 データタイプ：数値
name	リソースをフィルタリングするために使用する名前。指定された名前を持つリソースのみが応答で返されます。 データタイプ：文字列
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値
resourceSpecification.id	リソースのフィルタリングに使用するリソース仕様の sys_id。sys_id は、次のいずれかのテーブルにあるモデルのものである必要があります。 機器所有者モデル [sn_ni_core_equipment_holder_product_model] 機器モデル [sn_ni_core_equipment_product_model] インターフェイスカードモデル [sn_ni_core_interface_card_product_model] 論理接続モデル [sn_ni_core_logical_connection_product_model] ネットワークインターフェイスモデル [sn_ni_core_network_interface_product_model] 物理接続モデル [sn_ni_core_physical_connection_product_model] 指定された sys_id に一致するモデルを持つリソースのみが応答で返されます。 データタイプ：文字列

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

名前	説明
なし

ヘッダー

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

表 : 10. 要求ヘッダー

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

表 : 11. 応答ヘッダー

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

ステータスコード

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

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

ステータスコード	Description (説明)
200	成功。要求が正常に処理されました。
206	部分的なコンテンツ。要求は正常に処理され、ページネーションされた呼び出しによって指定されたコンテンツの部分的な範囲が返されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

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

名前	説明
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
href	リソースレコードへの相対リンク。 データタイプ：文字列
id	リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列
name	リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	メモのテキスト。 データタイプ：文字列
place	リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
relatedParty.role	関係者のロール。チーム [cmdb_rel_team] テーブルの [グループタイプ ] フィールドにあります。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	@type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	[このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

cURL 要求

この例では、最初の 5 つのネットワークサイトリソースレコードの name、 id、および href フィールドを取得します。

curl "https://instance.service-now.com/api/sn_ni_core/resource?@type=cmdb_ci_ni_site&fields=name%2Cid%2Chref&limit=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

[
   {
      "name": "DALLAS TX CO/HUB",
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/sn_ni_core/resource/c23683c54051c910f8772175cacd725c"
   },
   {
      "name": "PFP LOC F-800",
      "id": "0ac19bc54051c910f8772175cacd724b",
      "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
   },
   {
      "name": "FIBER SERVICE TERMINAL 003",
      "id": "d0541fcd4051c910f8772175cacd72c8",
      "href": "/api/sn_ni_core/resource/d0541fcd4051c910f8772175cacd72c8"
   },
   {
      "name": "270 RUMWOOD MAIN",
      "id": "e6f6df8d4051c910f8772175cacd72b2",
      "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
   },
   {
      "name": "3620 CHESTER ROMI48073",
      "id": "917dd8f6870e851079c40f2d0ebb353d",
      "href": "/api/sn_ni_core/resource/917dd8f6870e851079c40f2d0ebb353d"
   }
]

リソース在庫オープン API - GET /sn_ni_core/resource/{id}

指定されたリソースレコードを取得します。

URL 形式

デフォルトの URL：/api/sn_ni_core/resource/{id}

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

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

名前

説明

id

リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列

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

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効な値： description href id name note place relatedParty resourceCharacteristic resourceRelationship resourceSpecification startOperatingDate デフォルト：すべてのフィールドを返します。 データタイプ：文字列

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

名前	説明
なし

ヘッダー

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

表 : 16. 要求ヘッダー

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

表 : 17. 応答ヘッダー

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

ステータスコード

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

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

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求アイテムが見つかりませんでした。

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

名前	説明
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
href	リソースレコードへの相対リンク。 データタイプ：文字列
id	リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列
name	リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	メモのテキスト。 データタイプ：文字列
place	リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	@type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	[このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

cURL 要求

この例では、指定されたリソースレコードを取得します。

curl "https://instance.service-now.com/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

{
   "href": "/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de",
   "id": "915da8e140ddc910f8772175cacd72de",
   "name": "DLLSTXMR/ESS7450/IOM-01/MDA-01/NI-01",
   "place": {
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
      "@referredType": "GeographicAddress"
   },
   "resourceCharacteristic": [
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "availability",
         "valueType": "string",
         "value": "used"
      },
      {
         "name": "cabled",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "connector_type",
         "valueType": "string",
         "value": "sc"
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "equipment_clli",
         "valueType": "string",
         "value": "DLLSTXESS01"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "manufacturer",
         "valueType": "reference",
         "value": "a2f6a4914055c910f8772175cacd723a"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "646cf25fe42e0510f877e70ec9bcaca8"
      },
      {
         "name": "port_bandwidth",
         "valueType": "reference",
         "value": "ff39ae92eb900110700ca73bc152286d"
      },
      {
         "name": "replaceable",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "telco_equipment",
         "valueType": "reference",
         "value": "583e7b95405dc910f8772175cacd7292"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "virtual",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "81baac6140ddc910f8772175cacd728e",
            "href": "/api/sn_ni_core/resource/81baac6140ddc910f8772175cacd728e"
         }
      },
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "bf624bc640194d10f8772175cacd7225",
            "href": "/api/sn_ni_core/resource/bf624bc640194d10f8772175cacd7225"
         }
      }
   ],
   "resourceSpecification": {
      "id": "980416b0874e8110d28eb259dabb356b",
      "href": "/api/now/table/sn_ni_core_network_inventory_product_model/980416b0874e8110d28eb259dabb356b",
      "@referredType": "NetworkInterfaceModel"
   },
   "@type": "cmdb_ci_ni_interface"
}

リソースインベントリオープン API - PATCH /sn_ni_core/resource/{id}

指定されたリソースレコードを更新します。

URL 形式

デフォルトの URL：/api/sn_ni_core/resource/{id}

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

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

名前

説明

id

リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列

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

名前	説明
なし

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

名前	Description (説明)
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
href	リソースレコードへの相対リンク。 データタイプ：文字列
name	リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	note パラメーターが使用される場合は必須です。 メモのテキスト。 データタイプ：文字列
place	リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	place パラメーターが使用される場合は必須です。 ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ] 注: リソースからの relatedParty レコードの削除は、このエンドポイントではサポートされていません。Teams [cmdb_rel_team] テーブルからレコードを手動で削除できます。
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	relatedParty パラメーターが使用される場合は必須です。 グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
relatedParty.role	関係者のロール。チーム [cmdb_rel_team] テーブルの [グループタイプ ] フィールドにあります。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	resourceCharacteristic パラメーターが使用される場合は必須です。 @type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	resourceCharacteristic パラメーターが使用される場合は必須です。 特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	resourceRelationship パラメーターが使用される場合は必須です。 [このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	resourceRelationship パラメーターが使用される場合は必須です。 関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	resourceRelationship パラメーターが使用される場合は必須です。 関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	resourceSpecification パラメーターが使用される場合は必須です。 リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

ヘッダー

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

表 : 22. 要求ヘッダー

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

表 : 23. 応答ヘッダー

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

ステータスコード

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

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

ステータスコード	Description (説明)
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求アイテムが見つかりませんでした。
415	要求本文がサポートされていない形式であるか、Content-Type 要求ヘッダーが正しく設定されていません。

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

名前	説明
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
href	リソースレコードへの相対リンク。 データタイプ：文字列
id	リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列
name	リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	メモのテキスト。 データタイプ：文字列
place	リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
relatedParty.role	関係者のロール。チーム [cmdb_rel_team] テーブルの [グループタイプ ] フィールドにあります。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	@type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	[このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

cURL 要求

この例では、リソースの名前を更新します。

curl "http://instance.servicenow.com/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/merge-patch+json" \
--user 'username':'password' \
--data '{"name": "new name"}'

応答本文。

{
  "href": "/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292",
  "id": "583e7b95405dc910f8772175cacd7292",
  "name": "new name",
  "note": [
    {
      "text": "TECHNICIAN SCHECULED TO BE ONSITE THE WEEK OF APRIL 4, 2022."
    }
  ],
  "place": {
    "id": "c23683c54051c910f8772175cacd725c",
    "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
    "@referredType": "GeographicAddress"
  },
  "resourceCharacteristic": [
    {
      "name": "alarmable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "attested",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_hub",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_partitionvlans",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_print",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_route",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_switch",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "comments",
      "valueType": "string",
      "value": "ETHERNET SWITCH"
    },
    {
      "name": "cost_cc",
      "valueType": "string",
      "value": "USD"
    },
    {
      "name": "cpu_count",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "equipment_clli",
      "valueType": "string",
      "value": "DLLSTXESS01"
    },
    {
      "name": "fault_count",
      "valueType": "integer",
      "value": "0"
    },
    {
      "name": "firmware_manufacturer",
      "valueType": "reference",
      "value": "0c441abbc6112275000025157c651c89"
    },
    {
      "name": "firmware_version",
      "valueType": "string",
      "value": "A09DX887"
    },
    {
      "name": "hardware_status",
      "valueType": "string",
      "value": "installed"
    },
    {
      "name": "install_status",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "internet_facing",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "inventory_category",
      "valueType": "string",
      "value": "equipment"
    },
    {
      "name": "last_service_date",
      "valueType": "datetime",
      "value": "2022-02-18T16:36:54.000Z"
    },
    {
      "name": "life_cycle_stage",
      "valueType": "reference",
      "value": "Deploy"
    },
    {
      "name": "life_cycle_stage_status",
      "valueType": "reference",
      "value": "Reserved"
    },
    {
      "name": "managed_by",
      "valueType": "reference",
      "value": "46c9e158a9fe198101d44d0d22cb640d"
    },
    {
      "name": "manufacturer",
      "valueType": "reference",
      "value": "b7e831bdc0a80169015ae101f3c4d6cd"
    },
    {
      "name": "model_number",
      "valueType": "string",
      "value": "7450ESS-1"
    },
    {
      "name": "monitor",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "network_domain",
      "valueType": "string",
      "value": "core"
    },
    {
      "name": "ni_function",
      "valueType": "reference",
      "value": "2d22153940990d10f8772175cacd728b"
    },
    {
      "name": "ni_role",
      "valueType": "reference",
      "value": "c68e3f15405dc910f8772175cacd72f1"
    },
    {
      "name": "ni_type",
      "valueType": "reference",
      "value": "3772e8d54015c910f8772175cacd721c"
    },
    {
      "name": "ram",
      "valueType": "integer",
      "value": "3000"
    },
    {
      "name": "replaceable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "serial_number",
      "valueType": "string",
      "value": "7894564568225"
    },
    {
      "name": "skip_sync",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "spare",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "template_id",
      "valueType": "reference",
      "value": "49433535e5d28110f877657a33339131"
    },
    {
      "name": "unit_position",
      "valueType": "integer",
      "value": "2"
    },
    {
      "name": "unverified",
      "valueType": "boolean",
      "value": "false"
    }
  ],
  "resourceRelationship": [
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "f5d1c429405dc910f8772175cacd723f",
        "href": "/api/sn_ni_core/resource/f5d1c429405dc910f8772175cacd723f"
      }
    },
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "d6e100e5405dc910f8772175cacd72e9",
        "href": "/api/sn_ni_core/resource/d6e100e5405dc910f8772175cacd72e9"
      }
    },
    {
      "relationshipType": "Contained by::Contains",
      "resource": {
        "id": "5b10e8154015c910f8772175cacd724d",
        "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
      }
    }
  ],
  "resourceSpecification": {
    "id": "0ae34df1e5528110f877657a33339119",
    "href": "/api/now/table/cmdb_model/0ae34df1e5528110f877657a33339119",
    "@referredType": "EquipmentModel"
  },
  "@type": "cmdb_ci_ni_telco_equipment"
}

リソース在庫オープン API - POST /sn_ni_core/resource

リソースレコードを作成します。

URL 形式

デフォルトの URL：/api/sn_ni_core/resource

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

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

名前	説明
なし

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

名前	説明
なし

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

名前	説明
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
name	必須です。 リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	note パラメーターが使用される場合は必須です。 メモのテキスト。 データタイプ：文字列
place	コンテナタイプがケージ、ベイ、キャビネット、ラック、ラインアップ、またはインベントリモデルバンドルである機器ホルダーリソースに必要です。すべての機器リソースに必要です。 リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	place パラメーターが使用される場合は必須です。 ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	relatedParty パラメーターが使用される場合は必須です。 グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	resourceCharacteristic パラメーターが使用される場合は必須です。 @type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	resourceCharacteristic パラメーターが使用される場合は必須です。 特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	resourceRelationship パラメーターが使用される場合は必須です。 [このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	resourceRelationship パラメーターが使用される場合は必須です。 関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	resourceRelationship パラメーターが使用される場合は必須です。 関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	resourceSpecification パラメーターが使用される場合は必須です。 リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

ヘッダー

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

表 : 28. 要求ヘッダー

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

表 : 29. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
場所	作成されたリソースの URL。

ステータスコード

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

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

ステータスコード	説明
215	処理のため要求が正常に受信されました。要求は非同期的に完了します。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

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

名前	説明
@type	リソースのタイプ。 有効な値： cmdb_ci_cable (ケーブル) cmdb_ci_interface_card (インターフェイスカード) cmdb_ci_ip_address (IP アドレス) cmdb_ci_ni_logical_path (論理接続) cmdb_ci_ni_interface (ネットワークインターフェイス) cmdb_ci_ni_site (ネットワークサイト) cmdb_ci_ni_physical_link (物理接続) cmdb_ci_strand (ストランド) cmdb_ci_topology (トポロジ) sn_ni_core.equipment_tables sys_propertyで指定されたテーブルの名前、または指定されたテーブルを拡張するテーブルの名前。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブルの名前。 データタイプ：文字列
description	リソースの説明。 データタイプ：文字列
href	リソースレコードへの相対リンク。 データタイプ：文字列
id	リソースの sys_id。リソースのタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列
name	リソースの名前。 データタイプ：文字列
note	リソースに関するメモのリスト。 データタイプ：アレイ "note": [ { "text": "String" } ]
note.text	メモのテキスト。 データタイプ：文字列
place	リソースのネットワークサイト。 このパラメーターは、ネットワークサイト、物理接続、または論理接続リソースではサポートされていません。 データタイプ: オブジェクト "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	場所のタイプ。この値は常に GeographicAddress です。 データタイプ：文字列
place.href	場所レコードへの相対リンク。 データタイプ：文字列
place.id	ネットワークサイト [cmdb_ci_ni_site] テーブル内の場所レコードの sys_id。 データタイプ：文字列
relatedParty	リソースの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。グループ [sys_user_group] テーブルの [タイプ ] フィールドにあります。 データタイプ：文字列
relatedParty.href	関連するパーティレコードへの相対リンク。 データタイプ：文字列
relatedParty.id	グループ [sys_user_group] テーブル内の関係者レコードのSys_id。 データタイプ：文字列
resourceCharacteristic	リソースの特性のリスト。次のリソースタイプには、特定のリソース特性が必要です。 物理接続および論理接続リソースの場合、 ポート A または ポート Z の特性が必要です。リソースのライフサイクルステージステータスが [使用中] の場合は、Port A と Port Z の両方が必要です。 機器ホルダーリソースの場合、 コンテナタイプ 特性が必要です。 データタイプ：アレイ "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	@type パラメーターで指定されたリソーステーブルのフィールド名。model_id、name、network_site、operation_notes、operational_status、short_description、start_date のフィールド、または sys_id などの sys_ プリフィックスが付いたフィールドは使用できません。 データタイプ：文字列
resourceCharacteristic.value	特性の値。 データタイプ：文字列
resourceCharacteristic.valueType	値のタイプ。 有効な値： ブール 日時 浮動小数点数 integer ph_number 参照 string データタイプ：文字列
resourceRelationship	関連リソースのリスト。次のリソースタイプには、特定の関連リソースが必要です。 インターフェイスカードリソースの場合、コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースとの関係が必要です。 ネットワークインターフェイスリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 コンテナタイプがスロットまたはサブスロットである機器ホルダーリソースの場合、機器またはインターフェイスカードリソースとの関係が必要です。 データタイプ：アレイ "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	[このリソース記述子]::[関連リソース記述子] 形式の 2 つのリソース間の関係のタイプ。たとえば、Contains::Contained by は、関連リソースがこのリソースの子であることを示します。 記述子の有効な値は、CI 関係タイプ [cmdb_rel_type] テーブルの、Parent descriptor および Child descriptor 列にあります。 データタイプ：文字列
resourceRelationship.resource	関連リソースの詳細。関連リソースは、次のいずれかのリソースタイプである必要があります。 ケーブル 機器 機器ホルダー インターフェイスカード Logical Connection (論理接続) ネットワークインターフェイス ネットワークサイト 物理接続 ストランド トポロジ データタイプ: オブジェクト "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	関連リソースの sys_id。関連リソースのタイプに応じて、次のいずれかのテーブルにあります。 インターフェイスカード [cmdb_ci_interface_card] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダーを拡張するテーブル [cmdb_ci_equipment_holder] データタイプ：文字列
resourceRelationship.resource.href	関連リソースレコードへの相対リンク。 データタイプ：文字列
resourceSpecification	リソース仕様。 データタイプ: オブジェクト "resourceSpecification": { "id": "String" }
resourceSpecification.id	リソースの関連モデルの sys_id。モデルのタイプに応じて、次のいずれかのテーブルにあります。 ケーブルモデル [sn_ent_cable_model] 機器ホルダーモデル [sn_ent_nw_holder_model] 設備モデル [sn_ent_nw_equipment_model] インターフェイスカードモデル [sn_ent_nw_interface_model] 論理接続モデル [sn_ent_logical_nw_connection_model] ネットワークインターフェイスモデル [sn_ent_nw_interface_model] 物理接続モデル [sn_ent_physical_nw_connection_model] ストランドモデル [sn_ent_strand_model] トポロジモデル [sn_ent_network_topology_model] データタイプ：文字列
startOperatingDate	リソースが最初に運用を開始した日時。 データタイプ：文字列

cURL 要求

この例では、コロラド州デンバーにネットワークサイトを作成します。

curl "https://instance.service-now.com/api/sn_ni_core/resource" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"DENVER CO CO/HUB\",
  \"note\": [
    {
      \"text\": \"Cisco maintenance team onsite June 22, 2022.\"
    }
  ],
  \"resourceCharacteristic\": [
    {
      \"name\": \"attested\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"can_print\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"clli_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVRCOMR02T\"
    },
    {
      \"name\": \"comments\",
      \"valueType\": \"string\",
      \"value\": \"Site is scheduled for diesel generator test July 13, 2022 at 9am CST.\"
    },
    {
      \"name\": \"cost_cc\",
      \"valueType\": \"string\",
      \"value\": \"USD\"
    },
    {
      \"name\": \"county\",
      \"valueType\": \"string\",
      \"value\": \"DENVER\"
    },
    {
      \"name\": \"data_center_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVR00564\"
    },
    {
      \"name\": \"fault_count\",
      \"valueType\": \"integer\",
      \"value\": \"0\"
    },
    {
      \"name\": \"install_status\",
      \"valueType\": \"integer\",
      \"value\": \"1\"
    },
    {
      \"name\": \"life_cycle_stage\",
      \"valueType\": \"reference\",
      \"value\": \"Operational\"
    },
    {
      \"name\": \"life_cycle_stage_status\",
      \"valueType\": \"reference\",
      \"value\": \"In Use\"
    },
    {
      \"name\": \"location\",
      \"valueType\": \"reference\",
      \"value\": \"25ab8f300a0a0bb300d99f69c3ac24cd\"
    },
    {
      \"name\": \"managed_by\",
      \"valueType\": \"reference\",
      \"value\": \"b0f31e5673500010c2e7660c4cf6a711\"
    },
    {
      \"name\": \"monitor\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"network_domain\",
      \"valueType\": \"string\",
      \"value\": \"core\"
    },
    {
      \"name\": \"ni_type\",
      \"valueType\": \"reference\",
      \"value\": \"8e8f3770404d0110f8772175cacd7204\"
    },
    {
      \"name\": \"pots_number\",
      \"valueType\": \"ph_number\",
      \"value\": \"[phone]\"
    },
    {
      \"name\": \"skip_sync\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"third_party_ownership\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"unverified\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    }
  ],
  \"resourceRelationship\": [
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"e6f6df8d4051c910f8772175cacd72b2\",
        \"href\": \"/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"0ac19bc54051c910f8772175cacd724b\",
        \"href\": \"/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"997e5c11875851109a9c0f65dabb35ac\",
        \"href\": \"/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"5b10e8154015c910f8772175cacd724d\",
        \"href\": \"/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"57e73b51405dc910f8772175cacd726e\",
        \"href\": \"/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"bf58f751405dc910f8772175cacd72e8\",
        \"href\": \"/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"b5711e31405d0d10f8772175cacd7232\",
        \"href\": \"/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"ed811e31405d0d10f8772175cacd72d3\",
        \"href\": \"/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"d74937d1405dc910f8772175cacd7288\",
        \"href\": \"/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"da0df2e3e4e64510f877e70ec9bcacc6\",
        \"href\": \"/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6\"
      }
    }
  ],
  \"@type\": \"cmdb_ci_ni_site\"
}" \
--user 'username':'password'

応答本文。

{
   "href": "/api/sn_ni_core/resource/00399f0aed349150f877305f29f832b2",
   "id": "00399f0aed349150f877305f29f832b2",
   "name": "DENVER CO CO/HUB",
   "note": [
      {
         "text": "Cisco maintenance team onsite June 22, 2022."
      }
   ],
   "resourceCharacteristic": [
      {
         "name": "altitude_units",
         "valueType": "string",
         "value": "feet"
      },
      {
         "name": "attestation_status",
         "valueType": "string",
         "value": "Not Yet Reviewed"
      },
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "clli_code",
         "valueType": "string",
         "value": "DNVRCOMR02T"
      },
      {
         "name": "comments",
         "valueType": "string",
         "value": "Site is scheduled for diesel generator test July 13, 2022 at 9am CST."
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "county",
         "valueType": "string",
         "value": "DENVER"
      },
      {
         "name": "data_center_code",
         "valueType": "string",
         "value": "DNVR00564"
      },
      {
         "name": "discovery_source",
         "valueType": "string",
         "value": "Resource Inventory Open API"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "first_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "last_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "location",
         "valueType": "reference",
         "value": "25ab8f300a0a0bb300d99f69c3ac24cd"
      },
      {
         "name": "managed_by",
         "valueType": "reference",
         "value": "b0f31e5673500010c2e7660c4cf6a711"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "8e8f3770404d0110f8772175cacd7204"
      },
      {
         "name": "pots_number",
         "valueType": "ph_number",
         "value": "[phone]"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "third_party_ownership",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "e6f6df8d4051c910f8772175cacd72b2",
            "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "0ac19bc54051c910f8772175cacd724b",
            "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "997e5c11875851109a9c0f65dabb35ac",
            "href": "/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "5b10e8154015c910f8772175cacd724d",
            "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "57e73b51405dc910f8772175cacd726e",
            "href": "/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "bf58f751405dc910f8772175cacd72e8",
            "href": "/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "b5711e31405d0d10f8772175cacd7232",
            "href": "/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "ed811e31405d0d10f8772175cacd72d3",
            "href": "/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "d74937d1405dc910f8772175cacd7288",
            "href": "/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "da0df2e3e4e64510f877e70ec9bcacc6",
            "href": "/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6"
         }
      }
   ],
   "@type": "cmdb_ci_ni_site"
}

リソースインベントリオープン API - POST /sn_ni_core/resourceInventoryViatemplate

テンプレートに基づいてリソース構成アイテム (CI) と関連 CI 階層を作成します。

このエンドポイントを呼び出す前に、在庫テンプレート [sn_ni_core_inventory_template] テーブルに在庫テンプレートを作成する必要があります。関連 CI の階層全体を在庫テンプレートで定義できます。その後、単一の API 要求を介してすべての CI と関係を作成できます。

URL 形式

デフォルトの URL：/api/sn_ni_core/resourceinventoryviatemplate

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

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

名前	説明
なし

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

名前	説明
なし

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

名前	説明
overrides	オーバーライドする列と使用する値のリスト。 データタイプ：オブジェクト "overrides": { "column_name": "String" }
overrides.column_name	overrides パラメーターが使用される場合は必須です。列の名前と値。 データタイプ：文字列
parentId	必須です。親 CI の sys_id。親 CI のタイプに応じて、次のいずれかのテーブルにあります。 ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] インターフェイスカード [cmdb_ci_interface_card] IP アドレス [cmdb_ci_ip_address] 論理接続 [cmdb_ci_ni_logical_path] ネットワークインターフェイス [cmdb_ci_ni_interface] ネットワークサイト [cmdb_ci_ni_site] 物理接続 [cmdb_ci_ni_physical_link] ストランド [cmdb_ci_strand] トポロジ [cmdb_ci_topology] sn_ni_core.equipment_tables sys_propertyによって指定されたテーブル、および指定されたテーブルを拡張するテーブル。 機器ホルダー [cmdb_ci_equipment_holder] を拡張するテーブル。 次のいずれかのテーブルを拡張する子テーブル: ケーブル [cmdb_ci_cable] 機器ホルダー [cmdb_ci_equipment_holder] ストランド [cmdb_ci_strand] データタイプ：文字列
templateId	必須です。テンプレートの sys_id。在庫テンプレート [sn_ni_core_inventory_template] テーブルにあります。 データタイプ：文字列
templateOverride	テンプレートのオーバーライドリスト。 データタイプ：アレイ "templateOverrides": [ { "overrideTemplateId": "String", "templateId": "String" } ]
templateOverrides.overrideTemplateId	templateOverrides パラメーターが使用される場合は必須です。利用可能なテンプレート sys_id。 データタイプ：文字列
templateOverrides.templateId	templateOverrides パラメーターが使用される場合は必須です。関連テンプレートの sys_id。 データタイプ：文字列

ヘッダー

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

表 : 34. 要求ヘッダー

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

表 : 35. 応答ヘッダー

ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
場所	階層の最上位にある作成された CI の URL。

ステータスコード

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

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

ステータスコード	説明
201	リソースが作成されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
500	エラー。要求でエラーが発生しました。たとえば、要求が検証チェックに失敗したなどです。

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

名前	説明
result	作成された CI に関する情報を含む結果オブジェクト。 データタイプ：オブジェクト "result": { "sys_id": "String" }
result.sys_id	階層の最上位にある作成された CI の sys_id。 データタイプ：文字列

cURL 要求

この例では、テンプレートを使用して CI 階層を作成します。

curl "https://instance.service-now.com/api/sn_ni_core/resourceinventoryviatemplate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "templateId": "90475711ed6ec110f877d2f57b8accda",
   "parentId": "917dd8f6870e851079c40f2d0ebb353d",
   "overrides": {
      "equipment_clli": "test"
   },
   "templateOverrides": [
      {
         "templateId": "ac3b679ded6ec110f877d2f57b8acc29",
         "overrideTemplateId": "f9604efb54e18110f87749bbc4ad38d8"
      },
      {
         "templateId": "171c23dded6ec110f877d2f57b8acc33",
         "overrideTemplateId": "0f38e59187424110e14f64e73cbb35b4"
      }
   ]
}" \
--user 'username':'password'

応答本文。

"result": {
   "sys_id": "00598f0aed346259f388105f29f892c4"
}