識別および調整 API

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:198分
  • 識別 および調整 API は、識別および調整エンジン (IRE) を使用して、重複する構成アイテム (CI) の作成を最小限に抑え、 構成管理データベース (CMDB)の更新時に許可されたソースからの情報のみを受け入れることで CI 属性を調整するエンドポイントを提供します。

    この API を使用するには、ユーザーに itil または asset ロールが必要です。

    IRE の詳細については、「 識別および調整エンジン (IRE)」を参照してください。

    識別および調整 - POST /now/identifyreconcile

    指定されたペイロード (要求本文) に識別および調整ルールを適用して、構成アイテム (CI) を CMDB に挿入または更新します。CMDBを直接更新する代わりに、この API を使用します。

    識別および調整:POST /now/identifyreconcile/queryエンドポイントを使用して、データベースに変更をコミットせずにこのエンドポイントへのペイロードの送信をシミュレートします。

    拡張 IRE オプションを指定する必要がある場合は、代わりに 識別および調整:POST /now/identifyreconcile/enhanced エンドポイントを使用してください。拡張 IRE オプションの詳細については、「 識別および調整エンジン (IRE)」を参照してください。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/identifyreconcile

    デフォルト URL: /api/now/identifyreconcile

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 1. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 2. クエリパラメーター
    名前 説明
    sysparm_data_source CI 情報のソース。これは、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義された選択値のいずれかである必要があります。

    データタイプ:文字列

    デフォルト:不完全ペイロードテーブルに API ペイロードを挿入します。

    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    アイテム 作成または更新する CI のリスト。

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

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.className 必須です。作成または更新する CI のsys_class_name (クラス/テーブル名)。この値は、cmdb_ci_linux_server や cmdb_ci_win_server などの任意の CMDB テーブルにすることができます。

    データタイプ:文字列

    items.internal_id このペイロード内のこのアイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup 各オブジェクトがルックアップベースの識別レコードを記述するオブジェクトのアレイ。これらのレコードは、構成アイテム [cmdb_ci] テーブルへの参照を持つルックアップテーブルに基づいて、最上位の構成アイテムを識別するために使用されます。

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

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.lookup.className 必須です。作成または更新する CI のsys_class_name名またはクラス/テーブル名。この値は、cmdb_serial_number や cmdb_ci_network_adapter などの任意の CMDB クラス/テーブル、または非CMDB 階層クラスにすることができます。

    データタイプ:文字列

    items.lookup.internal_id このペイロード内のこのルックアップレコードの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.lookup.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.lookup.values このルックアップアイテムのフィールドを名前/値のペアとして記述するオブジェクト (名前はフィールド名)。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    items.related 識別されているトップレベル CI への参照を持つ関連テーブルに基づいて、各オブジェクトが作成または更新するアイテムレコードを記述するオブジェクトのアレイ。関連エントリ [cmdb_related_entry] テーブルのルールは、このアレイに含めることができるレコードのタイプを定義します。

    関連テーブルは、構成アイテム [cmdb_ci] テーブルを拡張する場合と拡張しない場合があります。これらのレコードは、構成アイテムを識別するためには使用されません。

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

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.related.className 必須です。作成または更新する関連アイテムのsys_class_name名またはクラス/テーブル名。

    データタイプ:文字列

    items.related.internal_id このペイロード内のこの関連アイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.related.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.related.sys_object_source_info.source_feed この関連アイテムを送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.related.sys_object_source_info.source_name 関連アイテム情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.related.sys_object_source_info.source_native_key 関連アイテムのソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.related.sys_object_source_info.source_recency_timestamp 関連アイテムがスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.related.values この関連アイテムに対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings 許可される更新のタイプを定義するパラメーターを含むオブジェクト。

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

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules IRE がペイロードアイテムのクラスに一致する再分類制限ルールの実行をスキップするかどうかを示すフラグ。
    有効な値:
    • true:ルールの実行をスキップします。
    • false:ルールを実行します。

    デフォルト値:false

    items.settings.updateWithoutDowngrade この CI で更新とダウングレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、ダウングレードは許可されていません。
    • false:アイテムの更新とダウングレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutSwitch この CI を更新でき、そのクラスを切り替えることができるかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、クラスの切り替えは許可されません。
    • false:アイテムの更新とクラスの切り替えの両方が許可されます。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutUpgrade この CI に対して更新とアップグレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、アップグレードは許可されていません。
    • false:アイテムの更新とアップグレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.sys_オブジェクト_ソース_情報 一意の CI ID を記述するオブジェクト。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.values この CI に対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    referenceItem ペイロード内の 2 つのアイテム間の参照のリスト。各参照アイテムの値は、クラスで定義された IRE ルールを使用して CI を識別する前に入力されます。

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

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    referenceItems.referenced 別のアイテムによって参照されているアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referencedBy 別のアイテムを参照するアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referenceField referencedByアイテムのクラス/テーブル内の参照フィールドの名前。

    データタイプ:文字列

    関連 ペイロードで定義されている 2 つのアイテム間の関係のリスト。
    このアレイ内のオブジェクトは、次の 2 つの形式のいずれかを使用できます。
    • このオブジェクトは、 parentchild の名前と値のペアを使用して 2 つのトップレベルのアイテム間の関係を (のみ) 定義できます。その値はペイロード items アレイのアイテムインデックスを表します。
    • このオブジェクトは、 parent_idchild_id のキー/値のペアを使用して、トップレベルアイテム、関連アイテム、ルックアップアイテムを含む任意の 2 つのアイテム間の関係を定義できます。その値はそれらのアイテムに定義された internal_id 値を表します。

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

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child 関係内の子を表す items アレイ内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.child_id 関係内の子アイテムの internal_id

    データタイプ:文字列

    relations.parent 関係内の親を表す items 配列内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.parent_id 関係内の親アイテムの internal_id

    データタイプ:文字列

    relations.sys_rel_source_info 関係のディスカバリーソース情報。非依存関係の場合、この情報は関係性ソース [sys_rel_source] テーブルにあります。

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

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name ディスカバリーソースの名前。

    デフォルト:API メソッドパラメーターで渡されたディスカバリーソース。

    relations.sys_rel_source_info.source_feed ディスカバリーソース内のサブディスカバリー/スキャンである任意の文字列。

    デフォルト:「UNKNOWN」は、テーブルでレコードを作成するときに [source_feed] 列に保存されsys_rel_source。

    relations.type 親アイテムと子アイテムの間に存在する関係のタイプ。これは、CI 関係性タイプ [cmdb_rel_type] テーブルの名前フィールド値である必要があります。

    データタイプ:文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    result クエリによって生成された結果のリスト。

    データタイプ:アレイ

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    result.additionalCommittedItems 挿入または更新するアレイ items 要求本文に含まれていない CI のリスト。

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

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    result.additionalCommittedItems.className この追加 CI のsys_class_name。

    データタイプ:文字列

    result.additionalCommittedItems.errorCount この追加 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedItems.errors この追加 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.errors.error この追加 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.errors.message この追加 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts この追加の CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.additionalCommittedItems.identificationAttempts.attemptResult この追加の CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.attributes この追加の CI 識別試行中に使用される CI ID エントリ属性のアレイ。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes この追加の CI 識別試行中に使用される CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.identifierName この追加の CI 識別の試行に使用される識別子ルール。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.searchOnTable この追加の CI 識別試行が検索されたテーブルの名前。

    データタイプ:文字列

    result.additionalCommittedItems.identifierEntrySysId この追加の CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.inputIndices この追加 CI に対応する要求本文 items アレイの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.additionalCommittedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedItems.mergedPayloads この追加 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedItems.operation この追加 CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:追加の CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:追加の CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.additionalCommittedItems.sysId 識別によってこの追加 CI のSys_idが見つかりました。

    注目の値: 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.warnings この追加 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.warnings.error この追加 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.warnings.message この追加 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.additionalCommittedRelations 要求本文に含まれていない依存関係 CI のリスト 挿入または更新する relations リスト。

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

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    result.additionalCommittedRelations.className この追加の依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.additionalCommittedRelations.errorCount この追加の依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedRelations.errors この追加の依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedRelations.errors.error この追加の依存関係性 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedRelations.errors.message この追加の依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedRelations.inputIndices この追加の依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.additionalCommittedRelations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds この追加の依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedRelations.operation この追加の依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • INSERT_AS_INCOMPLETE:依存関係性 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されます。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されます。
    • NO_CHANGE:依存関係 CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されます。

    データタイプ:文字列

    result.items 要求本文 items アレイに含まれる CI のリスト。

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

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルからの関連 CI のリスト (テーブル検索 CI)。

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

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.additionalRelatedItems.inputIndices この関連アイテムに対応する要求本文 items アレイの CI のインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds この関連アイテムの処理中に結合された、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId この関連 CI のSys_id。

    データタイプ:文字列

    result.items.className この CI のSys_class_name。

    データタイプ:文字列

    result.items.duplicateLookupIndices 同じ関連 CI を参照する items.lookup アレイ要素のインデックス値のアレイを含むオブジェクト。

    アレイ名は、指定された関連 CI を参照する要求本文 items.lookup アレイの最初の要素を示します。その値は、同じ関連 CI を参照する同じ配列からの追加要素のセットです。

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

    この例は、 items.lookup 配列の 2 番目の要素が、その配列の後の要素と同じ関連 CI を参照するケースを示しています。

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount この CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.items.errors この CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error この CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.items.errors.message この CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.items.identificationAttempts この CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult この CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.items.identificationAttempts.attributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName この CI 識別試行に使用される識別子ルール。

    データタイプ:文字列

    result.items.identificationAttempts.searchOnTable この CI 識別試行のために検索されたテーブルの名前。

    データタイプ:文字列

    result.items.identifierEntrySysId この CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.info アイテムの処理に関する追加情報のリスト。

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

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code スキップされた再分類タイプ。
    可能な値:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    result.items.info.message 再分類をスキップする理由に関する追加のインサイトを提供するメッセージ。

    データタイプ:文字列

    result.items.info.ruleSysId 一致した再分類制限ルールのSys_id。再分類制限ルールのために IRE が再分類をスキップする場合にのみ適用されます。ペイロードまたはグローバルフラグが原因で再分類がスキップされた場合、この値は空です。

    データタイプ:文字列

    result.items.inputIndices この CI に対応する要求本文 items アレイからの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.mergedPayloadIds この CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation この CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:CI は新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.items.relatedItems 要求本文 items.lookup アレイからの関連 CI のリスト (テーブル検索 CI)。

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

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.relatedItems.inputIndices この関連アイテムに対応する要求本文の itemsitems.lookup アレイからの CI およびルックアップアイテムのインデックス値のリスト。

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

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex 関連アイテムの CI 親に対応する要求本文 items アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.inputIndices.subIndex 関連アイテムに対応する要求本文 items.lookup アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.relatedItems.mergedPayloadIds 処理中にこの CI に結合された CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルのエントリーのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds 要求本文 items.lookup アレイからの関連アイテム (テーブルルックアップアイテム) のsys_id値のリスト。

    データタイプ:アレイ

    注目すべき値:
    • null:この関連アイテムのsys_idが特定されませんでした。
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId 識別によってこの CI のSys_idが見つかりました。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.warnings この CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error この CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.items.warnings.message この CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.logContextId このペイロードについて報告されたコンテキスト ID。

    データタイプ:文字列

    result.relations 要求本文 relations アレイからの依存関係 CI のリスト。

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

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    result.relations.className この依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.relations.errorCount この依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.relations.errors この依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error この依存関係 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.relations.errors.message この依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.relations.inputIndices この依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.relations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.relations.mergedPayloadIds この依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.relations.operation この依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されました。
    • INSERT_AS_INCOMPLETE:依存関係 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されました。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されました。
    • NO_CHANGE:依存関係 CI に対して操作は実行されませんでした。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されました。

    データタイプ:文字列

    result.relations.warnings この依存関係性 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error この依存関係性 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.relations.warnings.message この依存関係性 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    cURL 要求

    Linux サーバー (シリアル番号とネットワークアダプターの関連アイテムのルックアップを含む) と IP スイッチを含むペイロードを、それらの間に IP 接続依存関係がある状態で送信します。

    curl "https://instance.servicenow.com/api/now/identifyreconcile" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username:password" \
    --data '{ \
      "items": [{ \
        "className": "cmdb_ci_linux_server", \
        "values": { \
          "sys_class_name": "cmdb_ci_linux_server", \
          "name": "lnux101", \
          "host_name": "lnux101.servicenow.com", \
          "ip_address": "10.11.12.173", \
          "os_name": "Linux Red Hat" \
        }, \
        "lookup": [{ \
          "className": "cmdb_serial_number", \
          "values": { \
            "serial_number": "lnux101", \
            "serial_number_type": "uuid", \
            "valid": "true" \
          } \
        }, { \
          "className": "cmdb_ci_network_adapter", \
          "values": { \
            "name": "eth0", \
            "ip_address": "10.11.12.173", \
            "mac_address": "00:55:51:21:26:2f" \
          } \
        }] \
      }, { \
        "className": "cmdb_ci_ip_switch", \
        "values": { \
          "name": "IP-Switch-1", \
          "serial_number": "Switch23587", \
          "serial_number_type": "uuid" \
        } \
      }], \
      "relations": [{ \
        "parent": 0, \
        "child": 1, \
        "type": "IP Connection::IP Connection" \
      }]
    }'

    Linux サーバー CI は、ハードウェア [cmdb_ci_hardware] テーブルでその名前を検索するハードウェアルールによって識別され、Linux サーバー [cmdb_ci_linux_server] テーブルの既存の CI の更新として処理されます。同様に、IP スイッチはハードウェアルールによって識別され、ハードウェアテーブルでその名前を検索し、IP スイッチ [cmdb_ci_ip_switch] テーブルで既存の CI を更新します。最後に、サーバーとスイッチの間の IP 接続依存関係が新しいレコードとして CI 関係 [cmdb_rel_ci] テーブルに挿入されます。

    {
      "result": {
        "items": [{
          "className": "cmdb_ci_linux_server",
          "operation": "UPDATE",
          "sysId": "539747cac0a801640163e60735fbbf6e",
          "relatedSysIds": [null, null],
          "relatedItems": [{
            "markers": [],
            "inputIndices": [{
              "mainIndex": 0,
              "subIndex": 0
            }],
            "mergedPayloadIds": [],
            "className": "cmdb_serial_number"
          }, {
            "markers": [],
            "inputIndices": [{
              "mainIndex": 0,
              "subIndex": 1
            }],
            "mergedPayloadIds": [],
            "className": "cmdb_ci_network_adapter"
          }],
          "additionalRelatedItems": [],
          "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
          "identificationAttempts": [{
            "identifierName": "Hardware Rule",
            "attemptResult": "NO_MATCH",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "MATCHED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }],
          "markers": [],
          "inputIndices": [0],
          "mergedPayloadIds": [],
          "errorCount": 0
        }, {
          "className": "cmdb_ci_ip_switch",
          "operation": "UPDATE",
          "sysId": "304481257f701200bee45f19befa915b",
          "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
          "identificationAttempts": [{
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "NO_MATCH",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "MATCHED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }],
          "markers": [],
          "inputIndices": [1],
          "mergedPayloadIds": [],
          "errorCount": 0
        }],
        "additionalCommittedItems": [],
        "relations": [{
          "className": "cmdb_rel_ci",
          "operation": "INSERT",
          "markers": [],
          "inputIndices": [0],
          "mergedPayloadIds": [],
          "errorCount": 0
        }],
        "additionalCommittedRelations": []
      }
    }

    識別および調整:POST /now/identifyreconcile/enhanced

    指定されたペイロード (要求本文) に識別および調整ルールを適用して、構成アイテム (CI) を CMDB に挿入または更新します。CMDBを直接更新する代わりに、この API を使用します。

    識別および調整:POST /now/identifyreconcile/queryEnhancedエンドポイントを使用して、データベースに変更をコミットせずにこのエンドポイントへのペイロードの送信をシミュレートします。

    このメソッドは 識別および調整 - POST /now/identifyreconcile メソッドと似ていますが、次の機能が追加されています。
    • 部分的ペイロード
      • アイテムに警告またはエラーがある場合は、アイテム操作がINSERT_AS_PARTIALかINSERT_INCOMPLETEかを示します。
      • 既存の部分的ペイロードと結合された部分的ペイロードのsys_idsを返します。
    • ペイロードの重複排除機能をサポートします。
    • サマリーを生成します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/identifyreconcile/enhanced

    デフォルト URL: /api/now/identifyreconcile/enhanced

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 7. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 8. クエリパラメーター
    名前 説明
    オプション 要求に適用される拡張 IRE オプションを表す名前と値のペアのカンマ区切りリスト。

    たとえば、部分的ペイロード、部分コミット、重複排除ペイロード、およびサマリーの生成のデフォルト値を上書きするには 拡張 IRE オプション:

    partial_payloads:false,partial_commits:false,deduplicate_payloads:false,generate_summary:true
    注:
    デフォルトでは、または partial_payloads が true に設定されている場合、部分的ペイロード機能に不可欠な機能であるため、false に設定されていても、 partial_commitsdeduplicate_payloads の両方が有効になります。

    拡張 IRE オプションの詳細については、「 識別および調整エンジン (IRE)」を参照してください。

    名前と値のペアごとに有効な値:
    • true:この拡張 IRE オプションを有効にします。
    • false:この拡張 IRE オプションを無効にします。

    データタイプ:文字列

    sysparm_data_source CI 情報のソース。これは、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義された選択値のいずれかである必要があります。

    データタイプ:文字列

    デフォルト:不完全ペイロードテーブルに API ペイロードを挿入します。

    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    アイテム 作成または更新する CI のリスト。

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

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.className 必須です。作成または更新する CI のsys_class_name (クラス/テーブル名)。この値は、cmdb_ci_linux_server や cmdb_ci_win_server などの任意の CMDB テーブルにすることができます。

    データタイプ:文字列

    items.internal_id このペイロード内のこのアイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup 各オブジェクトがルックアップベースの識別レコードを記述するオブジェクトのアレイ。これらのレコードは、構成アイテム [cmdb_ci] テーブルへの参照を持つルックアップテーブルに基づいて、最上位の構成アイテムを識別するために使用されます。

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

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.lookup.className 必須です。作成または更新する CI のsys_class_name名またはクラス/テーブル名。この値は、cmdb_serial_number や cmdb_ci_network_adapter などの任意の CMDB クラス/テーブル、または非CMDB 階層クラスにすることができます。

    データタイプ:文字列

    items.lookup.internal_id このペイロード内のこのルックアップレコードの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.lookup.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.lookup.values このルックアップアイテムのフィールドを名前/値のペアとして記述するオブジェクト (名前はフィールド名)。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    items.related 識別されているトップレベル CI への参照を持つ関連テーブルに基づいて、各オブジェクトが作成または更新するアイテムレコードを記述するオブジェクトのアレイ。関連エントリ [cmdb_related_entry] テーブルのルールは、このアレイに含めることができるレコードのタイプを定義します。

    関連テーブルは、構成アイテム [cmdb_ci] テーブルを拡張する場合と拡張しない場合があります。これらのレコードは、構成アイテムを識別するためには使用されません。

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

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.related.className 必須です。作成または更新する関連アイテムのsys_class_name名またはクラス/テーブル名。

    データタイプ:文字列

    items.related.internal_id このペイロード内のこの関連アイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.related.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.related.sys_object_source_info.source_feed この関連アイテムを送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.related.sys_object_source_info.source_name 関連アイテム情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.related.sys_object_source_info.source_native_key 関連アイテムのソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.related.sys_object_source_info.source_recency_timestamp 関連アイテムがスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.related.values この関連アイテムに対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings 許可される更新のタイプを定義するパラメーターを含むオブジェクト。

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

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules IRE がペイロードアイテムのクラスに一致する再分類制限ルールの実行をスキップするかどうかを示すフラグ。
    有効な値:
    • true:ルールの実行をスキップします。
    • false:ルールを実行します。

    デフォルト値:false

    items.settings.updateWithoutDowngrade この CI で更新とダウングレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、ダウングレードは許可されていません。
    • false:アイテムの更新とダウングレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutSwitch この CI を更新でき、そのクラスを切り替えることができるかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、クラスの切り替えは許可されません。
    • false:アイテムの更新とクラスの切り替えの両方が許可されます。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutUpgrade この CI に対して更新とアップグレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、アップグレードは許可されていません。
    • false:アイテムの更新とアップグレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.sys_オブジェクト_ソース_情報 一意の CI ID を記述するオブジェクト。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.values この CI に対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    referenceItem ペイロード内の 2 つのアイテム間の参照のリスト。各参照アイテムの値は、クラスで定義された IRE ルールを使用して CI を識別する前に入力されます。

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

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    referenceItems.referenced 別のアイテムによって参照されているアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referencedBy 別のアイテムを参照するアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referenceField referencedByアイテムのクラス/テーブル内の参照フィールドの名前。

    データタイプ:文字列

    関連 ペイロードで定義されている 2 つのアイテム間の関係のリスト。
    このアレイ内のオブジェクトは、次の 2 つの形式のいずれかを使用できます。
    • このオブジェクトは、 parentchild の名前と値のペアを使用して 2 つのトップレベルのアイテム間の関係を (のみ) 定義できます。その値はペイロード items アレイのアイテムインデックスを表します。
    • このオブジェクトは、 parent_idchild_id のキー/値のペアを使用して、トップレベルアイテム、関連アイテム、ルックアップアイテムを含む任意の 2 つのアイテム間の関係を定義できます。その値はそれらのアイテムに定義された internal_id 値を表します。

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

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child 関係内の子を表す items アレイ内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.child_id 関係内の子アイテムの internal_id

    データタイプ:文字列

    relations.parent 関係内の親を表す items 配列内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.parent_id 関係内の親アイテムの internal_id

    データタイプ:文字列

    relations.sys_rel_source_info 関係のディスカバリーソース情報。非依存関係の場合、この情報は関係性ソース [sys_rel_source] テーブルにあります。

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

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name ディスカバリーソースの名前。

    デフォルト:API メソッドパラメーターで渡されたディスカバリーソース。

    relations.sys_rel_source_info.source_feed ディスカバリーソース内のサブディスカバリー/スキャンである任意の文字列。

    デフォルト:「UNKNOWN」は、テーブルでレコードを作成するときに [source_feed] 列に保存されsys_rel_source。

    relations.type 親アイテムと子アイテムの間に存在する関係のタイプ。これは、CI 関係性タイプ [cmdb_rel_type] テーブルの名前フィールド値である必要があります。

    データタイプ:文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。

    エラーメッセージの詳細「チャンク [...] は有効なエントリではありません」は、 options クエリパラメーターが正しい名前と値のペアの形式でないことを示します。

    たとえば、 options パラメーターに partial を指定すると、メッセージの詳細に「Chunk [partial] is not a valid entry」という 500 ステータスコードが生成されます。

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

    名前 説明
    result クエリによって生成された結果のリスト。

    データタイプ:アレイ

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    result.additionalCommittedItems 挿入または更新するアレイ items 要求本文に含まれていない CI のリスト。

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

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    result.additionalCommittedItems.className この追加 CI のsys_class_name。

    データタイプ:文字列

    result.additionalCommittedItems.errorCount この追加 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedItems.errors この追加 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.errors.error この追加 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.errors.message この追加 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts この追加の CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.additionalCommittedItems.identificationAttempts.attemptResult この追加の CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.attributes この追加の CI 識別試行中に使用される CI ID エントリ属性のアレイ。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes この追加の CI 識別試行中に使用される CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.identifierName この追加の CI 識別の試行に使用される識別子ルール。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.searchOnTable この追加の CI 識別試行が検索されたテーブルの名前。

    データタイプ:文字列

    result.additionalCommittedItems.identifierEntrySysId この追加の CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.inputIndices この追加 CI に対応する要求本文 items アレイの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.additionalCommittedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedItems.mergedPayloads この追加 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedItems.operation この追加 CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:追加の CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:追加の CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.additionalCommittedItems.sysId 識別によってこの追加 CI のSys_idが見つかりました。

    注目の値: 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.warnings この追加 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.warnings.error この追加 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.warnings.message この追加 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.additionalCommittedRelations 要求本文に含まれていない依存関係 CI のリスト 挿入または更新する relations リスト。

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

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    result.additionalCommittedRelations.className この追加の依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.additionalCommittedRelations.errorCount この追加の依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedRelations.errors この追加の依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedRelations.errors.error この追加の依存関係性 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedRelations.errors.message この追加の依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedRelations.inputIndices この追加の依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.additionalCommittedRelations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds この追加の依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedRelations.operation この追加の依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • INSERT_AS_INCOMPLETE:依存関係性 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されます。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されます。
    • NO_CHANGE:依存関係 CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されます。

    データタイプ:文字列

    result.items 要求本文 items アレイに含まれる CI のリスト。

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

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルからの関連 CI のリスト (テーブル検索 CI)。

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

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.additionalRelatedItems.inputIndices この関連アイテムに対応する要求本文 items アレイの CI のインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds この関連アイテムの処理中に結合された、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId この関連 CI のSys_id。

    データタイプ:文字列

    result.items.className この CI のSys_class_name。

    データタイプ:文字列

    result.items.duplicateLookupIndices 同じ関連 CI を参照する items.lookup アレイ要素のインデックス値のアレイを含むオブジェクト。

    アレイ名は、指定された関連 CI を参照する要求本文 items.lookup アレイの最初の要素を示します。その値は、同じ関連 CI を参照する同じ配列からの追加要素のセットです。

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

    この例は、 items.lookup 配列の 2 番目の要素が、その配列の後の要素と同じ関連 CI を参照するケースを示しています。

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount この CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.items.errors この CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error この CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.items.errors.message この CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.items.identificationAttempts この CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult この CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.items.identificationAttempts.attributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName この CI 識別試行に使用される識別子ルール。

    データタイプ:文字列

    result.items.identificationAttempts.searchOnTable この CI 識別試行のために検索されたテーブルの名前。

    データタイプ:文字列

    result.items.identifierEntrySysId この CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.info アイテムの処理に関する追加情報のリスト。

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

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code スキップされた再分類タイプ。
    可能な値:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    result.items.info.message 再分類をスキップする理由に関する追加のインサイトを提供するメッセージ。

    データタイプ:文字列

    result.items.info.ruleSysId 一致した再分類制限ルールのSys_id。再分類制限ルールのために IRE が再分類をスキップする場合にのみ適用されます。ペイロードまたはグローバルフラグが原因で再分類がスキップされた場合、この値は空です。

    データタイプ:文字列

    result.items.inputIndices この CI に対応する要求本文 items アレイからの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.mergedPayloadIds この CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation この CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:CI は新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.items.relatedItems 要求本文 items.lookup アレイからの関連 CI のリスト (テーブル検索 CI)。

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

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.relatedItems.inputIndices この関連アイテムに対応する要求本文の itemsitems.lookup アレイからの CI およびルックアップアイテムのインデックス値のリスト。

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

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex 関連アイテムの CI 親に対応する要求本文 items アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.inputIndices.subIndex 関連アイテムに対応する要求本文 items.lookup アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.relatedItems.mergedPayloadIds 処理中にこの CI に結合された CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルのエントリーのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds 要求本文 items.lookup アレイからの関連アイテム (テーブルルックアップアイテム) のsys_id値のリスト。

    データタイプ:アレイ

    注目すべき値:
    • null:この関連アイテムのsys_idが特定されませんでした。
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId 識別によってこの CI のSys_idが見つかりました。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.warnings この CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error この CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.items.warnings.message この CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.logContextId このペイロードについて報告されたコンテキスト ID。

    データタイプ:文字列

    result.relations 要求本文 relations アレイからの依存関係 CI のリスト。

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

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    result.relations.className この依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.relations.errorCount この依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.relations.errors この依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error この依存関係 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.relations.errors.message この依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.relations.inputIndices この依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.relations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.relations.mergedPayloadIds この依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.relations.operation この依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されました。
    • INSERT_AS_INCOMPLETE:依存関係 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されました。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されました。
    • NO_CHANGE:依存関係 CI に対して操作は実行されませんでした。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されました。

    データタイプ:文字列

    result.relations.warnings この依存関係性 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error この依存関係性 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.relations.warnings.message この依存関係性 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    cURL 要求

    コンピューター CI の部分的ペイロードを送信します。

    curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items" : [ \
        { \
          "className" : "cmdb_ci_computer", \
          "sys_object_source_info" : { \
            "source_name" : "ServiceNow", \
            "source_native_key" : "ncomputer3367" \
          }, \
          "values" : { \
            "cpu_core_count" : "6", \
            "ram" : "8192", \
            "manufacturer" : "DELL", \
            "company" : "My Company" \
          } \
        } \
      ] \
    }'

    応答は、ペイロードが CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されたことを示しています。

    {
      "result": {
        "items": [{
          "className": "cmdb_ci_computer",
          "operation": "INSERT_AS_PARTIAL",
          "sysId": "Unknown",
          "partialSysIds": ["1aec79151bb45010593876a61a4bcb28"],
          "identifierEntrySysId": "Unknown",
          "errors": [],
          "warnings": [{
            "error": "MISSING_MATCHING_ATTRIBUTES",
            "message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'"
          }],
          "identificationAttempts": [{
            "info": "sys_object_source NO_MATCH",
            "identifierName": "",
            "attemptResult": "NO_MATCH",
            "attributes": [],
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number", "serial_number_type"],
            "searchOnTable": "cmdb_serial_number",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["serial_number"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["name"],
            "searchOnTable": "cmdb_ci_hardware",
            "hybridEntryCiAttributes": []
          }, {
            "identifierName": "Hardware Rule",
            "attemptResult": "SKIPPED",
            "attributes": ["mac_address", "name"],
            "searchOnTable": "cmdb_ci_network_adapter",
            "hybridEntryCiAttributes": []
          }],
          "errorCount": 0,
          "markers": [],
          "warningCount": 1,
          "mergedPayloadIds": ["7ddcb9551bb45010593876a61a4bcb08"],
          "inputIndices": [0]
        }],
        "additionalCommittedItems": [],
        "relations": [],
        "additionalCommittedRelations": []
      }
    }

    サマリー生成の拡張 IRE オプションを有効にして、コンピューター CI の説明を完了する 2 番目の部分的ペイロードを送信します。

    curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced?options=generate_summary:true" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
    }'

    応答には、コンピューター CI が挿入されたことが示され、実行された操作の概要が表示されます。

    {
      "result": {
        "relations": [],
        "hasError": false,
        "additionalCommittedItems": [],
        "hasWarning": false,
        "items": [
          {
            "relatedSysIds": [
              "735c79151bb45010593876a61a4bcb67"
            ],
            "identifierEntrySysId": "Unknown",
            "sysId": "ff5c79151bb45010593876a61a4bcb64",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT",
            "relatedItems": [
              {
                "operation": "INSERT",
                "warningCount": 0,
                "errors": [],
                "sysId": "735c79151bb45010593876a61a4bcb67",
                "className": "cmdb_ci_network_adapter",
                "errorCount": 0,
                "markers": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "mergedPayloadIds": []
              }
            ],
            "mergedPayloadIds": [
              "fe4c39151bb45010593876a61a4bcbd3"
            ],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 0
          }
        ],
        "additionalCommittedRelations": [],
        "summary": {
          "cmdb_ci_network_adapter": {
            "mergedPartialPayloads": 0,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          },
          "cmdb_ci_computer": {
            "mergedPartialPayloads": 1,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          }
        }
      }
    }

    識別および調整:POST /now/identifyreconcile/query

    データベース内の操作をコミットせずに、指定されたペイロード (要求本文) で実行する CMDB 操作 (挿入/更新) を決定します。

    このエンドポイントを使用して、 識別および調整 - POST /now/identifyreconcile エンドポイントへのペイロード (要求本文) の送信をシミュレートします。

    拡張 IRE オプションを指定する必要がある場合は、代わりに 識別および調整:POST /now/identifyreconcile/enhanced エンドポイントを使用してください。拡張 IRE オプションの詳細については、「 識別および調整エンジン (IRE)」を参照してください。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/identifyreconcile/query

    デフォルト URL: /api/now/identifyreconcile/query

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 13. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 14. クエリパラメーター
    名前 説明
    sysparm_data_source CI 情報のソース。これは、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義された選択値のいずれかである必要があります。

    データタイプ:文字列

    デフォルト:不完全ペイロードテーブルに API ペイロードを挿入します。

    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    アイテム 作成または更新する CI のリスト。

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

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.className 必須です。作成または更新する CI のsys_class_name (クラス/テーブル名)。この値は、cmdb_ci_linux_server や cmdb_ci_win_server などの任意の CMDB テーブルにすることができます。

    データタイプ:文字列

    items.internal_id このペイロード内のこのアイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup 各オブジェクトがルックアップベースの識別レコードを記述するオブジェクトのアレイ。これらのレコードは、構成アイテム [cmdb_ci] テーブルへの参照を持つルックアップテーブルに基づいて、最上位の構成アイテムを識別するために使用されます。

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

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.lookup.className 必須です。作成または更新する CI のsys_class_name名またはクラス/テーブル名。この値は、cmdb_serial_number や cmdb_ci_network_adapter などの任意の CMDB クラス/テーブル、または非CMDB 階層クラスにすることができます。

    データタイプ:文字列

    items.lookup.internal_id このペイロード内のこのルックアップレコードの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.lookup.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.lookup.values このルックアップアイテムのフィールドを名前/値のペアとして記述するオブジェクト (名前はフィールド名)。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    items.related 識別されているトップレベル CI への参照を持つ関連テーブルに基づいて、各オブジェクトが作成または更新するアイテムレコードを記述するオブジェクトのアレイ。関連エントリ [cmdb_related_entry] テーブルのルールは、このアレイに含めることができるレコードのタイプを定義します。

    関連テーブルは、構成アイテム [cmdb_ci] テーブルを拡張する場合と拡張しない場合があります。これらのレコードは、構成アイテムを識別するためには使用されません。

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

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.related.className 必須です。作成または更新する関連アイテムのsys_class_name名またはクラス/テーブル名。

    データタイプ:文字列

    items.related.internal_id このペイロード内のこの関連アイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.related.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.related.sys_object_source_info.source_feed この関連アイテムを送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.related.sys_object_source_info.source_name 関連アイテム情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.related.sys_object_source_info.source_native_key 関連アイテムのソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.related.sys_object_source_info.source_recency_timestamp 関連アイテムがスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.related.values この関連アイテムに対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings 許可される更新のタイプを定義するパラメーターを含むオブジェクト。

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

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules IRE がペイロードアイテムのクラスに一致する再分類制限ルールの実行をスキップするかどうかを示すフラグ。
    有効な値:
    • true:ルールの実行をスキップします。
    • false:ルールを実行します。

    デフォルト値:false

    items.settings.updateWithoutDowngrade この CI で更新とダウングレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、ダウングレードは許可されていません。
    • false:アイテムの更新とダウングレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutSwitch この CI を更新でき、そのクラスを切り替えることができるかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、クラスの切り替えは許可されません。
    • false:アイテムの更新とクラスの切り替えの両方が許可されます。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutUpgrade この CI に対して更新とアップグレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、アップグレードは許可されていません。
    • false:アイテムの更新とアップグレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.sys_オブジェクト_ソース_情報 一意の CI ID を記述するオブジェクト。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.values この CI に対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    referenceItem ペイロード内の 2 つのアイテム間の参照のリスト。各参照アイテムの値は、クラスで定義された IRE ルールを使用して CI を識別する前に入力されます。

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

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    referenceItems.referenced 別のアイテムによって参照されているアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referencedBy 別のアイテムを参照するアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referenceField referencedByアイテムのクラス/テーブル内の参照フィールドの名前。

    データタイプ:文字列

    関連 ペイロードで定義されている 2 つのアイテム間の関係のリスト。
    このアレイ内のオブジェクトは、次の 2 つの形式のいずれかを使用できます。
    • このオブジェクトは、 parentchild の名前と値のペアを使用して 2 つのトップレベルのアイテム間の関係を (のみ) 定義できます。その値はペイロード items アレイのアイテムインデックスを表します。
    • このオブジェクトは、 parent_idchild_id のキー/値のペアを使用して、トップレベルアイテム、関連アイテム、ルックアップアイテムを含む任意の 2 つのアイテム間の関係を定義できます。その値はそれらのアイテムに定義された internal_id 値を表します。

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

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child 関係内の子を表す items アレイ内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.child_id 関係内の子アイテムの internal_id

    データタイプ:文字列

    relations.parent 関係内の親を表す items 配列内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.parent_id 関係内の親アイテムの internal_id

    データタイプ:文字列

    relations.sys_rel_source_info 関係のディスカバリーソース情報。非依存関係の場合、この情報は関係性ソース [sys_rel_source] テーブルにあります。

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

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name ディスカバリーソースの名前。

    デフォルト:API メソッドパラメーターで渡されたディスカバリーソース。

    relations.sys_rel_source_info.source_feed ディスカバリーソース内のサブディスカバリー/スキャンである任意の文字列。

    デフォルト:「UNKNOWN」は、テーブルでレコードを作成するときに [source_feed] 列に保存されsys_rel_source。

    relations.type 親アイテムと子アイテムの間に存在する関係のタイプ。これは、CI 関係性タイプ [cmdb_rel_type] テーブルの名前フィールド値である必要があります。

    データタイプ:文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    result クエリによって生成された結果のリスト。

    データタイプ:アレイ

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    result.additionalCommittedItems 挿入または更新するアレイ items 要求本文に含まれていない CI のリスト。

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

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    result.additionalCommittedItems.className この追加 CI のsys_class_name。

    データタイプ:文字列

    result.additionalCommittedItems.errorCount この追加 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedItems.errors この追加 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.errors.error この追加 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.errors.message この追加 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts この追加の CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.additionalCommittedItems.identificationAttempts.attemptResult この追加の CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.attributes この追加の CI 識別試行中に使用される CI ID エントリ属性のアレイ。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes この追加の CI 識別試行中に使用される CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.identifierName この追加の CI 識別の試行に使用される識別子ルール。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.searchOnTable この追加の CI 識別試行が検索されたテーブルの名前。

    データタイプ:文字列

    result.additionalCommittedItems.identifierEntrySysId この追加の CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.inputIndices この追加 CI に対応する要求本文 items アレイの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.additionalCommittedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedItems.mergedPayloads この追加 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedItems.operation この追加 CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:追加の CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:追加の CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.additionalCommittedItems.sysId 識別によってこの追加 CI のSys_idが見つかりました。

    注目の値: 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.warnings この追加 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.warnings.error この追加 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.warnings.message この追加 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.additionalCommittedRelations 要求本文に含まれていない依存関係 CI のリスト 挿入または更新する relations リスト。

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

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    result.additionalCommittedRelations.className この追加の依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.additionalCommittedRelations.errorCount この追加の依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedRelations.errors この追加の依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedRelations.errors.error この追加の依存関係性 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedRelations.errors.message この追加の依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedRelations.inputIndices この追加の依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.additionalCommittedRelations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds この追加の依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedRelations.operation この追加の依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • INSERT_AS_INCOMPLETE:依存関係性 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されます。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されます。
    • NO_CHANGE:依存関係 CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されます。

    データタイプ:文字列

    result.items 要求本文 items アレイに含まれる CI のリスト。

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

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルからの関連 CI のリスト (テーブル検索 CI)。

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

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.additionalRelatedItems.inputIndices この関連アイテムに対応する要求本文 items アレイの CI のインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds この関連アイテムの処理中に結合された、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId この関連 CI のSys_id。

    データタイプ:文字列

    result.items.className この CI のSys_class_name。

    データタイプ:文字列

    result.items.duplicateLookupIndices 同じ関連 CI を参照する items.lookup アレイ要素のインデックス値のアレイを含むオブジェクト。

    アレイ名は、指定された関連 CI を参照する要求本文 items.lookup アレイの最初の要素を示します。その値は、同じ関連 CI を参照する同じ配列からの追加要素のセットです。

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

    この例は、 items.lookup 配列の 2 番目の要素が、その配列の後の要素と同じ関連 CI を参照するケースを示しています。

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount この CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.items.errors この CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error この CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.items.errors.message この CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.items.identificationAttempts この CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult この CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.items.identificationAttempts.attributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName この CI 識別試行に使用される識別子ルール。

    データタイプ:文字列

    result.items.identificationAttempts.searchOnTable この CI 識別試行のために検索されたテーブルの名前。

    データタイプ:文字列

    result.items.identifierEntrySysId この CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.info アイテムの処理に関する追加情報のリスト。

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

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code スキップされた再分類タイプ。
    可能な値:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    result.items.info.message 再分類をスキップする理由に関する追加のインサイトを提供するメッセージ。

    データタイプ:文字列

    result.items.info.ruleSysId 一致した再分類制限ルールのSys_id。再分類制限ルールのために IRE が再分類をスキップする場合にのみ適用されます。ペイロードまたはグローバルフラグが原因で再分類がスキップされた場合、この値は空です。

    データタイプ:文字列

    result.items.inputIndices この CI に対応する要求本文 items アレイからの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.mergedPayloadIds この CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation この CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:CI は新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.items.relatedItems 要求本文 items.lookup アレイからの関連 CI のリスト (テーブル検索 CI)。

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

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.relatedItems.inputIndices この関連アイテムに対応する要求本文の itemsitems.lookup アレイからの CI およびルックアップアイテムのインデックス値のリスト。

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

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex 関連アイテムの CI 親に対応する要求本文 items アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.inputIndices.subIndex 関連アイテムに対応する要求本文 items.lookup アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.relatedItems.mergedPayloadIds 処理中にこの CI に結合された CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルのエントリーのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds 要求本文 items.lookup アレイからの関連アイテム (テーブルルックアップアイテム) のsys_id値のリスト。

    データタイプ:アレイ

    注目すべき値:
    • null:この関連アイテムのsys_idが特定されませんでした。
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId 識別によってこの CI のSys_idが見つかりました。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.warnings この CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error この CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.items.warnings.message この CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.logContextId このペイロードについて報告されたコンテキスト ID。

    データタイプ:文字列

    result.relations 要求本文 relations アレイからの依存関係 CI のリスト。

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

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    result.relations.className この依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.relations.errorCount この依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.relations.errors この依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error この依存関係 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.relations.errors.message この依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.relations.inputIndices この依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.relations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.relations.mergedPayloadIds この依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.relations.operation この依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されました。
    • INSERT_AS_INCOMPLETE:依存関係 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されました。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されました。
    • NO_CHANGE:依存関係 CI に対して操作は実行されませんでした。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されました。

    データタイプ:文字列

    result.relations.warnings この依存関係性 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error この依存関係性 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.relations.warnings.message この依存関係性 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    cURL 要求

    Linux サーバー (シリアル番号とネットワークアダプターの関連アイテムのルックアップを含む) と IP スイッチを含むペイロードの送信を、それら間の IP 接続関係とともにシミュレートします。

    curl "https://instance.servicenow.com/api/now/identifyreconcile/query" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items": [{ \
        "className": "cmdb_ci_linux_server", \
        "values": { \
          "sys_class_name": "cmdb_ci_linux_server", \
          "name": "lnux101", \
          "host_name": "lnux101.servicenow.com", \
          "ip_address": "10.11.12.173", \
          "os_name": "Linux Red Hat" \
        }, \
        "lookup": [{ \
          "className": "cmdb_serial_number", \
          "values": { \
            "serial_number": "lnux101", \
            "serial_number_type": "uuid", \
            "valid": "true" \
          } \
        }, { \
          "className": "cmdb_ci_network_adapter", \
          "values": { \
            "name": "eth0", \
            "ip_address": "10.11.12.173", \
            "mac_address": "00:55:51:21:26:2f" \
          } \
        }] \
      }, { \
        "className": "cmdb_ci_ip_switch", \
        "values": { \
          "name": "IP-Switch-1", \
          "serial_number": "Switch23587", \
          "serial_number_type": "uuid" \
        } \
      }], \
      "relations": [{ \
        "parent": 0, \
        "child": 1, \
        "type": "IP Connection::IP Connection" \
      }] \
    }'

    Linux サーバー CI は、ハードウェア [cmdb_ci_hardware] テーブルでその名前を検索するハードウェアルールによって識別され、Linux サーバー [cmdb_ci_linux_server] テーブルの既存の CI の更新として処理されます。同様に、IP スイッチはハードウェアルールによって識別され、ハードウェアテーブルでその名前を検索し、IP スイッチ [cmdb_ci_ip_switch] テーブルで既存の CI を更新します。最後に、サーバーとスイッチの間の IP 接続関係が新しいレコードとして CI 関係 [cmdb_rel_ci] テーブルに挿入されます。

    {
      "result": {
        "relations": [
          {
            "operation": "INSERT",
            "mergedPayloadIds": [],
            "className": "cmdb_rel_ci",
            "errorCount": 0,
            "markers": [],
            "inputIndices": [
              0
            ]
          }
        ],
        "items": [
          {
            "relatedSysIds": [
              null,
              null
            ],
            "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
            "sysId": "539747cac0a801640163e60735fbbf6e",
            "errorCount": 0,
            "markers": [],
            "identificationAttempts": [
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "MATCHED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              }
            ],
            "inputIndices": [
              0
            ],
            "additionalRelatedItems": [],
            "operation": "UPDATE",
            "relatedItems": [
              {
                "markers": [],
                "mergedPayloadIds": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "className": "cmdb_serial_number"
              },
              {
                "markers": [],
                "mergedPayloadIds": [],
                "inputIndices": [
                  {
                    "subIndex": 1,
                    "mainIndex": 0
                  }
                ],
                "className": "cmdb_ci_network_adapter"
              }
            ],
            "mergedPayloadIds": [],
            "className": "cmdb_ci_linux_server"
          },
          {
            "operation": "UPDATE",
            "identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
            "mergedPayloadIds": [],
            "sysId": "304481257f701200bee45f19befa915b",
            "identificationAttempts": [
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "MATCHED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              }
            ],
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_ip_switch",
            "inputIndices": [
              1
            ]
          }
        ],
        "additionalCommittedRelations": [],
        "additionalCommittedItems": []
      }
    }

    識別および調整:POST /now/identifyreconcile/queryEnhanced

    データベース内の操作をコミットせずに、指定されたペイロード (要求本文) で実行する CMDB 操作 (挿入/更新) を決定します。

    このエンドポイントを使用して、 識別および調整:POST /now/identifyreconcile/enhanced エンドポイントへのペイロード (要求本文) の送信をシミュレートします。

    このメソッドは 識別および調整:POST /now/identifyreconcile/query メソッドと似ていますが、次の機能が追加されています。
    • 部分的ペイロード
      • アイテムに警告またはエラーがある場合は、アイテム操作がINSERT_AS_PARTIALかINSERT_INCOMPLETEかを示します。
      • 既存の部分的ペイロードと結合された部分的ペイロードのsys_idsを返します。
    • ペイロードの重複排除機能をサポートします。
    • サマリーを生成します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/identifyreconcile/queryEnhanced

    デフォルト URL: /api/now/identifyreconcile/queryEnhanced

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 19. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 20. クエリパラメーター
    名前 説明
    オプション 要求に適用される拡張 IRE オプションを表す名前と値のペアのカンマ区切りリスト。

    たとえば、部分的ペイロード、部分コミット、重複排除ペイロード、およびサマリーの生成のデフォルト値を上書きするには 拡張 IRE オプション:

    partial_payloads:false,partial_commits:false,deduplicate_payloads:false,generate_summary:true
    注:
    デフォルトでは、または partial_payloads が true に設定されている場合、部分的ペイロード機能に不可欠な機能であるため、false に設定されていても、 partial_commitsdeduplicate_payloads の両方が有効になります。

    拡張 IRE オプションの詳細については、「 識別および調整エンジン (IRE)」を参照してください。

    名前と値のペアごとに有効な値:
    • true:この拡張 IRE オプションを有効にします。
    • false:この拡張 IRE オプションを無効にします。

    データタイプ:文字列

    sysparm_data_source CI 情報のソース。これは、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義された選択値のいずれかである必要があります。

    データタイプ:文字列

    デフォルト:不完全ペイロードテーブルに API ペイロードを挿入します。

    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    アイテム 作成または更新する CI のリスト。

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

    "items": [
      {
        "className": "String",
        "internal_id": "String",
        "lookup": [Array],
        "related": [Array],
        "settings": {Object},
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.className 必須です。作成または更新する CI のsys_class_name (クラス/テーブル名)。この値は、cmdb_ci_linux_server や cmdb_ci_win_server などの任意の CMDB テーブルにすることができます。

    データタイプ:文字列

    items.internal_id このペイロード内のこのアイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup 各オブジェクトがルックアップベースの識別レコードを記述するオブジェクトのアレイ。これらのレコードは、構成アイテム [cmdb_ci] テーブルへの参照を持つルックアップテーブルに基づいて、最上位の構成アイテムを識別するために使用されます。

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

    "lookup": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.lookup.className 必須です。作成または更新する CI のsys_class_name名またはクラス/テーブル名。この値は、cmdb_serial_number や cmdb_ci_network_adapter などの任意の CMDB クラス/テーブル、または非CMDB 階層クラスにすることができます。

    データタイプ:文字列

    items.lookup.internal_id このペイロード内のこのルックアップレコードの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.lookup.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.lookup.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.lookup.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.lookup.values このルックアップアイテムのフィールドを名前/値のペアとして記述するオブジェクト (名前はフィールド名)。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "ip_address": "String",
      "mac_address": "String",
      "serial_number": "String",
      "serial_number_type": "String",
      "valid": "String"
    }
    items.related 識別されているトップレベル CI への参照を持つ関連テーブルに基づいて、各オブジェクトが作成または更新するアイテムレコードを記述するオブジェクトのアレイ。関連エントリ [cmdb_related_entry] テーブルのルールは、このアレイに含めることができるレコードのタイプを定義します。

    関連テーブルは、構成アイテム [cmdb_ci] テーブルを拡張する場合と拡張しない場合があります。これらのレコードは、構成アイテムを識別するためには使用されません。

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

    "related": [
      {
        "className": "String",
        "internal_id": "String",
        "sys_object_source_info": {Object},
        "values": {Object}
      }
    ]
    items.related.className 必須です。作成または更新する関連アイテムのsys_class_name名またはクラス/テーブル名。

    データタイプ:文字列

    items.related.internal_id このペイロード内のこの関連アイテムの一意の識別子。任意の値にすることができますが、ペイロード内で一意である必要があります。

    データタイプ:文字列

    items.related.sys_オブジェクト_ソース_情報 指定されたデータソースの一意の CI ID を記述するオブジェクト。ソースが異なれば、同じ CI に対して名前と値のペアが異なる場合があります。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.related.sys_object_source_info.source_feed この関連アイテムを送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.related.sys_object_source_info.source_name 関連アイテム情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.related.sys_object_source_info.source_native_key 関連アイテムのソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.related.sys_object_source_info.source_recency_timestamp 関連アイテムがスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.related.values この関連アイテムに対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    items.settings 許可される更新のタイプを定義するパラメーターを含むオブジェクト。

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

    "settings": {
      "skipReclassificationRestrictionRules": Boolean,
      "updateWithoutDowngrade": Boolean,
      "updateWithoutSwitch": Boolean,
      "updateWithoutUpgrade": Boolean
    }
    items.settings.skipReclassificationRestrictionRules IRE がペイロードアイテムのクラスに一致する再分類制限ルールの実行をスキップするかどうかを示すフラグ。
    有効な値:
    • true:ルールの実行をスキップします。
    • false:ルールを実行します。

    デフォルト値:false

    items.settings.updateWithoutDowngrade この CI で更新とダウングレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、ダウングレードは許可されていません。
    • false:アイテムの更新とダウングレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutSwitch この CI を更新でき、そのクラスを切り替えることができるかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、クラスの切り替えは許可されません。
    • false:アイテムの更新とクラスの切り替えの両方が許可されます。

    データタイプ:ブーリアン

    デフォルト値:false

    items.settings.updateWithoutUpgrade この CI に対して更新とアップグレードの両方が許可されているかどうかを示すフラグ。
    有効な値:
    • true:アイテムを更新しますが、アップグレードは許可されていません。
    • false:アイテムの更新とアップグレードの両方が許可されています。

    データタイプ:ブーリアン

    デフォルト値:false

    items.sys_オブジェクト_ソース_情報 一意の CI ID を記述するオブジェクト。

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

    "sys_object_source_info": {
      "source_feed": "String",
      "source_name": "String",  
      "source_native_key": "String",
      "source_recency_timestamp": "String"
    }
    items.sys_object_source_info.source_feed この CI を送信するフィードを一意に識別する名前。ソースに複数のフィードを含めることができる場合に使用します。

    データタイプ:文字列

    items.sys_object_source_info.source_name CI 情報のデータソース。この値は、構成アイテム [cmdb_ci] テーブルの [discovery_source] フィールドに定義されている選択値のいずれかである必要があります。

    データタイプ:文字列

    items.sys_object_source_info.source_native_key CI のソースからの一意のキー/ID。アイテムに固有の任意の文字列を指定できます。

    データタイプ:文字列

    items.sys_object_source_info.source_recency_timestamp CI がスキャンされた UTC 日時。

    データタイプ:文字列

    形式:YYYY-MM-DD hh:mm:ss

    items.values この CI に対して名前/値のペアとして作成または更新するフィールドを記述するオブジェクト (名前はフィールド名)。参照フィールドの場合、値は参照sys_idである必要があります。

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

    フィールドの名前とタイプは、次のようなユーザーが選択したフィールドによって異なります。

    "values": {
      "host_name": "String",
      "ip_address": "String",
      "name": "String",
      "os_name": "String",
      "sys_class_name": "String"
    }
    referenceItem ペイロード内の 2 つのアイテム間の参照のリスト。各参照アイテムの値は、クラスで定義された IRE ルールを使用して CI を識別する前に入力されます。

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

    "referenceItems": [
      {
        "referenced": "String",
        "referencedBy": "String",
        "referenceField": "String"
      }
    ]
    referenceItems.referenced 別のアイテムによって参照されているアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referencedBy 別のアイテムを参照するアイテムに対して定義された internal_id

    データタイプ:文字列

    referenceItems.referenceField referencedByアイテムのクラス/テーブル内の参照フィールドの名前。

    データタイプ:文字列

    関連 ペイロードで定義されている 2 つのアイテム間の関係のリスト。
    このアレイ内のオブジェクトは、次の 2 つの形式のいずれかを使用できます。
    • このオブジェクトは、 parentchild の名前と値のペアを使用して 2 つのトップレベルのアイテム間の関係を (のみ) 定義できます。その値はペイロード items アレイのアイテムインデックスを表します。
    • このオブジェクトは、 parent_idchild_id のキー/値のペアを使用して、トップレベルアイテム、関連アイテム、ルックアップアイテムを含む任意の 2 つのアイテム間の関係を定義できます。その値はそれらのアイテムに定義された internal_id 値を表します。

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

    "relations": [
      {
        "child": Number,
        "parent": Number,
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    "relations": [
      {
        "child_id": "String",
        "parent_id": "String",
        "sys_rel_source_info": {Object},
        "type": "String"
      }
    ]
    relations.child 関係内の子を表す items アレイ内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.child_id 関係内の子アイテムの internal_id

    データタイプ:文字列

    relations.parent 関係内の親を表す items 配列内の CI オブジェクトの整数インデックス。

    データタイプ:数値

    relations.parent_id 関係内の親アイテムの internal_id

    データタイプ:文字列

    relations.sys_rel_source_info 関係のディスカバリーソース情報。非依存関係の場合、この情報は関係性ソース [sys_rel_source] テーブルにあります。

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

    "sys_rel_source_info": { 
      "source_name": "String", 
      "source_feed": "String" 
    } 
    relations.sys_rel_source_info.source_name ディスカバリーソースの名前。

    デフォルト:API メソッドパラメーターで渡されたディスカバリーソース。

    relations.sys_rel_source_info.source_feed ディスカバリーソース内のサブディスカバリー/スキャンである任意の文字列。

    デフォルト:「UNKNOWN」は、テーブルでレコードを作成するときに [source_feed] 列に保存されsys_rel_source。

    relations.type 親アイテムと子アイテムの間に存在する関係のタイプ。これは、CI 関係性タイプ [cmdb_rel_type] テーブルの名前フィールド値である必要があります。

    データタイプ:文字列

    ヘッダー

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

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

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。

    エラーメッセージの詳細「チャンク [...] は有効なエントリではありません」は、 options クエリパラメーターが正しい名前と値のペアの形式でないことを示します。

    たとえば、 options パラメーターに partial を指定すると、メッセージの詳細に「Chunk [partial] is not a valid entry」という 500 ステータスコードが生成されます。

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

    名前 説明
    result クエリによって生成された結果のリスト。

    データタイプ:アレイ

    "result": [
      "additionalCommittedItems": [Array],
      "additionalCommittedRelations": [Array],
      "items": [Array],
      "relations": [Array]
    ]
    result.additionalCommittedItems 挿入または更新するアレイ items 要求本文に含まれていない CI のリスト。

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

    "additionalCommittedItems": [
      {
        "className": "String",
        "errorCount": Number,
        "identificationAttempts": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloads": [Array],
        "operation": "String",
        "sysId": "String"
      }
    ]
    result.additionalCommittedItems.className この追加 CI のsys_class_name。

    データタイプ:文字列

    result.additionalCommittedItems.errorCount この追加 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedItems.errors この追加 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.errors.error この追加 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.errors.message この追加 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts この追加の CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.additionalCommittedItems.identificationAttempts.attemptResult この追加の CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.attributes この追加の CI 識別試行中に使用される CI ID エントリ属性のアレイ。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes この追加の CI 識別試行中に使用される CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.additionalCommittedItems.identificationAttempts.identifierName この追加の CI 識別の試行に使用される識別子ルール。

    データタイプ:文字列

    result.additionalCommittedItems.identificationAttempts.searchOnTable この追加の CI 識別試行が検索されたテーブルの名前。

    データタイプ:文字列

    result.additionalCommittedItems.identifierEntrySysId この追加の CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.inputIndices この追加 CI に対応する要求本文 items アレイの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.additionalCommittedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedItems.mergedPayloads この追加 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedItems.operation この追加 CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:追加の CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:追加の CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.additionalCommittedItems.sysId 識別によってこの追加 CI のSys_idが見つかりました。

    注目の値: 不明:この追加の CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.additionalCommittedItems.warnings この追加 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedItems.warnings.error この追加 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.additionalCommittedItems.warnings.message この追加 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.additionalCommittedRelations 要求本文に含まれていない依存関係 CI のリスト 挿入または更新する relations リスト。

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

    "additionalCommittedRelations": [
      {
        "className": "String",
        "operation": "String",
        "markers": [Array],
        "inputIndices": [Array],
        "mergedPayloadIds": [Array]
      }
    ]
    result.additionalCommittedRelations.className この追加の依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.additionalCommittedRelations.errorCount この追加の依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.additionalCommittedRelations.errors この追加の依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.additionalCommittedRelations.errors.error この追加の依存関係性 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.additionalCommittedRelations.errors.message この追加の依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.additionalCommittedRelations.inputIndices この追加の依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.additionalCommittedRelations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.additionalCommittedRelations.mergedPayloadIds この追加の依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.additionalCommittedRelations.operation この追加の依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されます。
    • INSERT_AS_INCOMPLETE:依存関係性 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されます。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されます。
    • NO_CHANGE:依存関係 CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されます。

    データタイプ:文字列

    result.items 要求本文 items アレイに含まれる CI のリスト。

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

    "items": [
      {
        "additionalRelatedItems": [Array],
        "className": "String",
        "duplicateLookupIndices": {Object},
        "errorCount": Number,
        "errors": [Array],
        "identificationAttempts": [Array],
        "identifierEntrySysId": "String",
        "info": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "relatedItems": [Array],
        "relatedSysIds": [Array],
        "sysId": "String",
        "warnings": [Array]
      }
    ]
    result.items.additionalRelatedItems CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルからの関連 CI のリスト (テーブル検索 CI)。

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

    "additionalRelatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.additionalRelatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.additionalRelatedItems.inputIndices この関連アイテムに対応する要求本文 items アレイの CI のインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
        Number
    ]
    result.items.additionalRelatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.additionalRelatedItems.mergedPayloadIds この関連アイテムの処理中に結合された、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.additionalRelatedItems.sysId この関連 CI のSys_id。

    データタイプ:文字列

    result.items.className この CI のSys_class_name。

    データタイプ:文字列

    result.items.duplicateLookupIndices 同じ関連 CI を参照する items.lookup アレイ要素のインデックス値のアレイを含むオブジェクト。

    アレイ名は、指定された関連 CI を参照する要求本文 items.lookup アレイの最初の要素を示します。その値は、同じ関連 CI を参照する同じ配列からの追加要素のセットです。

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

    この例は、 items.lookup 配列の 2 番目の要素が、その配列の後の要素と同じ関連 CI を参照するケースを示しています。

    "duplicateLookupIndices": [
      "2": [Array]
    ]
    result.items.errorCount この CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.items.errors この CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.errors.error この CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.items.errors.message この CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.items.identificationAttempts この CI を識別するために行われた試行のリスト。
    データタイプ:オブジェクトのアレイ
    "identificationAttempts": [
      {
        "attemptResult": "String",
        "attributes": [Array],
        "hybridEntryCiAttributes": [Array],
        "identiferName": "String",
        "searchOnTable": [Array]
      }
    ]
    result.items.identificationAttempts.attemptResult この CI 識別試行の結果。
    可能な値:
    • 一致:識別に成功しました。識別子ルールテーブルで、指定された属性と完全に一致する一意の CI が見つかりました。
    • MULTI_MATCH:エラーで識別に失敗しました。指定された属性と照合したときに、識別子ルールテーブルで重複 CI が見つかりました。
    • NO_MATCH:識別に失敗しました。指定された属性に一致する識別子ルールテーブルに CI が見つかりませんでした。
    • スキップ:識別は試行されませんでした。この識別子ルールテーブル検索に必要な属性が指定されていないため、ルールは適用されませんでした。

    データタイプ:文字列

    result.items.identificationAttempts.attributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "attributes": [
      "serial_number": "String",
      "serial_number_type": "String",
    ]
    result.items.identificationAttempts.hybridEntryCiAttributes この CI 識別試行中に使用された CI ID エントリ属性のリスト。

    データタイプ:アレイ

    属性の名前とタイプは、次のような要求本文データと使用中の識別子によって異なります。

    "hybridEntryCiAttributes": [
      "name": "String",
      "serial_number": "String"
    ]
    result.items.identificationAttempts.identifierName この CI 識別試行に使用される識別子ルール。

    データタイプ:文字列

    result.items.identificationAttempts.searchOnTable この CI 識別試行のために検索されたテーブルの名前。

    データタイプ:文字列

    result.items.identifierEntrySysId この CI を識別するために使用される識別子ルールのSys_id。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.info アイテムの処理に関する追加情報のリスト。

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

    "info": [
      {
        "code": "String",
        "message": "String",
        "ruleSysId": "String"
      }
    ]
    result.items.info.code スキップされた再分類タイプ。
    可能な値:
    • SKIPPED_CLASS_SWITCH
    • SKIPPED_CLASS_DOWNGRADE
    • SKIPPED_CLASS_UPGRADE
    result.items.info.message 再分類をスキップする理由に関する追加のインサイトを提供するメッセージ。

    データタイプ:文字列

    result.items.info.ruleSysId 一致した再分類制限ルールのSys_id。再分類制限ルールのために IRE が再分類をスキップする場合にのみ適用されます。ペイロードまたはグローバルフラグが原因で再分類がスキップされた場合、この値は空です。

    データタイプ:文字列

    result.items.inputIndices この CI に対応する要求本文 items アレイからの CI のインデックス値のリスト。

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

    "inputIndices": [
      {
        Number
      }
    ]
    result.items.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.mergedPayloadIds この CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.operation この CI に対して実行された操作。
    可能な値:
    • 削除:既存の CI がターゲットテーブルから削除されます。
    • INSERT:CI は新しいレコードとしてターゲットテーブルに挿入されます。
    • NO_CHANGE:CI に対して操作は実行されません。
    • 更新:ターゲットテーブルの既存の CI が更新されます。
    • UPDATE_WITH_DOWNGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより汎用的なクラス (先祖クラス) に変更されます。
    • UPDATE_WITH_SWITCH:ターゲットテーブルの既存の CI が更新され、そのクラスが先祖または子孫クラスではない別のクラスに変更されます。
    • UPDATE_WITH_UPGRADE:ターゲットテーブルの既存の CI が更新され、そのクラスがより特殊なクラス (子孫クラス) に変更されます。

    データタイプ:文字列

    result.items.relatedItems 要求本文 items.lookup アレイからの関連 CI のリスト (テーブル検索 CI)。

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

    "relatedItems": [
      {
        "className": "String",
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "sysId": "String"
      }
    ]
    result.items.relatedItems.className 関連アイテムのsys_class_name。

    データタイプ:文字列

    result.items.relatedItems.inputIndices この関連アイテムに対応する要求本文の itemsitems.lookup アレイからの CI およびルックアップアイテムのインデックス値のリスト。

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

    "inputIndices": [
      {
        "mainIndex": Number,
        "subIndex": Number
      }
    ]
    result.items.relatedItems.inputIndices.mainIndex 関連アイテムの CI 親に対応する要求本文 items アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.inputIndices.subIndex 関連アイテムに対応する要求本文 items.lookup アレイのインデックス値。

    データタイプ:数値

    result.items.relatedItems.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.items.relatedItems.mergedPayloadIds 処理中にこの CI に結合された CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルのエントリーのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.items.relatedSysIds 要求本文 items.lookup アレイからの関連アイテム (テーブルルックアップアイテム) のsys_id値のリスト。

    データタイプ:アレイ

    注目すべき値:
    • null:この関連アイテムのsys_idが特定されませんでした。
    "relatedSysIds": [
        Number,
        Number
    ]
    result.items.sysId 識別によってこの CI のSys_idが見つかりました。
    注目すべき値:
    • 不明:この CI の識別に失敗しました。詳細については、「errors」を参照してください。

    データタイプ:文字列

    result.items.warnings この CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.items.warnings.error この CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.items.warnings.message この CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    result.logContextId このペイロードについて報告されたコンテキスト ID。

    データタイプ:文字列

    result.relations 要求本文 relations アレイからの依存関係 CI のリスト。

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

    "relations": [
      {
        "className": "String",
        "errorCount": Number,
        "errors": [Array],
        "inputIndices": [Array],
        "markers": [Array],
        "mergedPayloadIds": [Array],
        "operation": "String",
        "warnings": [Array]
      }
    ]
    result.relations.className この依存関係 CI のsys_class_name。
    サポートされている値のみ:
    • cmdb_rel_ci:CI 関係テーブル。

    データタイプ:文字列

    result.relations.errorCount この依存関係 CI の処理中に発生したエラーの数。

    データタイプ:数値

    result.relations.errors この依存関係 CI の処理中に発生したエラーのリスト。

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

    "errors": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.errors.error この依存関係 CI の処理中に発生したエラーのタイプ。

    データタイプ:文字列

    result.relations.errors.message この依存関係性 CI の処理中にエラーメッセージが発生しました。

    データタイプ:文字列

    result.relations.inputIndices この依存関係 CI に対応する要求本文 relations アレイ内の依存関係 CI オブジェクトのインデックス値のリスト。

    データタイプ:アレイ

    "inputIndices": [
      Number
    ]
    result.relations.markers 内部使用のためのマーカー値のリスト。

    データタイプ:アレイ

    "markers": []
    result.relations.mergedPayloadIds この依存関係 CI の処理中に結合された CMDB IRE 部分的ペイロード [cmdb_ire_partial_payloads] テーブルの部分的ペイロードのsys_id値のリスト。

    データタイプ:アレイ

    "mergedPayloadIds": [
      "String"
    ]
    result.relations.operation この依存関係 CI に対して実行された操作。
    可能な値:
    • INSERT:依存関係 CI が新しいレコードとしてターゲットテーブルに挿入されました。
    • INSERT_AS_INCOMPLETE:依存関係 CI にエラーがあり、CMDB IRE 不完全ペイロード [cmdb_ire_incomplete_payloads] テーブルに挿入されました。
    • INSERT_AS_PARTIAL:依存関係 CI にエラーがあり、CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されました。
    • NO_CHANGE:依存関係 CI に対して操作は実行されませんでした。
    • 更新:ターゲットテーブルの既存の依存関係 CI が更新されました。

    データタイプ:文字列

    result.relations.warnings この依存関係性 CI の処理中に発生した警告のリスト。

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

    "warnings": [
      {
        "error": "String",
        "message": "String"
      }
    ]
    result.relations.warnings.error この依存関係性 CI の処理中に発生した警告のタイプ。

    データタイプ:文字列

    result.relations.warnings.message この依存関係性 CI の処理中に警告メッセージが表示されました。

    データタイプ:文字列

    cURL 要求

    コンピューター CI の部分的ペイロードの送信をシミュレートします。

    curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username":"password" \
    --data '{ \
      "items" : [ \
        { \
          "className" : "cmdb_ci_computer", \
          "sys_object_source_info" : { \
            "source_name" : "ServiceNow", \
            "source_native_key" : "ncomputer3367" \
          }, \
          "values" : { \
            "cpu_core_count" : "6", \
            "ram" : "8192", \
            "manufacturer" : "DELL", \
            "company" : "My Company" \
          } \
        } \
      ] \
    }'

    応答は、ペイロードが CMDB IRE 部分のペイロード [cmdb_ire_partial_payloads] テーブルに挿入されることを示しています。

    {
      "result": {
        "relations": [],
        "items": [
          {
            "identifierEntrySysId": "Unknown",
            "partialSysIds": [
              "1aec79151bb45010593876a61a4bcb28"
            ],
            "sysId": "Unknown",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT_AS_PARTIAL",
            "errors": [],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 1,
            "warnings": [
              {
                "message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'",
                "error": "MISSING_MATCHING_ATTRIBUTES"
              }
            ],
            "mergedPayloadIds": [
              "7ddcb9551bb45010593876a61a4bcb08"
            ]
          }
        ],
        "additionalCommittedRelations": [],
        "additionalCommittedItems": []
      }
    }

    サマリー生成の拡張 IRE オプションを有効にして、コンピューター CI の説明を完了する 2 番目の部分的ペイロードの送信をシミュレートします。

    curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced?options=generate_summary:true" \
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --user "username:password" \
    --data '{ \
    }'

    応答には、コンピューター CI が挿入されることが表示され、実行される操作の概要が表示されます。

    {
      "result": {
        "relations": [],
        "hasError": false,
        "additionalCommittedItems": [],
        "hasWarning": false,
        "items": [
          {
            "relatedSysIds": [
              "735c79151bb45010593876a61a4bcb67"
            ],
            "identifierEntrySysId": "Unknown",
            "sysId": "ff5c79151bb45010593876a61a4bcb64",
            "errorCount": 0,
            "markers": [],
            "className": "cmdb_ci_computer",
            "inputIndices": [
              0
            ],
            "operation": "INSERT",
            "relatedItems": [
              {
                "operation": "INSERT",
                "warningCount": 0,
                "errors": [],
                "sysId": "735c79151bb45010593876a61a4bcb67",
                "className": "cmdb_ci_network_adapter",
                "errorCount": 0,
                "markers": [],
                "inputIndices": [
                  {
                    "subIndex": 0,
                    "mainIndex": 0
                  }
                ],
                "mergedPayloadIds": []
              }
            ],
            "mergedPayloadIds": [
              "fe4c39151bb45010593876a61a4bcbd3"
            ],
            "identificationAttempts": [
              {
                "info": "sys_object_source NO_MATCH",
                "attemptResult": "NO_MATCH",
                "identifierName": "",
                "attributes": [],
                "hybridEntryCiAttributes": []
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number",
                  "serial_number_type"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_serial_number"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "serial_number"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "SKIPPED",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_hardware"
              },
              {
                "attemptResult": "NO_MATCH",
                "identifierName": "Hardware Rule",
                "attributes": [
                  "mac_address",
                  "name"
                ],
                "hybridEntryCiAttributes": [],
                "searchOnTable": "cmdb_ci_network_adapter"
              }
            ],
            "warningCount": 0
          }
        ],
        "additionalCommittedRelations": [],
        "summary": {
          "cmdb_ci_network_adapter": {
            "mergedPartialPayloads": 0,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          },
          "cmdb_ci_computer": {
            "mergedPartialPayloads": 1,
            "inserted": 1,
            "partial": 0,
            "warnings": 0,
            "incomplete": 0,
            "additionalInserted": 0,
            "unchanged": 0,
            "skipped": 0,
            "updated": 0,
            "errors": 0
          }
        }
      }
    }