{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":1051,"path":"api-reference/server-api-reference/c_IdentEngineScriptAPI.md","title":"IdentificationEngineScriptableApi - Global","bundle":null,"doc_type":null,"release":"australia","body":"\n# IdentificationEngineScriptableApi- Global\n\nThe IdentificationEngineScriptableApi uses the Identification and Reconciliation framework to minimize the creation of duplicate configuration items \\(CIs\\) and to reconcile CI attributes by only accepting information from authorized data sources when updating the Configuration Management Database \\(CMDB\\).\n\n**Parent Topic:**[Server API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/api-server.md)\n\n## IdentificationEngineScriptableApi - createOrUpdateCI\\(String source, String input\\)\n\nInserts or updates configuration items \\(CI\\) and non-Configuration Management Database \\(CMDB\\) CIs \\(classes not extending from cmdb\\_ci\\) in the CMDB based on identification and reconciliation rules. Use this API instead of updating the CMDB directly.\n\nYou must pass non-CMDB CIs as lookup or related items in the IRE payload. For additional information on non-CMDB table ingestion, see [IRE support for non-CMDB tables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire-support-non-cmdb-tables.md).\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ninput\n\n\n\nString\n\n\n\nRequired. Input payload. A JSON formatted string of configuration items to add or update. ```\n\"input\" { \n \"items\": [Array],\n \"referenceItems\": [Array],\n \"relations\": [Array]\n}\n```\n\n
\n\ninput.items\n\n\n\nArray of Objects\n\n\n\nItems to add or update.```\n\"items\": [\n { \n \"className\": \"String\",\n \"display_values\": {Object},\n \"internal_id\": \"String\",\n \"lookup\": [Array],\n \"related\": [Array],\n \"settings\": {Object},\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_ci\\_linux\\_server or cmdb\\_ci\\_win\\_server.\n\n
\n\ninput.items.display\\_values\n\n\n\nObject\n\n\n\nReference fields to create or update for this related item as name-value pairs, where the name is the field name and the value is the referenced display value. If you want to use the sys\\_id instead of the display value for reference fields, pass the information in the **input.items.lookup.values** parameter instead of in this parameter.Reference field names depend on the fields selected by the user, such as:\n\n ```\n\"display_values\": {\n \"model_id\": \"String\",\n \"location\": \"String\"\n}\n```\n\n
\n\ninput.items.internal\\_id\n\n\n\nString\n\n\n\nUnique item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup\n\n\n\nArray of Objects\n\n\n\nIdentifies the top-level item containing the lookup \\(lookup-based identification\\). These records are used to identify the configuration item based on a lookup table that has a reference back to cmdb\\_ci.For example:\n\n```\n\"lookup\": [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.lookup.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_serial\\_number or cmdb\\_ci\\_network\\_adapter.\n\n
\n\ninput.items.lookup.internal\\_id\n\n\n\nString\n\n\n\nUnique item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nUnique CI identifier for a specific source.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.lookup.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.items.related\n\n\n\nArray\n\n\n\nReference to the top-level item that contains the related list. Rules in the Related Entry \\[cmdb\\_related\\_entry\\] define what type of records can be in this array. These records are used to add items based on a related table that has a reference to the CI that is being identified. The related table may or may not extend cmdb\\_ci. These records are not used to identify the configuration item.\n\n```\n\"related\" [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.related.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_software\\_instance or cmdb\\_key\\_value.\n\n
\n\ninput.items.related.internal\\_id\n\n\n\nString\n\n\n\nUnique item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nUnique CI identifier for a specific source.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.related.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.items.settings\n\n\n\nObject\n\n\n\nParameters that define the types of updates that are permitted.```\n\"settings\": { \n \"skipReclassificationRestrictionRules\": Boolean, \n \"updateWithoutDowngrade\": Boolean, \n \"updateWithoutSwitch\": Boolean,\n \"updateWithoutUpgrade\": Boolean\n}\n```\n\n
\n\ninput.items.settings.skipReclassificationRestrictionRules\n\n\n\nBoolean\n\n\n\nFlag that indicates whether IRE should not run the Reclassification Restriction rule that matches the class for the payload item.Valid values:\n\n- true: Skip running the rule.\n- false: Run the rule.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutDowngrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and downgrade are both permitted for this item.Valid values:\n\n- true: Update the item but downgrade is not permitted.\n- false: Both item update and downgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutUpgrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and upgrade are both permitted for this item.Valid values:\n\n- true: Update the item but upgrade is not permitted.\n- false: Both item update and upgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutSwitch\n\n\n\nBoolean\n\n\n\nFlag that indicates whether the item can be updated and the class switched.Valid values:\n\n- true: Update the item but class switching is not permitted.\n- false: Both item update and class switching are permitted.\n\nDefault: false\n\n
\n\ninput.items.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nUnique CI identifier for a specific source.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.referenceItems\n\n\n\nArray of Objects\n\n\n\nList that define references between items in the input payload. The values of each reference item are populated before identifying a CI using the IRE rules defined on a class.```\n\"referenceItems\": [\n { \n \"referenced\": \"String\", \n \"referencedBy\": \"String\", \n \"referenceField\": \"String\" \n }\n]\n```\n\n
\n\ninput.referenceItems.referenced\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item being referenced by another item.\n\n
\n\ninput.referenceItems.referencedBy\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item that references another item.\n\n
\n\ninput.referenceItems.referenceField\n\n\n\nString\n\n\n\nName of the reference field in the class/table for the **referencedBy** item.\n\n
\n\ninput.relations\n\n\n\nArray of Objects\n\n\n\nList that specifies relationships between items in the input payload. An object in this array can use either of two formats.\n\n- The object can define a relationship between two top-level items \\(only\\) using **parent** and **child** name-value pairs, with values representing item indexes from the payload **items** array.\n\n ```\n\"relations\": [\n {\n \"child\": Number,\n \"parent\": Number,\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n- The object can define a relationship between any two items, including top-level, related, or lookup items, using **parent\\_id** and **child\\_id** key/value pairs, with values representing **internal\\_id** values defined for those items.\n\n ```\n\"relations\": [\n {\n \"child_id\": \"String\",\n \"parent_id\": \"String\",\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n\n
\n\ninput.relations.child\n\n\n\nNumber\n\n\n\nInteger index of the CI object in the **items** array that represents the child in the relationship \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.child\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the child item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\n\n\n\nNumber\n\n\n\nInteger index of the parent item in the **items** array \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the parent item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info\n\n\n\nObject\n\n\n\nDiscovery source information for the relationship. For non-dependency relationships, this information is saved in the Relationship Sources \\[sys\\_rel\\_source\\] table \\(not persisted for identifyCIEnhanced\\(\\) or identifyCI\\(\\) methods.\\)Data type: Object\n\n```\n\"sys_rel_source_info\": { \n \"source_name\": \"String\", \n \"source_feed\": \"String\" \n} \n```\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nDiscovery source name. Default: Discovery source passed in the API method parameter.\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nAny string that is a sub-discovery/scan within the discovery source. Default: 'UNKNOWN' is stored in the source\\_feed column when creating a record in sys\\_rel\\_source table.\n\n
\n\ninput.relations.type\n\n\n\nString\n\n\n\nType of relationship that exists between the parent and child items. This must be a name field value from the CI Relationship Type \\[cmdb\\_rel\\_type\\] table.\n\n
\n\nsource\n\n\n\nString\n\n\n\nIdentifies the data source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the cmdb\\_ci table.\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\n<String>\n\n\n\nJSON formatted string that is a list of results for the configuration items in the input string. Each result string is in the format  'items: \\[\\{\\}\\], relations:\\[\\{\\}\\]', where each item within the items and relations lists contains name-value pairs. Data type: String\n\n
\n\n<String>.additionalCommittedItems\n\n\n\nNo values are currently returned.\n\n
\n\n<String>.additionalCommittedRelations\n\n\n\nNo values are currently returned.\n\n
\n\n<String>.items\n\n\n\nDescription of the created or updated CIs.Data type: Object\n\n```\n\"items\": { \n \"additionalRelatedItems\": [Array],\n \"className\": \"String\",\n \"duplicateIndices\": [Array],\n \"errorCount\": Number,\n \"errors\": [Array],\n \"identificationAttempts\": [Array],\n \"identifierEntrySysId\": \"String\",\n \"info\": [Array],\n \"inputIndices\": [Array],\n \"maskedAttributes\": [Array],\n \"operation\": \"String\",\n \"relatedItems\": [Array],\n \"relatedSysIds\": [Array],\n \"sysId\": \"String\"\n}\n```\n\n
\n\n<String>.items.additionalRelatedItems\n\n\n\nList of information about additional lookup and related items that were processed but not provided as part of the input payload. These items are from partial payloads.This information is not currently returned.\n\nData type: Array of Objects\n\n```\n\"additionalRelatedItems\": [ \n {\n \"className\": \"String\", \n \"inputIndices\": [Array], \n \"operation\": \"String\",\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.additionalRelatedItems.inputIndices\n\n\n\nIndex of the corresponding input item. For top-level items, it is a list of integers. For related or lookup items, it is list of JSON objects.Data type: Array of Numbers or Array of Objects\n\n```\n\"inputIndices\": [\n { \n \"mainIndex\": Number, \n \"subIndex\": Number \n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems.inputIndices.mainIndex\n\n\n\nIndex value from the request body **items** array that corresponds to the CI parent of the additional related item. Data type: Number\n\n
\n\n<String>.items.additionalRelatedItems.inputIndices.subIndex\n\n\n\nIndex value from the request body **items.lookup** array that corresponds to the additional related item.Data type: Number\n\n
\n\n<String>.items.additionalRelatedItems.operation\n\n\n\nType of operation.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- NO\\_CHANGE: No CI changes were made.\n- UPDATE: Existing CI was updated.\n\nData type: String\n\n
\n\n<String>.items.additionalRelatedItems.sysId\n\n\n\nSys\\_id of the additional related items.Data type: String\n\n
\n\n<String>.items.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.duplicateIndices\n\n\n\nList of indexes of CIs that are duplicates of the current item.Data type: Array\n\n
\n\n<String>.items.errorCount\n\n\n\nNumber of errors.Data type: Number\n\n
\n\n<String>.items.errors\n\n\n\nList of errors encountered while processing this CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.errors.error\n\n\n\nType of error encountered while processing the CI.Data type: String\n\n
\n\n<String>.items.errors.message\n\n\n\nError message associated with the error.Data type: String\n\n
\n\n<String>.items.identificationAttempts\n\n\n\nList of attempts that were made to identify the CIs.Data type: Array of Objects\n\n```\n\"identificationAttempts\": [\n { \n \"attemptResult\": \"String\", \n \"attributes\": [Array],\n \"hybridEntryCiAttributes\": [Array],\n \"identifierName\": \"String\",\n \"searchOnTable\": \"String\" \n }\n]\n```\n\n
\n\n<String>.items.identificationAttempts.attemptResult\n\n\n\nResults of the attempt to identify the CI.Possible values:\n\n- MATCHED: Identification succeeded. A unique CI was found in the identifier rule table which exactly matched the specified attributes.\n- MULTI\\_MATCH: Identification failed with an error. Duplicate CIs were found in the identifier rule table when matching against the specified attributes.\n- NO\\_MATCH: Identification failed. No CI was found in the identifier rule table which matched the specified attributes.\n- SKIPPED: Identification not attempted. The attributes required for this identifier rule table search were not provided, so the rule was not applied.\n\nData type: String\n\n
\n\n<String>.items.identificationAttempts.attributes\n\n\n\nList of CI identifier entry attributes that were used during the identification process.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"attributes\": [\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n]\n```\n\n
\n\n<String>.items.identificationAttempts.hybridEntryCiAttributes\n\n\n\nNo values are currently returned.\n\n
\n\n<String>.items.identificationAttempts.identifierName\n\n\n\nIdentifier rule used for this CI identification attempt.Data type: String\n\n
\n\n<String>.items.identificationAttempts.searchOnTable\n\n\n\nName of the table searched during the identification process.Data type: String\n\n
\n\n<String>.items.identifierEntrySysId\n\n\n\nSys\\_id for the identifier rule used to identify the CI.Data type: String\n\nTable: Identifier Entry \\[cmdb\\_identifier\\_entry\\]\n\n
\n\n<String>.items.info\n\n\n\nList that contain additional information about the processing of the item.Data type: Array of Objects\n\n```\n\"info\": [\n {\n \"code\": \"String\",\n \"message\": \"String\",\n \"ruleSysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.info.code\n\n\n\nReclassification type that was skipped.Possible values:\n\n- SKIPPED\\_CLASS\\_SWITCH\n- SKIPPED\\_CLASS\\_DOWNGRADE\n- SKIPPED\\_CLASS\\_UPGRADE\n\nData type: String\n\n
\n\n<String>.items.info.message\n\n\n\nMessage that provides additional insights into the reason for skipping the reclassification.Data type: String\n\n
\n\n<String>.items.info.ruleSysId\n\n\n\nSys\\_id of the reclassification restriction rule that was matched. Applicable only when IRE skips reclassification due to reclassification restriction rule. This value is empty if the reclassification is skipped due to a payload or global flag.Data type: String\n\n
\n\n<String>.items.inputIndices\n\n\n\nIndex values for CIs from the request body **items** array that correspond to this CI.Data type: Array\n\n
\n\n<String>.items.maskedAttributes\n\n\n\nList of attributes whose update by a non-authoritative data source was skipped as defined by the [Reconciliation Rules](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/create-reconciliation-rule.md).Data type: Array\n\n
\n\n<String>.items.relatedItems\n\n\n\nList that provides information about the processed related items.Data type: Array of Objects\n\n```\n\"relatedItems\": [\n { \n \"className\": \"String\",\n \"errors\": [Array],\n \"errorCount\": Number, \n \"inputIndices\": [Array],\n \"operation\": \"String\",\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.errors\n\n\n\nList of errors that occurred during processing.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.errorCount\n\n\n\nNumber of errors detected during processing.Data type: Number\n\n
\n\n<String>.items.relatedItems.inputIndices\n\n\n\nIndexes of the corresponding related items.Data type: Array or Numbers\n\n```\n\"inputIndices\": [\n { \n \"mainIndex\": Number, \n \"subIndex\": Number \n }\n]\n```\n\n
\n\n<String>.items.relatedItems.inputIndices.mainIndex\n\n\n\nInteger value from the request body **items** array that corresponds to the CI parent of the related item.Data type: Number\n\n
\n\n<String>.items.relatedItems.inputIndices.subIndex\n\n\n\nInteger value from the request body **items.lookup** array that corresponds to the related item.Data type: Number\n\n
\n\n<String>.items.relatedItems.operation\n\n\n\nType of operation.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- NO\\_CHANGE: No CI changes were made.\n- UPDATE: Existing CI was updated.\n\nData type: String\n\n
\n\n<String>.items.relatedSysIds\n\n\n\nList of the sys\\_id values for related items \\(table lookup items\\) from the request body **items.lookup** array.Notable values - null: No sys\\_id was identified for this related item.\n\nData type: Array\n\n
\n\n<String>.items.sys\\_id\n\n\n\nSys\\_id of the CI that was updated or created.Data type: String\n\n
\n\n<String>.relations\n\n\n\nInformation about the processed relations.Data type: Array of Objects\n\n```\n\"relations\":[\n { \n \"className\": \"String\",\n \"errorCount\": Number,\n \"inputIndices\": [Array],\n \"operation\": \"String\",\n \"sysId\": \"String\" \n }\n]\n```\n\n
\n\n<String>.relations.className\n\n\n\nSys\\_class\\_name of this dependent relationship CI.Only supported value: cmdb\\_rel\\_ci: CI Relationship table.\n\nData type: String\n\n
\n\n<String>.relations.errorCount\n\n\n\nNumber of errors.Data type: Number\n\n
\n\n<String>.relations.inputIndices\n\n\n\nIndexes of the corresponding input relations.Data type: Array\n\n
\n\n<String>.relations.operation\n\n\n\nType of operation performed.Possible values:\n\n- INSERT\n- UPDATE\n- NO\\_CHANGE\n\nData type: String\n\n
\n\n<String>.relations.sysId\n\n\n\nSys\\_id of the dependent relationship CI.Data type: String\n\n
The following shows how to reclassify a configuration item.\n\n```\nvar payload = {\n \"items\": [\n {\n \"className\": \"cmdb_ci_win_server\",\n \"values\": {\n \"short_description\": \"Linux server description\",\n \"name\": \"Linux Server 1\"\n }\n }\n ]\n};\nvar input = new JSON().encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.createOrUpdateCI('ServiceNow', input);\ngs.print(output);\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_linux_server\",\n \"operation\": \"NO_CHANGE\",\n \"sysId\": \"440577800f321010150efc91ff767e94\",\n \"identifierEntrySysId\": \"556eb250c3400200d8d4bea192d3ae92\",\n \"identificationAttempts\": [\n {\n \"attributes\": [],\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"serial_number\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"name\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"MATCHED\",\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"info\": [\n {\n \"message\": \"CI Reclassification not allowed from class: [cmdb_ci_linux_server] to [cmdb_ci_win_server] by a reclassification restriction rule\",\n \"code\": \"SKIPPED_CLASS_SWITCH\",\n \"ruleSysId\": \"b3d4b3800f321010150efc91ff767eab\"\n }\n ],\n \"errorCount\": 0,\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ],\n \"mergedPayloadIds\": []\n }\n ],\n \"additionalCommittedItems\": [],\n \"relations\": [],\n \"additionalCommittedRelations\": []\n}\n```\n\n```\nvar payload = {\n\"items\": [\n{\n \"className\": \"cmdb_ci_win_server\", \n \"values\": {\n \"chassis_type\": \"Desktop\",\n \"os\": \"Windows 2012 R2 Datacenter\",\n \"name\": \"Windows2012Server1\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"cpu_count\": \"1\"\n },\n \"lookup\": [\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"serial_number_type\": \"bios\"\n },\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"3311-9736-4988-9744-1749-4183-41\",\n \"serial_number_type\": \"chassis\"\n },\n \"className\": \"cmdb_serial_number\"\n }],\n\n \"internal_id\": \"16777219\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"16777219\",\n \"source_recency_timestamp\": \"2019-10-18 08:31:23\"\n }},\n { \n \"className\": \"cmdb_ci_spkg\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter\",\n \"key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL\"\n },\n\n \"related\": [\n {\n \"internal_id\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter-SAMLABVM52\"\n },\n \"className\": \"cmdb_software_instance\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }}]}, \n {\n \"className\": \"cmdb_ci_app_server_tomcat\",\n \"values\": {\n \"running_process_key_parameters\": \"/opt/OV/nonOV/tomcat/b/temp org.apache.catalina.startup.Bootstrap start\",\n \"install_directory\": \"/opt/OV/nonOV/tomcat/b\",\n \"name\": \"Tomcat@hpom9:3443\",\n \"server_port\": \"8006\",\n \"sys_class_name\": \"cmdb_ci_app_server_tomcat\"\n },\n\n \"internal_id\": \"tomcat_id\"\n }],\n\n\"relations\": [\n {\n \"parent_id\": \"tomcat_id\",\n \"child_id\": \"16777219\",\n \"type\": \"Runs on::Runs\"\n }],\n\n\"referenceItems\": [\n {\n \"referenceField\": \"installed_on\",\n \"referenced\": \"16777219\",\n \"referencedBy\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }]};\n\nvar jsonUntil = new JSON();\nvar input = jsonUntil.encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.createOrUpdateCI('ServiceNow', input);\ngs.print(output);\n\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_win_server\",\n \"operation\": \"INSERT\",\n \"sysId\": \"d56ab6eadbd510102f67dfea5e96194e\",\n \"relatedSysIds\": [\n \"dd6af62adb1910102f67dfea5e96197f\",\n \"996af62adb1910102f67dfea5e961980\"\n ],\n \"relatedItems\": [\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"sysId\": \"dd6af62adb1910102f67dfea5e96197f\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 0\n }\n ],\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"sysId\": \"996af62adb1910102f67dfea5e961980\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 1\n }\n ],\n \"className\": \"cmdb_serial_number\"\n }\n ],\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source NO_MATCH\",\n \"identifierName\": \"\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"serial_number\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"mac_address\",\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_network_adapter\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ]\n },\n {\n \"className\": \"cmdb_ci_spkg\",\n \"operation\": \"INSERT\",\n \"sysId\": \"116af62adb1910102f67dfea5e961981\",\n \"relatedSysIds\": [\n \"6d6af62adb1910102f67dfea5e961984\"\n ],\n \"relatedItems\": [\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"sysId\": \"6d6af62adb1910102f67dfea5e961984\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 1,\n \"subIndex\": 0\n }\n ],\n \"className\": \"cmdb_software_instance\"\n }\n ],\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Software\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"key\"\n ],\n \"searchOnTable\": \"cmdb_ci_spkg\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 1\n ]\n },\n {\n \"className\": \"cmdb_ci_app_server_tomcat\",\n \"operation\": \"INSERT\",\n \"sysId\": \"e96af62adb1910102f67dfea5e961985\",\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 2\n ]\n }\n ],\n \"additionalCommittedItems\": [],\n \"relations\": [\n {\n \"className\": \"cmdb_rel_ci\",\n \"operation\": \"INSERT\",\n \"sysId\": \"e96af62adb1910102f67dfea5e961989\",\n \"identifierEntrySysId\": \"Unknown\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ]\n }\n ],\n \"additionalCommittedRelations\": []\n}\n```\n\nIdentify a dependent CI.\n\n```\nvar payload = \n {items: [ \n {className:'cmdb_ci_web_server', \n values: {name:'apache linux den 200', \n running_process_command: 'xyz', \n running_process_key_parameters: 'abc', \n tcp_port:'3452'}}, \n {className:'cmdb_ci_linux_server', \n values: {name:'lnux100', ram:'2048'}}],\n relations:[{parent: 0, child: 1, type: 'Runs on::Runs'}]\n };\n\nvar jsonUntil = new JSON();\nvar input = jsonUntil.encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.createOrUpdateCI('ServiceWatch', input);\ngs.print(output);\n\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_web_server\",\n \"operation\": \"INSERT\",\n \"sysId\": \"b9bb766adb1910102f67dfea5e961962\",\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n },\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ]\n },\n {\n \"className\": \"cmdb_ci_linux_server\",\n \"operation\": \"INSERT\",\n \"sysId\": \"a5bb766adb1910102f67dfea5e96195b\",\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"serial_number\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"mac_address\",\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_network_adapter\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 1\n ]\n }\n ],\n \"additionalCommittedItems\": [],\n \"relations\": [\n {\n \"className\": \"cmdb_rel_ci\",\n \"operation\": \"INSERT\",\n \"sysId\": \"fdbb766adb1910102f67dfea5e961964\",\n \"identifierEntrySysId\": \"Unknown\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ]\n }\n ],\n \"additionalCommittedRelations\": []\n}\n```\n\nIdentify an independent CI with lookup-based identification.\n\n```\nvar payload = {items: [\n {className:'cmdb_ci_netgear', \n values: {name:'ny8500-nbxs08',\n ports:'1200'}, \n lookup: [{className:'cmdb_serial_number',\n values:{serial_number:'1234ABCD', serial_number_type:'uuid',absent:'false',valid:'true'}},\n {className:'cmdb_serial_number',\n values:{serial_number:'3456EFGH', serial_number_type:'system',absent:'false',valid:'true'}}]}]};\n\nvar jsonUntil = new JSON();\nvar input = jsonUntil.encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.createOrUpdateCI('ServiceNow', input);\ngs.print(output);\n\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_netgear\",\n \"operation\": \"INSERT\",\n \"sysId\": \"787c7e6adb1910102f67dfea5e96196e\",\n \"relatedSysIds\": [\n \"f47c7e6adb1910102f67dfea5e961977\",\n \"3c7c7e6adb1910102f67dfea5e961977\"\n ],\n \"relatedItems\": [\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"sysId\": \"f47c7e6adb1910102f67dfea5e961977\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 0\n }\n ],\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"sysId\": \"3c7c7e6adb1910102f67dfea5e961977\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 1\n }\n ],\n \"className\": \"cmdb_serial_number\"\n }\n ],\n \"identifierEntrySysId\": \"Unknown\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [],\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"serial_number\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"mac_address\",\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_network_adapter\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [],\n \"warningCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ]\n }\n ],\n \"additionalCommittedItems\": [],\n \"relations\": [],\n \"additionalCommittedRelations\": []\n}\n```\n\n### Scoped equivalent\n\nTo use the createOrUpdateCI\\(String source, String input\\) method in a scoped application, use the corresponding scoped IdentificationEngine method: [createOrUpdateCI\\( String source, String input\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/IdentificationEngineScopedAPI.md).\n\n## IdentificationEngineScriptableApi - createOrUpdateCIEnhanced\\(String source, String input, Object options\\)\n\nInserts or updates configuration items \\(CI\\) and non-Configuration Management Database \\(CMDB\\) CIs \\(classes not extending from cmdb\\_ci\\) in the CMDB based on identification and reconciliation rules. Use this API instead of updating the CMDB directly.\n\nYou must pass non-CMDB CIs as lookup or related items in the IRE payload. For additional information on non-CMDB table ingestion, see [IRE support for non-CMDB tables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire-support-non-cmdb-tables.md).\n\nIn addition to providing the functionality of the createOrUpdateCI\\(\\) method, this method also supports:\n\n- Handling partial payloads\n- Handling partial commits\n- Removing duplicate items within a payload\n- Generating output summaries\n\nFor additional information on IRE and more detailed explanations of the data used by this method, see [Identification and Reconciliation \\(IRE\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire.md).\n\nFor additional information on non-CMDB table ingestion, see [IRE support for non-CMDB tables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire-support-non-cmdb-tables.md).\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ninput\n\n\n\nString\n\n\n\nRequired. Input payload. A JSON formatted string of configuration items to add or update. ```\n\"input\" { \n \"items\": [Array],\n \"referenceItems\": [Array],\n \"relations\": [Array]\n}\n```\n\n
\n\ninput.items\n\n\n\nArray of Objects\n\n\n\nItems to add or update.```\n\"items\": [\n { \n \"className\": \"String\",\n \"display_values\": {Object},\n \"internal_id\": \"String\",\n \"lookup\": [Array],\n \"related\": [Array],\n \"settings\": {Object},\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_ci\\_linux\\_server or cmdb\\_ci\\_win\\_server.\n\n
\n\ninput.items.display\\_values\n\n\n\nObject\n\n\n\nReference fields to create or update for this related item as name-value pairs, where the name is the field name and the value is the referenced display value. If you want to use the sys\\_id instead of the display value for reference fields, pass the information in the **input.items.lookup.values** parameter instead of in this parameter.Reference field names depend on the fields selected by the user, such as:\n\n ```\n\"display_values\": {\n \"model_id\": \"String\",\n \"location\": \"String\"\n}\n```\n\n
\n\ninput.items.internal\\_id\n\n\n\nString\n\n\n\nUnique item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup\n\n\n\nArray of Objects\n\n\n\nIdentifies the top-level item containing the lookup \\(lookup-based identification\\). These records are used to identify the configuration item based on a lookup table that has a reference back to cmdb\\_ci.For example:\n\n```\n\"lookup\": [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.lookup.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_serial\\_number or cmdb\\_ci\\_network\\_adapter.\n\n
\n\ninput.items.lookup.internal\\_id\n\n\n\nString\n\n\n\nUnique lookup item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nDefines a unique CI identifier for a specific data source. Different sources may have different name-value pairs for the same CI.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key-id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date/time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.lookup.values\n\n\n\nObject\n\n\n\nField information for the CI as name-value pairs, where the name is the field name. When updating reference fields, the value must be the referenced sys\\_id.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n \"valid\": \"String\",\n \"ip_address\": \"String\",\n \"mac_address\": \"String\"\n}\n```\n\n
\n\ninput.items.related\n\n\n\nArray of Objects\n\n\n\nReference to the top-level item that contains the related list. Rules in the Related Entry \\[cmdb\\_related\\_entry\\] define what type of records can be in this array. These records are used to add items based on a related table that has a reference to the CI that is being identified. The related table may or may not extend cmdb\\_ci. These records are not used to identify the configuration item.\n\n```\n\"related\" [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.related.className\n\n\n\nString\n\n
\n\ninput.items.related.internal\\_id\n\n\n\nString\n\n\n\nUnique identifier for this related item in this payload. Can be any value, but must be unique within the payload.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nObject that makes up a unique CI identifier for a specified data source. Different sources may have different name-value pairs for the same CI.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nIdentifies the data source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/ID from the source for the related item. The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: `YYYY-MM-DD hh:mm:ss`\n\n
\n\ninput.items.related.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.items.settings\n\n\n\nObject\n\n\n\nParameters that define the types of updates that are permitted.```\n\"settings\": { \n \"skipReclassificationRestrictionRules\": Boolean, \n \"updateWithoutDowngrade\": Boolean, \n \"updateWithoutSwitch\": Boolean,\n \"updateWithoutUpgrade\": Boolean\n}\n```\n\n
\n\ninput.items.settings.skipReclassificationRestrictionRules\n\n\n\nBoolean\n\n\n\nFlag that indicates whether IRE should not run the Reclassification Restriction rule that matches the class for the payload item.Valid values:\n\n- true: Skip running the rule.\n- false: Run the rule.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutDowngrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and downgrade are both permitted for this item.Valid values:\n\n- true: Update the item but downgrade is not permitted.\n- false: Both item update and downgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutSwitch\n\n\n\nBoolean\n\n\n\nFlag that indicates whether the item can be updated and the class switched.Valid values:\n\n- true: Update the item but class switching is not permitted.\n- false: Both item update and class switching are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutUpgrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and upgrade are both permitted for this item.Valid values:\n\n- true: Update the item but upgrade is not permitted.\n- false: Both item update and upgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nUnique CI identifier for a specific source.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.referenceItems\n\n\n\nArray of Objects\n\n\n\nList that define references between items in the input payload. The values of each reference item are populated before identifying a CI using the IRE rules defined on a class.```\n\"referenceItems\": [\n { \n \"referenced\": \"String\", \n \"referencedBy\": \"String\", \n \"referenceField\": \"String\" \n }\n]\n```\n\n
\n\ninput.referenceItems.referenced\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item being referenced by another item.\n\n
\n\ninput.referenceItems.referencedBy\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item that references another item.\n\n
\n\ninput.referenceItems.referenceField\n\n\n\nString\n\n\n\nName of the reference field in the class/table for the **referencedBy** item.\n\n
\n\ninput.relations\n\n\n\nArray of Objects\n\n\n\nList that specifies relationships between items in the input payload. An object in this array can use either of two formats.\n\n- The object can define a relationship between two top-level items \\(only\\) using **parent** and **child** name-value pairs, with values representing item indexes from the payload **items** array.\n\n ```\n\"relations\": [\n {\n \"child\": Number,\n \"parent\": Number,\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n- The object can define a relationship between any two items, including top-level, related, or lookup items, using **parent\\_id** and **child\\_id** key/value pairs, with values representing **internal\\_id** values defined for those items.\n\n ```\n\"relations\": [\n {\n \"child_id\": \"String\",\n \"parent_id\": \"String\",\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n\n
\n\ninput.relations.child\n\n\n\nNumber\n\n\n\nInteger index of the CI object in the **items** array that represents the child in the relationship \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.child\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the child item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\n\n\n\nNumber\n\n\n\nInteger index of the parent item in the **items** array \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the parent item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info\n\n\n\nObject\n\n\n\nDiscovery source information for the relationship. For non-dependency relationships, this information is saved in the Relationship Sources \\[sys\\_rel\\_source\\] table \\(not persisted for identifyCIEnhanced\\(\\) or identifyCI\\(\\) methods.\\)Data type: Object\n\n```\n\"sys_rel_source_info\": { \n \"source_name\": \"String\", \n \"source_feed\": \"String\" \n} \n```\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nDiscovery source name. Default: Discovery source passed in the API method parameter.\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nAny string that is a sub-discovery/scan within the discovery source. Default: 'UNKNOWN' is stored in the source\\_feed column when creating a record in sys\\_rel\\_source table.\n\n
\n\ninput.relations.type\n\n\n\nString\n\n\n\nType of relationship that exists between the parent and child items. This must be a name field value from the CI Relationship Type \\[cmdb\\_rel\\_type\\] table.\n\n
\n\noptions\n\n\n\nObject\n\n\n\nOptional, but \\{\\} or null must be passed-in. Options to enable or disable features.**Note:** By default or if **partial\\_payloads** is set to true, both **partial\\_commits** and **deduplicate\\_payloads** are enabled, even if they are set to false, as those features are essential for partial payloads functionality.\n\n```\n\"options\": { \n \"deduplicate_payloads\": Boolean,\n \"generate_summary\": Boolean, \n \"partial_commits\": Boolean, \n \"partial_payloads\": Boolean,\n \"skip_updating_last_scan_to_now\": Boolean,\n \"skip_updating_source_last_discovered_to_now\": Boolean\n}\n```\n\n
\n\noptions.deduplicate\\_payloads\n\n\n\nBoolean\n\n\n\nFlag that indicates whether duplicate items are merged or considered errors.Valid values:\n\n- true: Merge duplicate items.\n- false: Consider duplicate items as errors.\n\nDefault: true\n\n
\n\noptions.generate\\_summary\n\n\n\nBoolean\n\n\n\nFlag that indicates whether the returned results contain summary information. For the details of the returned summary information, see **<String>.summary** in the return results table.Valid values:\n\n- true: Include summary information.\n- false: Don't include summary information.\n\nDefault: false\n\n
\n\noptions.partial\\_commits\n\n\n\nBoolean\n\n\n\nFlag that indicates whether partial commit support is enabled. For additional information on partial commits, see [Enhanced IRE features](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire.md).Valid values:\n\n- true: Partial commit enabled.\n- false: Partial commit disabled.\n\nDefault: true\n\n
\n\noptions.partial\\_payloads\n\n\n\nBoolean\n\n\n\nFlag that indicates whether partial payload support is enabled. For additional information on partial payloads, see [Enhanced IRE features](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire.md) and [Create an IRE data source rule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/create-ire-data-source-rule.md).Valid values:\n\n- true: Partial payload enabled.\n- false: Partial payload disabled.\n\nDefault: true\n\n
\n\noptions.skip\\_updating\\_last\\_scan\\_to\\_now\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to skip updating the sys\\_object\\_source's last\\_scan time field.Valid values:\n\n- true: If the **source\\_recency\\_timestamp** parameter is not passed in**sys\\_object\\_source\\_info**, do not update the sys\\_object\\_source's last\\_scan time field.\n- false: Update the sys\\_object\\_source's last\\_scan time field.\n\nDefault: Uses the value in the glide.identification\\_engine.skip\\_updating\\_last\\_scan\\_to\\_now system property.\n\n
\n\noptions.skip\\_updating\\_source\\_last\\_discovered\\_to\\_now\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to skip updating the discovery\\_source and last\\_discovered fields in the Configuration Item \\[cmdb\\_ci\\] table.Valid values:\n\n- true: If last\\_discovered is not provided in the payload item values, do not update the discovery\\_source and last\\_discovered fields.\n- false: Update the discovery\\_source and last\\_discovered fields.\n\nDefault: Uses the value in the glide.identification\\_engine.skip\\_updating\\_source\\_last\\_discovered\\_to\\_now system property.\n\n
\n\nsource\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n
\n\nParameter\n\n\n\nDescription\n\n
\n\n<String>\n\n\n\nJSON formatted string that is a list of results for the configuration items in the input string.Data type: String\n\n```\n{ \n \"additionalCommittedItems\": [Array], \n \"additionalCommittedRelations\": [Array], \n \"hasError\": Boolean, \n \"hasWarning\": Boolean,\n \"items\": [Array], \n \"relations\": [Array], \n \"summary\": {Object} \n}\n```\n\n
\n\n<String>.additionalCommittedItems\n\n\n\nList of CIs that were committed during the IRE processing of the current payload, but were not present in the current input payload.Data type: Array of Objects\n\n```\n\"additionalCommittedItems\": [\n {\n \"className\": \"String\",\n \"errorCount\": Number,\n \"operation\": \"String\",\n \"identificationAttempts\": [Array],\n \"inputIndices\": [Array],\n \"markers\": [Array],\n \"mergedPayloads\": [Array],\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedItems.className\n\n\n\nSys\\_class\\_name of this additional CI.Data type: String\n\n
\n\n<String>.additionalCommittedItems.errorCount\n\n\n\nNumber of errors encountered while processing this additional CI.Data type: Number\n\n
\n\n<String>.additionalCommittedItems.errors\n\n\n\nArray of objects that describes errors encountered while processing this additional CI.Data type: Array\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedItems.errors.error\n\n\n\nType of error encountered while processing the additional CI.Data type: String\n\n
\n\n<String>.additionalCommittedItems.errors.message\n\n\n\nError message encountered while processing the additional CI.Data type: String\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts\n\n\n\nArray of objects in which each object describes an attempt made to identify this additional CI.Data type: Array of Objects\n\n```\n\"identificationAttempts\": [\n {\n \"attemptResult\": \"String\",\n \"attributes\": [Array],\n \"hybridEntryCiAttributes\": [Array],\n \"identiferName\": \"String\",\n \"searchOnTable\": [Array]\n }\n]\n```\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts.attemptResult\n\n\n\nOutcome of this additional CI identification attempt.Data type: String\n\nPossible values:\n\n- MATCHED: Identification succeeded. A unique CI was found in the identifier rule table which exactly matched the specified attributes.\n- MULTI\\_MATCH: Identification failed with an error. Duplicate CIs were found in the identifier rule table when matching against the specified attributes.\n- NO\\_MATCH: Identification failed. No CI was found in the identifier rule table which matched the specified attributes.\n- SKIPPED: Identification not attempted. The attributes required for this identifier rule table search were not provided, so the rule was not applied.\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts.attributes\n\n\n\nCI identifier entry attributes used during this additional CI identification attempt.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"attributes\": [\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n]\n```\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes\n\n\n\nArray of CI identifier entry attributes used during this additional CI identification attempt.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"hybridEntryCiAttributes\": [\n \"name\": \"String\",\n \"serial_number\": \"String\"\n]\n```\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts.identifierName\n\n\n\nIdentifier rule used for this additional CI identification attempt.Data type: String\n\n
\n\n<String>.additionalCommittedItems.identificationAttempts.searchOnTable\n\n\n\nName of the table searched for this additional CI identification attempt.Data type: String\n\n
\n\n<String>.additionalCommittedItems.identifierEntrySysId\n\n\n\nSys\\_id for the identifier rule used to identify this additional CI.Notable values - Unknown: Identification of this additional CI failed. See **errors** for details.\n\n
\n\n<String>.additionalCommittedItems.inputIndices\n\n\n\nIndex values for CIs from the request body **items** array that correspond to this additional CI.Data type: Array of Numbers\n\n```\n\"inputIndices\": [\n {\n Number\n }\n]\n```\n\n
\n\n<String>.additionalCommittedItems.markers\n\n\n\nMarker values for internal use.Data type: Array\n\n```\n\"markers\": []\n```\n\n
\n\n<String>.additionalCommittedItems.mergedPayloads\n\n\n\nSys\\_id values for partial payloads from the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table that were merged during processing of this additional CI.Data type: Array\n\n```\n\"mergedPayloadIds\": [\n \"String\"\n]\n```\n\n
\n\n<String>.additionalCommittedItems.operation\n\n\n\nOperation performed for this additional CI.Data type: String\n\nPossible values:\n\n- DELETE: An existing CI is removed from the target table.\n- INSERT: The additional CI is inserted into the target table as a new record.\n- NO\\_CHANGE: No operation is performed for the additional CI.\n- UPDATE: An existing CI in the target table is updated.\n- UPDATE\\_WITH\\_DOWNGRADE: An existing CI in the target table is updated and its class is changed to a more generic class \\(ancestor class\\).\n- UPDATE\\_WITH\\_SWITCH: An existing CI in the target table is updated and its class is changed to another class which is not an ancestor or descendent class.\n- UPDATE\\_WITH\\_UPGRADE: An existing CI in the target table is updated and its class is changed to a more specialized class \\(descendent class\\).\n\n
\n\n<String>.additionalCommittedItems.sysId\n\n\n\nSys\\_id found for this additional CI through identification.Data type: String\n\nNotable values - Unknown: Identification of this additional CI failed. See **errors** for details.\n\n
\n\n<String>.additionalCommittedItems.warnings\n\n\n\nDescription of warnings encountered while processing this additional CI.Data type: Array of Objects\n\n```\n\"warnings\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedItems.warnings.error\n\n\n\nType of warning encountered while processing this additional CI.Data type: String\n\n
\n\n<String>.additionalCommittedItems.warnings.message\n\n\n\nWarning message encountered while processing this additional CI.Data type: String\n\n
\n\n<String>.additionalCommittedRelations\n\n\n\nDescription of a dependent relationship CI that was not included in the request body **relations** list to insert or update.Data type: Array of Objects\n\n```\n\"additionalCommittedRelations\": [\n {\n \"className\": \"String\",\n \"inputIndices\": [Array],\n \"markers\": [Array],\n \"mergedPayloadIds\": [Array],\n \"operation\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedRelations.className\n\n\n\nThe sys\\_class\\_name of this additional dependent relationship CI.Data type: String\n\nOnly supported value: cmdb\\_rel\\_ci: The CI Relationship table.\n\n
\n\n<String>.additionalCommittedRelations.errorCount\n\n\n\nNumber of errors encountered while processing this additional dependent relationship CI.Data type: Number\n\n
\n\n<String>.additionalCommittedRelations.errors\n\n\n\nDescription of the errors encountered while processing this additional dependent relationship CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedRelations.errors.error\n\n\n\nType of error encountered while processing the additional dependent relationship CI.Data type: String\n\n
\n\n<String>.additionalCommittedRelations.errors.message\n\n\n\nError message encountered while processing this additional dependent relationship CI.Data type: String\n\n
\n\n<String>.additionalCommittedRelations.inputIndices\n\n\n\nIndex values for dependent relationship CI objects in the request body **relations** array that correspond to this additional dependent relationship CI.Data type: Array\n\n```\n\"inputIndices\": [\n Number\n]\n```\n\n
\n\n<String>.additionalCommittedRelations.markers\n\n\n\nMarker values for internal use.Data type: Array\n\n```\n\"markers\": []\n```\n\n
\n\n<String>.additionalCommittedRelations.mergedPayloadIds\n\n\n\nSys\\_id values for partial payloads from the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table that were merged for this CI.that were merged during processing of this additional dependent relationship CI.Data type: Array\n\n```\n\"mergedPayloadIds\": [\n \"String\"\n]\n```\n\n
\n\n<String>.additionalCommittedRelations.operation\n\n\n\nOperation that was performed for the additional dependent relationship CI.Possible values:\n\n- INSERT: The dependent relationship CI is inserted into the target table as a new record.\n- INSERT\\_AS\\_INCOMPLETE: The dependent relationship CI had errors and is inserted into the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.\n- INSERT\\_AS\\_PARTIAL: The dependent relationship CI had errors and is inserted into the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table.\n- NO\\_CHANGE: No operation is performed for the dependent relationship CI.\n- UPDATE: An existing dependent relationship CI in the target table is updated.\n\nData type: String\n\n
\n\n<String>.hasError\n\n\n\nFlag that indicates whether any item or relation has errors.Data type: Boolean\n\n
\n\n<String>.hasWarning\n\n\n\nFlag that indicates whether any item or relation has warnings.Data type: Boolean\n\n
\n\n<String>.items\n\n\n\nDescription of the created or updated CIs.Data type: Array of Objects\n\n```\n\"items\": [\n { \n \"additionalRelatedItems\": [Array],\n \"className\": \"String\",\n \"duplicateIndices\": [Array],\n \"errorCount\": Number, \n \"errors\": [Array], \n \"identificationAttempts\": [Array], \n \"identifierEntrySysId\": \"String\", \n \"incompleteSysIds\": \"String\",\n \"info\": [Array],\n \"inputIndices\": [Array], \n \"maskedAttributes\": [Array],\n \"operation\": \"String\", \n \"partialSysIds\": \"String\", \n \"relatedItems\": [Array], \n \"relatedSysIds\": [Array], \n \"sysId\": \"String\" \n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems\n\n\n\nInformation about additional lookup and related items that were processed but not provided as part of the input payload. These items are from partial payloads.Data type: Array of Objects\n\n```\n\"additionalRelatedItems\": [ \n {\n \"className\": \"String\", \n \"inputIndices\": [Array],\n \"mergedPayloadIds\": [Array], \n \"operation\": \"String\",\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.additionalRelatedItems.inputIndices\n\n\n\nIndex values for CIs from the request body **items** array that correspond to this related item.Data type: Array of Numbers\n\n
\n\n<String>.items.additionalRelatedItems.mergedPayloadIds\n\n\n\nList of sys\\_ids of the partial payloads that were merged into the related item.Data type: Array\n\nTable: CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\]\n\n
\n\n<String>.items.additionalRelatedItems.operation\n\n\n\nType of operation.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- NO\\_CHANGE: No CI changes were made.\n- UPDATE: Existing CI was updated.\n\nData type: String\n\n
\n\n<String>.items.additionalRelatedItems.sysId\n\n\n\nSys\\_id of the CI that was updated or created.Data type: String\n\n
\n\n<String>.items.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.duplicateIndices\n\n\n\nList of indexes of CIs that are duplicates of the current item.Data type: Array\n\n
\n\n<String>.items.errorCount\n\n\n\nNumber of errors encountered while processing the item.Data type: Number\n\n
\n\n<String>.items.errors\n\n\n\nList of errors encountered while processing this CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.errors.error\n\n\n\nType of error encountered while processing the CI.Data type: String\n\n
\n\n<String>.items.errors.message\n\n\n\nError message associated with the error.Data type: String\n\n
\n\n<String>.items.identificationAttempts\n\n\n\nList of attempts that were made to identify the CIs.Data type: Array of Objects\n\n```\n\"identificationAttempts\": [\n { \n \"attemptResult\": \"String\", \n \"attributes\": [Array],\n \"hybridEntryCiAttributes\": [Array],\n \"identifierName\": \"String\",\n \"searchOnTable\": \"String\" \n }\n]\n```\n\n
\n\n<String>.items.identificationAttempts.attemptResult\n\n\n\nResults of the attempt to identify the CI.Possible values:\n\n- MATCHED: Identification succeeded. A unique CI was found in the identifier rule table which exactly matched the specified attributes.\n- MULTI\\_MATCH: Identification failed with an error. Duplicate CIs were found in the identifier rule table when matching against the specified attributes.\n- NO\\_MATCH: Identification failed. No CI was found in the identifier rule table which matched the specified attributes.\n- SKIPPED: Identification not attempted. The attributes required for this identifier rule table search were not provided, so the rule was not applied.\n\nData type: String\n\n
\n\n<String>.items.identificationAttempts.attributes\n\n\n\nList of CI identifier entry attributes that were used during the identification process.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"attributes\": [\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n]\n```\n\n
\n\n<String>items.identificationAttempts.hybridEntryCiAttributes\n\n\n\nList of CI identifier entry attributes that were used during the identification process.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"hybridEntryCiAttributes\": [\n \"name\": \"String\",\n \"serial_number\": \"String\"\n]\n```\n\n
\n\n<String>.items.identificationAttempts.identifierName\n\n\n\nIdentifier rule used for this CI identification attempt.Data type: String\n\n
\n\n<String>.items.identificationAttempts.searchOnTable\n\n\n\nName of the table searched during the identification process.Data type: String\n\n
\n\n<String>.items.identifierEntrySysId\n\n\n\nSys\\_id for the identifier rule used to identify the CI.Data type: String\n\nTable: Identifier Entry \\[cmdb\\_identifier\\_entry\\]\n\n
\n\n<String>.items.incompleteSysIds\n\n\n\nIf the item had errors and was saved as an incomplete payload, this parameter contains the sys\\_id of the record in the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.Data type: String\n\n
\n\n<String>.items.info\n\n\n\nAdditional information about the processing of the item.Data type: Array of Objects\n\n```\n\"info\": [\n {\n \"code\": \"String\",\n \"message\": \"String\",\n \"ruleSysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.info.code\n\n\n\nReclassification type that was skipped.Possible values:\n\n- SKIPPED\\_CLASS\\_DOWNGRADE\n- SKIPPED\\_CLASS\\_SWITCH\n- SKIPPED\\_CLASS\\_UPGRADE\n\nData type: String\n\n
\n\n<String>.items.info.message\n\n\n\nMessage that provides additional insights into the reason for skipping the reclassification.Data type: String\n\n
\n\n<String>.items.info.ruleSysId\n\n\n\nSys\\_id of the reclassification restriction rule that was matched. Applicable only when IRE skips reclassification due to reclassification restriction rule. This value is empty if the reclassification is skipped due to a payload or global flag.Data type: String\n\n
\n\n<String>.items.inputIndices\n\n\n\nIndexes of the corresponding input CI. For top-level items, it is a list of integers. For related or lookup CIs, it is list of JSON objects.Data type: Array of Numbers\n\n
\n\n<String>.items.maskedAttributes\n\n\n\nList of attributes whose update by a non-authoritative data source was skipped as defined by the [Reconciliation Rules](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/create-reconciliation-rule.md).Data type: Array\n\n
\n\n<String>.items.operation\n\n\n\nOperation that took place.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- INSERT\\_AS\\_INCOMPLETE: Item was saved in cmdb\\_ire\\_incomplete\\_payloads table.\n- INSERT\\_AS\\_PARTIAL: Item was saved in cmdb\\_ire\\_partial\\_payloads table.\n- UPDATE: Existing CI was updated.\n- UPDATE\\_WITH\\_DOWNGRADE: CI was updated and the class changed to a more generic class \\(ancestor class\\).\n- UPDATE\\_WITH\\_SWITCH: CI was updated and the class changed to a class that is not ancestor or descendent.\n- UPDATE\\_WITH\\_UPDRADE: CI was updated and the class changed to a more specialized class \\(descendent class\\).\n\nData type: String\n\n
\n\n<String>.items.partialSysIds\n\n\n\nIf the item had errors and was saved as a partial payload, this parameter contains the sys\\_id of the partial payload record. Data type: String\n\n
\n\n<String>.items.relatedItems\n\n\n\nList of JSON objects that describe a related CI \\(table lookup CI\\) from the request body **items.lookup** array.Data type: Array of Objects\n\n```\n\"relatedItems\": [\n { \n \"className\": \"String\",\n \"errors\": [Array],\n \"errorCount\": Number, \n \"incompleteSysIds\": [Array],\n \"inputIndices\": [Array],\n \"mergePayloadIds\": [Array],\n \"operation\": \"String\",\n \"partialSysIds\": [Array], \n \"sysId\": \"String\",\n \"warningCount\": Number,\n \"warnings\": [Array]\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.errors\n\n\n\nList of errors that occurred during processing of the related item.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.errors.error\n\n\n\nType of error encountered while processing the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.errors.message\n\n\n\nError message associated with the error.Data type: String\n\n
\n\n<String>.items.relatedItems.errorCount\n\n\n\nNumber of errors detected while processing the related items.Data type: Number\n\n
\n\n<String>.items.relatedItems.incompleteSysIds\n\n\n\nIf the relation had errors and was saved as an incomplete payload, this value is the sys\\_id of the record in the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.Data type: String\n\n
\n\n<String>.items.relatedItems.inputIndices\n\n\n\nIndex of the corresponding input item. For top-level items, it is a list of integers. For related or lookup items, it is list of JSON objects.Data type: Array of Numbers or Array of Objects\n\n```\n\"inputIndices\": [\n { \n \"mainIndex\": Number, \n \"subIndex\": Number \n }\n]\n```\n\n
\n\n<String>.items.relatedItems.inputIndices.mainIndex\n\n\n\nIndex value from the request body **items** array that corresponds to the CI parent of the related item. Data type: Number\n\n
\n\n<String>.items.relatedItems.inputIndices.subIndex\n\n\n\nIndex value from the request body **items.lookup** array that corresponds to the related item.Data type: Number\n\n
\n\n<String>.items.relatedItems.mergedPayloadIds\n\n\n\nList of sys\\_ids of the partial payloads that were merged into the CI during processing.Data type: Array\n\n
\n\n<String>.items.relatedItems.operation\n\n\n\nOperation that took place.Possible values:\n\n- INSERT: New related CI was inserted into the database.\n- INSERT\\_AS\\_INCOMPLETE: Item was saved in cmdb\\_ire\\_incomplete\\_payloads table.\n- INSERT\\_AS\\_PARTIAL: Item was saved in cmdb\\_ire\\_partial\\_payloads table.\n- NO\\_CHANGE: No related CI changes were made.\n- UPDATE: Existing related CI was updated.\n- UPDATE\\_WITH\\_DOWNGRADE: Related CI was updated and the class changed to a more generic class \\(ancestor class\\).\n- UPDATE\\_WITH\\_SWITCH: Related CI was updated and the class changed to a class that is not ancestor or descendent.\n- UPDATE\\_WITH\\_UPDRADE: Related CI was updated and the class changed to a more specialized class \\(descendent class\\).\n\nData type: String\n\n
\n\n<String>.items.relatedItems.partialSysIds\n\n\n\nIf the related item had errors and was saved as a partial payload, this contains a list of the sys\\_ids of the associated records in the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table.Data type: Array\n\n
\n\n<String>.items.relatedItems.sysId\n\n\n\nSys\\_id of the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.warningCount\n\n\n\nNumber of warnings encountered when processing the related items.Data type: Number\n\n
\n\n<String>.items.relatedItems.warnings\n\n\n\nDescription of warnings encountered while processing the related items.Data type: Array of Objects\n\n```\n\"warnings\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.warnings.error\n\n\n\nType of warning encountered while processing the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.warnings.message\n\n\n\nMessage associated with the warning.Data type: String\n\n
\n\n<String>.items.relatedSysIds\n\n\n\nList of the sys\\_id values of the CIs used during lookup-based identification of related items.Data type: String\n\n
\n\n<String>.items.sys\\_id\n\n\n\nSys\\_id of the CI that was updated or created.Data type: String\n\n
\n\n<String>.relations\n\n\n\nDescription of a dependent relationship CI from the request body **relations** array.Data type: Array of Objects\n\n```\n\"relations\": [ \n { \n \"className\": \"String\",\n \"errorCount\": Number,\n \"errors\": [Array],\n \"incompleteSysIds\": \"String\",\n \"inputIndices\": [Array],\n \"operation\": \"String\",\n \"partialSysIds\": \"String\",\n \"sysId\": \"String\" \n }\n]\n```\n\n
\n\n<String>.relations.className\n\n\n\nSys\\_class\\_name of this dependent relationship CI.Only supported value: cmdb\\_rel\\_ci: CI Relationship table.\n\nData type: String\n\n
\n\n<String>.relations.errorCount\n\n\n\nNumber of errors encountered when processing the dependent relationship CI.Data type: Number\n\n
\n\n<String>.relations.errors\n\n\n\nList that describes errors that were encountered while processing this dependent relationship CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.relations.errors.error\n\n\n\nType of error encountered while processing the dependent relationship CI.Data type: String\n\n
\n\n<String>.relations.errors.message\n\n\n\nError message encountered while processing this dependent relationship CI.Data type: String\n\n
\n\n<String>.relations.incompleteSysIds\n\n\n\nIf the relation had errors and was saved as an incomplete payload, this value is the sys\\_id of the record in the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.Data type: String\n\n
\n\n<String>.relations.inputIndices\n\n\n\nIndexes for the dependent relationship CI objects in the request body **relations** array that correspond to this dependent relationship CI.Data type: Array\n\n
\n\n<String>.relations.operation\n\n\n\nType of operation performed.Possible values:\n\n- INSERT: The dependent relationship CI was inserted into the target table as a new record.\n- INSERT\\_AS\\_INCOMPLETE: The dependent relationship CI had errors and was inserted into the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.\n- INSERT\\_AS\\_PARTIAL: The dependent relationship CI had errors and was inserted into the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table.\n- NO\\_CHANGE: No operation was performed.\n- UPDATE: An existing dependent relationship CI in the target table was updated.\n\nData type: String\n\n
\n\n<String>.relations.partialSysIds\n\n\n\nIf the relation had errors and was saved as a partial payload, this value is the sys\\_id of the record in the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table.Data type: String\n\n
\n\n<String>.relations.sysId\n\n\n\nSys\\_id of the dependent relationship CI.Data type: String\n\n
\n\n<String>.summary\n\n\n\nList of JSON properties that provide statistics on how many items were inserted, updated, and such, per class.Data type: Array\n\n
\n\n<String>.summary.<class\\_name>\n\n\n\nStatistics for a specific class.Data type: Object\n\n```\n: {\n \"additionalInsertedItemCount\": Number, \n \"errorCount\": Number,\n \"incompleteItemCount\": Number,\n \"insertedItemCount\": Number,\n \"partialItemCount\": Number,\n \"skippedItemCount\": Number,\n \"unchangedItemCount\": Number,\n \"updatedItemCount\": Number,\n \"warningCount\": Number \n}\n```\n\n
\n\n<String>.summary.<class\\_name>.additionalInsertedItemCount\n\n\n\nNumber of items inserted due to processing of partial payloads.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.errorCount\n\n\n\nNumber of errors encounter when processing items.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.incompleteItemCount\n\n\n\nNumber of items inserted in the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.insertedItemCount\n\n\n\nNumber of items created.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.partialItemCount\n\n\n\nNumber of items saved in the Partial Payload table \\[cmdb\\_ire\\_partial\\_payloads\\].Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.skippedItemCount\n\n\n\nNumber of items that were skipped.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.unchangedItemCount\n\n\n\nNumber of items that had entries but were not modified.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.updatedItemCount\n\n\n\nNumber of items updated.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.warningCount\n\n\n\nNumber of items that generated a warning when processed.Data type: Number\n\n
Identify a dependent CI.\n\n```\nvar payload = {\n\"items\": [\n{\n \"className\": \"cmdb_ci_win_server\", \n \"values\": {\n \"chassis_type\": \"Desktop\",\n \"os\": \"Windows 2012 R2 Datacenter\",\n \"name\": \"Windows2012Server1\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"cpu_count\": \"1\"\n },\n \"lookup\": [\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"serial_number_type\": \"bios\"\n },\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"3311-9736-4988-9744-1749-4183-41\",\n \"serial_number_type\": \"chassis\"\n },\n \"className\": \"cmdb_serial_number\"\n }],\n\n \"internal_id\": \"16777219\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"16777219\",\n \"source_recency_timestamp\": \"2019-10-18 08:31:23\"\n }},\n { \n \"className\": \"cmdb_ci_spkg\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter\",\n \"key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL\"\n },\n\n \"related\": [\n {\n \"internal_id\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter-SAMLABVM52\"\n },\n \"className\": \"cmdb_software_instance\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }}] \n \"settings\" : {\n \"skipReclassificationRestrictionRules\" : \"false\",\n \"updateWithoutDowngrade\" : \"true\",\n \"updateWithoutUpgrade\" : \"true\",\n \"updateWithoutSwitch\" : \"true\"\n }}, \n {\n \"className\": \"cmdb_ci_app_server_tomcat\",\n \"values\": {\n \"running_process_key_parameters\": \"/opt/OV/nonOV/tomcat/b/temp org.apache.catalina.startup.Bootstrap start\",\n \"install_directory\": \"/opt/OV/nonOV/tomcat/b\",\n \"name\": \"Tomcat@hpom9:3443\",\n \"server_port\": \"8006\",\n \"sys_class_name\": \"cmdb_ci_app_server_tomcat\"\n },\n\n \"internal_id\": \"tomcat_id\"\n }],\n\n\"relations\": [\n {\n \"parent_id\": \"tomcat_id\",\n \"child_id\": \"16777219\",\n \"type\": \"Runs on::Runs\"\n }],\n\n\"referenceItems\": [\n {\n \"referenceField\": \"installed_on\",\n \"referenced\": \"16777219\",\n \"referencedBy\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }]};\n\nvar input = new JSON().encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.createOrUpdateCIEnhanced('ServiceNow', input, {});\n```\n\nOutput:\n\n```\n{\n\n\"items\": [\n{\n \"className\": \"cmdb_ci_win_server\",\n \"operation\": \"NO_CHANGE\",\n \"sysId\": \"65d873d2b3a0001028f6eae2c6a8dc2a\",\n \"relatedSysIds\": [\n \"a1d873d2b3a0001028f6eae2c6a8dc32\",\n \"a1d873d2b3a0001028f6eae2c6a8dc33\"\n],\n\n\"relatedItems\": [\n{\n \"className\": \"cmdb_serial_number\",\n \"sysId\": \"a1d873d2b3a0001028f6eae2c6a8dc32\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 0\n }]\n},\n \"className\": \"cmdb_serial_number\",\n \"sysId\": \"a1d873d2b3a0001028f6eae2c6a8dc33\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 1\n }]\n}],\n\n\"additionalRelatedItems\": [],\n\"identificationAttempts\": [],\n\"errorCount\": 0,\n\"inputIndices\": [0]\n},\n{\n\"className\": \"cmdb_ci_spkg\",\n\"operation\": \"NO_CHANGE\",\n\"sysId\": \"c764e971b320001028f6eae2c6a8dc44\",\n\n\"relatedSysIds\": [\n \"8b64e971b320001028f6eae2c6a8dc47\"\n],\n\"relatedItems\": [\n {\n \"className\": \"cmdb_software_instance\",\n \"sysId\": \"8b64e971b320001028f6eae2c6a8dc47\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 1,\n \"subIndex\": 0\n }]\n }],\n\n\"additionalRelatedItems\": [],\n\"identifierEntrySysId\": \"a52a87c03746220006b216a543990e8c\",\n\"identificationAttempts\": [\n {\n \"attributes\": [\n \"key\"\n ],\n \"identifierName\": \"Software\",\n \"attemptResult\": \"MATCHED\",\n \"searchOnTable\": \"cmdb_ci_spkg\",\n \"hybridEntryCiAttributes\": []\n }],\n\n\"errorCount\": 0,\n\"inputIndices\": [1]\n},\n\n{\n\"className\": \"cmdb_ci_app_server_tomcat\",\n\"operation\": \"INSERT\",\n\"sysId\": \"6f29f3d2b3a0001028f6eae2c6a8dcc6\",\n\"identifierEntrySysId\": \"Unknown\",\n\"identificationAttempts\": [\n{\n \"attributes\": [\n \"install_directory\",\n \"running_process_key_parameters\",\n \"sys_class_name\"\n ],\n\"identifierName\": \"Tomcat\",\n\"attemptResult\": \"NO_MATCH\",\n\"searchOnTable\": \"cmdb_ci_app_server_tomcat\",\n\"hybridEntryCiAttributes\": []\n},\n{\n\"attributes\": [\n \"cl_port\",\n \"sys_class_name\"\n],\n\"identifierName\": \"Application Rule\",\n\"attemptResult\": \"SKIPPED\",\n\"searchOnTable\": \"cmdb_ci_appl\",\n\"hybridEntryCiAttributes\": []\n},\n{\n\"attributes\": [\n \"running_process_command\",\n \"running_process_key_parameters\",\n \"sys_class_name\"\n],\n\"identifierName\": \"Application Rule\",\n\"attemptResult\": \"NO_MATCH\",\n\"searchOnTable\": \"cmdb_ci_appl\",\n\"hybridEntryCiAttributes\": []\n}\n],\n\n\"errorCount\": 0,\n\"inputIndices\": [2]\n}\n],\n\"additionalCommittedItems\": [],\n\"relations\": [\n{\n \"className\": \"cmdb_rel_ci\",\n \"operation\": \"INSERT\",\n \"sysId\": \"6729f3d2b3a0001028f6eae2c6a8dcc9\",\n \"errorCount\": 0,\n \"inputIndices\": [0]\n}],\n\"additionalCommittedRelations\": []\n}\n```\n\n## IdentificationEngineScriptableApi - identifyCI\\(String jsonString\\)\n\nDetermines the operation \\(insert/update\\) to perform with the specified payload without committing the operation in the database.\n\n**Note:** If your identification rules are configured to do so, this method can also ingest non-CMDB tables. For additional information on non-CMDB table ingestion, see [IRE support for non-CMDB tables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire-support-non-cmdb-tables.md).\n\nThis works just like createOrUpdateCI\\(\\), but does not commit the result.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\njsonString\n\n\n\nString\n\n\n\nA JSON formatted string of configuration items to be added or updated. Each input string is in the format  'items: \\[\\{\\}\\], relations:\\[\\{\\}\\]', where each item within the items and relations lists contains name-value pairs. The possible name-value pairs within the items list are:\n\n- className: Sys\\_class\\_name of the CI to be created or updated.\n- lookup:\\[\\{\\}\\]: List of records with each item having name-value pairs like the items list.\n- values:\\{\\}: Field information for the CI as name-value pairs, where the name is the field name.\n\nPossible name-value pairs within the relations list are:\n\n- child: Index of the child item in the dependency relation\n- parent: Index of the parent item in the dependency relation\n- type: Relationship type. This is one of the name field values from the cmdb\\_rel\\_type table.\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\nString\n\n\n\nA JSON formatted string that is a list of results. Each result string is in the format  'items: \\[\\{\\}\\], relations:\\[\\{\\}\\]', where each item within the items and relations lists contains name-value pairs. The possible name-value pairs within the items list are:\n\n- className: Sys\\_class\\_name for the CI that was updated or created.\n- duplicateIndices: List of indexes of items that are duplicates of the current item.\n- errors: List of errors in the format of \\(error, message string\\)\n- identificationAttempts: List of attempts.\n - attemptResult: One of SKIPPED, NO\\_MATCH, MATCHED, MULTI\\_MATCH.\n - attributes: Attributes of identifier entry used during identification.\n - identiferName: CI identifier to which this identifier entry belongs.\n - searchOnTable: Table searched during the identification process.\n- identifierEntrySysId: Sys\\_id of identifier entry used during matching.\n- operation: Operation to perform, which is one of the following:\n - DELETE\n - INSERT\n - UPDATE\n - UPDATE\\_WITH\\_DOWNGRADE\n - UPDATE\\_WITH\\_SWITCH\n - UPDATE\\_WITH\\_UPGRADE\n- relatedSysIds: List of sys\\_id values of CIs used during lookup based identification.\n- sysId: Sys\\_id of the CI that was updated or created.\n\nPossible name-value pairs within the relations list are:\n\n- className: Relationship CI's class name and is always cmdb\\_rel\\_ci\n- operation: Type of operation: INSERT, UPDATE, NO\\_CHANGE\n- sysId: Sys\\_id of the relationship CI inserted or updated\n\n
Identify an independent CI with lookup-based identification.\n\n```\nvar payload = {items: [\n {className:'cmdb_ci_netgear', \n values: {name:'ny8500-nbxs08',\n ports:'1200'}, \n lookup: [{className:'cmdb_serial_number',\n values:{serial_number:'1234ABCD', serial_number_type:'uuid',absent:'false',valid:'true'}},\n {className:'cmdb_serial_number',\n values:{serial_number:'3456EFGH', serial_number_type:'system',absent:'false',valid:'true'}}]}]};\n\nvar jsonUntil = new JSON();\nvar input = jsonUntil.encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.identifyCI(input);\ngs.print(output);\n\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_netgear\",\n \"operation\": \"UPDATE\",\n \"sysId\": \"55b35562c0a8010e01cff22378e0aea9\",\n \"relatedSysIds\": [\n null,\n null\n ],\n \"relatedItems\": [\n {\n \"errors\": [\n \n ],\n \"operation\": \"INSERT\",\n \"info\": [\n \n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [\n \n ],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 0\n }\n ],\n \"warningCount\": 0,\n \"markers\": [\n \n ],\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"errors\": [\n \n ],\n \"operation\": \"INSERT\",\n \"info\": [\n \n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [\n \n ],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 1\n }\n ],\n \"warningCount\": 0,\n \"markers\": [\n \n ],\n \"className\": \"cmdb_serial_number\"\n }\n ],\n \"identifierEntrySysId\": \"556eb250c3400200d8d4bea192d3ae92\",\n \"identificationAttempts\": [\n {\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"source_name\",\n \"source_native_key\"\n ],\n \"searchOnTable\": \"sys_object_source\",\n \"hybridEntryCiAttributes\": [\n \n ]\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": [\n \n ]\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"attributes\": [\n \"serial_number\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": [\n \n ]\n },\n {\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"MATCHED\",\n \"attributes\": [\n \"name\"\n ],\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": [\n \n ]\n }\n ],\n \"info\": [\n \n ],\n \"errorCount\": 0,\n \"mergedPayloadIds\": [\n \n ],\n \"inputIndices\": [\n 0\n ],\n \"warningCount\": 0,\n \"markers\": [\n \n ]\n }\n ],\n \"additionalCommittedItems\": [\n \n ],\n \"relations\": [\n \n ],\n \"additionalCommittedRelations\": [\n \n ],\n \"hasError\": false,\n \"hasWarning\": false\n}\n```\n\n### Scoped equivalent\n\nTo use the identifyCI\\(String jsonString\\) method in a scoped application, use the corresponding scoped IdentificationEngine method: [identifyCI\\(String jsonString\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/IdentificationEngineScopedAPI.md).\n\n## IdentificationEngineScriptableApi - identifyCIEnhanced\\(String source, String input, Object options\\)\n\nDetermines the Configuration Management Database \\(CMDB\\) operation \\(insert/update\\) to perform with the specified payload \\(request body\\), without committing the operations in the database.\n\n**Note:** If your identification rules are configured to do so, this method can also ingest non-CMDB tables. For additional information on non-CMDB table ingestion, see [IRE support for non-CMDB tables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire-support-non-cmdb-tables.md).\n\nUse this method to simulate submission of a payload.\n\nThis method is similar to the [IdentificationEngineScriptableApi - identifyCI\\(String jsonString\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/c_IdentEngineScriptAPI.md) method, however it also supports the following functionality:\n\n- Partial payloads\n - In case of an item having a warning or error, indicates if an item operation is INSERT\\_AS\\_PARTIAL or INSERT\\_INCOMPLETE.\n - Returns the sys\\_ids of partial payloads that were merged with existing partial payloads.\n- Supports payload deduplicate feature.\n- Generates a summary.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ninput\n\n\n\nString\n\n\n\nRequired. Input payload. A JSON formatted string of configuration items to add or update. ```\n\"input\" { \n \"items\": [Array],\n \"referenceItems\": [Array],\n \"relations\": [Array]\n}\n```\n\n
\n\ninput.items\n\n\n\nArray of Objects\n\n\n\nItems to add or update.```\n\"items\": [\n { \n \"className\": \"String\",\n \"display_values\": {Object},\n \"internal_id\": \"String\",\n \"lookup\": [Array],\n \"related\": [Array],\n \"settings\": {Object},\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_ci\\_linux\\_server or cmdb\\_ci\\_win\\_server.\n\n
\n\ninput.items.display\\_values\n\n\n\nObject\n\n\n\nReference fields to create or update for this related item as name-value pairs, where the name is the field name and the value is the referenced display value. If you want to use the sys\\_id instead of the display value for reference fields, pass the information in the **input.items.lookup.values** parameter instead of in this parameter.Reference field names depend on the fields selected by the user, such as:\n\n ```\n\"display_values\": {\n \"model_id\": \"String\",\n \"location\": \"String\"\n}\n```\n\n
\n\ninput.items.internal\\_id\n\n\n\nString\n\n\n\nUnique item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup\n\n\n\nArray of Objects\n\n\n\nIdentifies the top-level item containing the lookup \\(lookup-based identification\\). These records are used to identify the configuration item based on a lookup table that has a reference back to cmdb\\_ci.For example:\n\n```\n\"lookup\": [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.lookup.className\n\n\n\nString\n\n\n\nRequired. Class/table name, sys\\_class\\_name, of the configuration item \\(CI\\) to create or update.This value can be any CMDB class/table, such as cmdb\\_serial\\_number or cmdb\\_ci\\_network\\_adapter.\n\n
\n\ninput.items.lookup.internal\\_id\n\n\n\nString\n\n\n\nUnique lookup item identifier for the associated payload.This can be any value, but must be unique within the payload.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nDefines a unique CI identifier for a specific data source. Different sources may have different name-value pairs for the same CI.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key-id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.lookup.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date/time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.lookup.values\n\n\n\nObject\n\n\n\nField information for the CI as name-value pairs, where the name is the field name. When updating reference fields, the value must be the referenced sys\\_id.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n \"valid\": \"String\",\n \"ip_address\": \"String\",\n \"mac_address\": \"String\"\n}\n```\n\n
\n\ninput.items.related\n\n\n\nArray of Objects\n\n\n\nReference to the top-level item that contains the related list. Rules in the Related Entry \\[cmdb\\_related\\_entry\\] define what type of records can be in this array. These records are used to add items based on a related table that has a reference to the CI that is being identified. The related table may or may not extend cmdb\\_ci. These records are not used to identify the configuration item.\n\n```\n\"related\" [\n {\n \"className\": \"String\",\n \"internal_id\": \"String\",\n \"sys_object_source_info\": {Object},\n \"values\": {Object}\n }\n]\n```\n\n
\n\ninput.items.related.className\n\n\n\nString\n\n
\n\ninput.items.related.internal\\_id\n\n\n\nString\n\n\n\nUnique identifier for this related item in this payload. Can be any value, but must be unique within the payload.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nObject that makes up a unique CI identifier for a specified data source. Different sources may have different name-value pairs for the same CI.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nIdentifies the data source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/ID from the source for the related item. The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.related.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: `YYYY-MM-DD hh:mm:ss`\n\n
\n\ninput.items.related.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.items.settings\n\n\n\nObject\n\n\n\nParameters that define the types of updates that are permitted.```\n\"settings\": { \n \"skipReclassificationRestrictionRules\": Boolean, \n \"updateWithoutDowngrade\": Boolean, \n \"updateWithoutSwitch\": Boolean,\n \"updateWithoutUpgrade\": Boolean\n}\n```\n\n
\n\ninput.items.settings.skipReclassificationRestrictionRules\n\n\n\nBoolean\n\n\n\nFlag that indicates whether IRE should not run the Reclassification Restriction rule that matches the class for the payload item.Valid values:\n\n- true: Skip running the rule.\n- false: Run the rule.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutDowngrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and downgrade are both permitted for this item.Valid values:\n\n- true: Update the item but downgrade is not permitted.\n- false: Both item update and downgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutSwitch\n\n\n\nBoolean\n\n\n\nFlag that indicates whether the item can be updated and the class switched.Valid values:\n\n- true: Update the item but class switching is not permitted.\n- false: Both item update and class switching are permitted.\n\nDefault: false\n\n
\n\ninput.items.settings.updateWithoutUpgrade\n\n\n\nBoolean\n\n\n\nFlag that indicates whether update and upgrade are both permitted for this item.Valid values:\n\n- true: Update the item but upgrade is not permitted.\n- false: Both item update and upgrade are permitted.\n\nDefault: false\n\n
\n\ninput.items.sys\\_object\\_source\\_info\n\n\n\nObject\n\n\n\nUnique CI identifier for a specific source.```\n\"sys_object_source_info\": { \n \"source_feed\": \"String\",\n \"source_name\": \"String\", \n \"source_native_key\": \"String\",\n \"source_recency_timestamp\": \"String\"\n} \n```\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nIf the source can have multiple feeds, use this field to provide the name of the feed sending this item.The data source generates this feed name. It can be any string that uniquely identifies the source feed.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_native\\_key\n\n\n\nString\n\n\n\nUnique key/id for the item from the source.The data source generates this key. It can be any string that is unique to the item.\n\n
\n\ninput.items.sys\\_object\\_source\\_info.source\\_recency\\_timestamp\n\n\n\nString\n\n\n\nUTC date and time that the item was scanned.Format: YYYY-MM-DD hh:mm:ss\n\n
\n\ninput.items.values\n\n\n\nObject\n\n\n\nFields to create or update for this related item as name/value pairs, where the name is the field name. For a reference field, the value must be the referenced sys\\_id. If you want to use the display value instead of the sys\\_id for reference fields, pass this information in a **display\\_values** object instead of in the **values** object.Field names and types depend on the fields selected by the user, such as:\n\n```\n\"values\": {\n \"host_name\": \"String\",\n \"ip_address\": \"String\",\n \"name\": \"String\",\n \"os_name\": \"String\",\n \"sys_class_name\": \"String\"\n}\n```\n\n
\n\ninput.referenceItems\n\n\n\nArray of Objects\n\n\n\nList that define references between items in the input payload. The values of each reference item are populated before identifying a CI using the IRE rules defined on a class.```\n\"referenceItems\": [\n { \n \"referenced\": \"String\", \n \"referencedBy\": \"String\", \n \"referenceField\": \"String\" \n }\n]\n```\n\n
\n\ninput.referenceItems.referenced\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item being referenced by another item.\n\n
\n\ninput.referenceItems.referencedBy\n\n\n\nString\n\n\n\nThe **internal\\_id** defined for the item that references another item.\n\n
\n\ninput.referenceItems.referenceField\n\n\n\nString\n\n\n\nName of the reference field in the class/table for the **referencedBy** item.\n\n
\n\ninput.relations\n\n\n\nArray of Objects\n\n\n\nList that specifies relationships between items in the input payload. An object in this array can use either of two formats.\n\n- The object can define a relationship between two top-level items \\(only\\) using **parent** and **child** name-value pairs, with values representing item indexes from the payload **items** array.\n\n ```\n\"relations\": [\n {\n \"child\": Number,\n \"parent\": Number,\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n- The object can define a relationship between any two items, including top-level, related, or lookup items, using **parent\\_id** and **child\\_id** key/value pairs, with values representing **internal\\_id** values defined for those items.\n\n ```\n\"relations\": [\n {\n \"child_id\": \"String\",\n \"parent_id\": \"String\",\n \"sys_rel_source_info\": {Object},\n \"type\": \"String\"\n }\n]\n ```\n\n\n
\n\ninput.relations.child\n\n\n\nNumber\n\n\n\nInteger index of the CI object in the **items** array that represents the child in the relationship \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.child\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the child item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\n\n\n\nNumber\n\n\n\nInteger index of the parent item in the **items** array \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.parent\\_id\n\n\n\nString\n\n\n\nThe **internal\\_id** of the parent item in the relation \\(items, items.related, or items.lookup.\\)\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info\n\n\n\nObject\n\n\n\nDiscovery source information for the relationship. For non-dependency relationships, this information is saved in the Relationship Sources \\[sys\\_rel\\_source\\] table \\(not persisted for identifyCIEnhanced\\(\\) or identifyCI\\(\\) methods.\\)Data type: Object\n\n```\n\"sys_rel_source_info\": { \n \"source_name\": \"String\", \n \"source_feed\": \"String\" \n} \n```\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_name\n\n\n\nString\n\n\n\nDiscovery source name. Default: Discovery source passed in the API method parameter.\n\n
\n\ninput.relations.sys\\_rel\\_source\\_info.source\\_feed\n\n\n\nString\n\n\n\nAny string that is a sub-discovery/scan within the discovery source. Default: 'UNKNOWN' is stored in the source\\_feed column when creating a record in sys\\_rel\\_source table.\n\n
\n\ninput.relations.type\n\n\n\nString\n\n\n\nType of relationship that exists between the parent and child items. This must be a name field value from the CI Relationship Type \\[cmdb\\_rel\\_type\\] table.\n\n
\n\noptions\n\n\n\nObject\n\n\n\nOptional, but \\{\\} or null must be passed-in. Options to enable or disable features.**Note:** By default or if **partial\\_payloads** is set to true, both **partial\\_commits** and **deduplicate\\_payloads** are enabled, even if they are set to false, as those features are essential for partial payloads functionality.\n\n```\n\"options\": { \n \"deduplicate_payloads\": Boolean,\n \"generate_summary\": Boolean, \n \"partial_commits\": Boolean, \n \"partial_payloads\": Boolean,\n \"skip_updating_last_scan_to_now\": Boolean,\n \"skip_updating_source_last_discovered_to_now\": Boolean\n}\n```\n\n
\n\noptions.deduplicate\\_payloads\n\n\n\nBoolean\n\n\n\nFlag that indicates whether duplicate items are merged or considered errors.Valid values:\n\n- true: Merge duplicate items.\n- false: Consider duplicate items as errors.\n\nDefault: true\n\n
\n\noptions.generate\\_summary\n\n\n\nBoolean\n\n\n\nFlag that indicates whether the returned results contain summary information. For the details of the returned summary information, see **<String>.summary** in the return results table.Valid values:\n\n- true: Include summary information.\n- false: Don't include summary information.\n\nDefault: false\n\n
\n\noptions.partial\\_commits\n\n\n\nBoolean\n\n\n\nFlag that indicates whether partial commit support is enabled. For additional information on partial commits, see [Enhanced IRE features](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire.md).Valid values:\n\n- true: Partial commit enabled.\n- false: Partial commit disabled.\n\nDefault: true\n\n
\n\noptions.partial\\_payloads\n\n\n\nBoolean\n\n\n\nFlag that indicates whether partial payload support is enabled. For additional information on partial payloads, see [Enhanced IRE features](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/ire.md) and [Create an IRE data source rule](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/create-ire-data-source-rule.md).Valid values:\n\n- true: Partial payload enabled.\n- false: Partial payload disabled.\n\nDefault: true\n\n
\n\noptions.skip\\_updating\\_last\\_scan\\_to\\_now\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to skip updating the sys\\_object\\_source's last\\_scan time field.Valid values:\n\n- true: If the **source\\_recency\\_timestamp** parameter is not passed in**sys\\_object\\_source\\_info**, do not update the sys\\_object\\_source's last\\_scan time field.\n- false: Update the sys\\_object\\_source's last\\_scan time field.\n\nDefault: Uses the value in the glide.identification\\_engine.skip\\_updating\\_last\\_scan\\_to\\_now system property.\n\n
\n\noptions.skip\\_updating\\_source\\_last\\_discovered\\_to\\_now\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to skip updating the discovery\\_source and last\\_discovered fields in the Configuration Item \\[cmdb\\_ci\\] table.Valid values:\n\n- true: If last\\_discovered is not provided in the payload item values, do not update the discovery\\_source and last\\_discovered fields.\n- false: Update the discovery\\_source and last\\_discovered fields.\n\nDefault: Uses the value in the glide.identification\\_engine.skip\\_updating\\_source\\_last\\_discovered\\_to\\_now system property.\n\n
\n\nsource\n\n\n\nString\n\n\n\nData source of the CI information. This value must be one of the choice values defined for the discovery\\_source field of the Configuration Item \\[cmdb\\_ci\\] table.\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\n<String>\n\n\n\nJSON formatted string that is a list of results for the configuration items in the input string.Data type: String\n\n```\n{ \n \"additionalCommittedItems\": [Array], \n \"additionalCommittedRelations\": [Array], \n \"hasError\": Boolean, \n \"hasWarning\": Boolean,\n \"items\": [Array], \n \"relations\": [Array], \n \"summary\": {Object} \n}\n```\n\n
\n\n<String>.additionalCommittedItems\n\n\n\nList of CIs that were committed during the IRE processing of the current payload, but were not present in the current input payload.Data type: Array of Objects\n\n```\n\"additionalCommittedItems\": [\n {\n \"className\": \"String\",\n \"errorCount\": Number,\n \"operation\": \"String\",\n \"identificationAttempts\": [Array],\n \"inputIndices\": [Array],\n \"markers\": [Array],\n \"mergedPayloads\": [Array],\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.additionalCommittedRelations\n\n\n\nDescription of a dependent relationship CI that was not included in the request body **relations** list to insert or update.Data type: Array of Objects\n\n```\n\"additionalCommittedRelations\": [\n {\n \"className\": \"String\",\n \"inputIndices\": [Array],\n \"markers\": [Array],\n \"mergedPayloadIds\": [Array],\n \"operation\": \"String\"\n }\n]\n```\n\n
\n\n<String>.hasError\n\n\n\nFlag that indicates whether any item or relation has errors.Data type: Boolean\n\n
\n\n<String>.hasWarning\n\n\n\nFlag that indicates whether any item or relation has warnings.Data type: Boolean\n\n
\n\n<String>.items\n\n\n\nDescription of the created or updated CIs.Data type: Array of Objects\n\n```\n\"items\": [ \n { \n \"additionalRelatedItems\": [Array],\n \"className\": \"String\",\n \"duplicateIndices\": [Array],\n \"errorCount\": Number, \n \"errors\": [Array], \n \"identificationAttempts\": [Array], \n \"identifierEntrySysId\": \"String\",\n \"info\": [Array], \n \"inputIndices\": [Array], \n \"maskedAttributes\": [Array],\n \"operation\": \"String\",\n \"relatedSysIds\": [Array], \n \"sysId\": \"String\" \n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems\n\n\n\nInformation about additional lookup and related items that were processed but not provided as part of the input payload. These items are from partial payloads.Data type: Array of Objects\n\n```\n\"additionalRelatedItems\": [ \n {\n \"className\": \"String\", \n \"inputIndices\": [Array],\n \"mergedPayloadIds\": [Array], \n \"operation\": \"String\",\n \"sysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.additionalRelatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.additionalRelatedItems.inputIndices\n\n\n\nIndex values for CIs from the request body **items** array that correspond to this related item.Data type: Array of Numbers\n\n
\n\n<String>.items.additionalRelatedItems.mergedPayloadIds\n\n\n\nList of sys\\_ids of the partial payloads that were merged into the related item.Data type: Array\n\nTable: CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\]\n\n
\n\n<String>.items.additionalRelatedItems.operation\n\n\n\nType of operation.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- NO\\_CHANGE: No CI changes were made.\n- UPDATE: Existing CI was updated.\n\nData type: String\n\n
\n\n<String>.items.additionalRelatedItems.sysId\n\n\n\nSys\\_id of the CI that was updated or created.Data type: String\n\n
\n\n<String>.items.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the CI that was created or updated.Data type: String\n\n
\n\n<String>.items.duplicateIndices\n\n\n\nList of indexes of CIs that are duplicates of the current item.Data type: Array\n\n
\n\n<String>.items.errorCount\n\n\n\nNumber of errors encountered while processing the item.Data type: Number\n\n
\n\n<String>.items.errors\n\n\n\nList of errors encountered while processing this CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.errors.error\n\n\n\nType of error encountered while processing the CI.Data type: String\n\n
\n\n<String>.items.errors.message\n\n\n\nError message encountered while processing the CI.Data type: String\n\n
\n\n<String>.items.identificationAttempts\n\n\n\nList of attempts that were made to identify the CIs.Data type: Array of Objects\n\n```\n\"identificationAttempts\": [\n { \n \"attemptResult\": \"String\", \n \"attributes\": [Array],\n \"hybridEntryCiAttributes\": [Array],\n \"identifierName\": \"String\",\n \"searchOnTable\": \"String\" \n }\n]\n```\n\n
\n\n<String>.items.identificationAttempts.attemptResult\n\n\n\nResults of the attempt to identify the CI.Possible values:\n\n- MATCHED: Identification succeeded. A unique CI was found in the identifier rule table which exactly matched the specified attributes.\n- MULTI\\_MATCH: Identification failed with an error. Duplicate CIs were found in the identifier rule table when matching against the specified attributes.\n- NO\\_MATCH: Identification failed. No CI was found in the identifier rule table which matched the specified attributes.\n- SKIPPED: Identification not attempted. The attributes required for this identifier rule table search were not provided, so the rule was not applied.\n\nData type: String\n\n
\n\n<String>.items.identificationAttempts.attributes\n\n\n\nList of CI identifier entry attributes that were used during the identification process.Data type: Array\n\nAttribute names and types depend on the request body data and the identifier in use, such as:\n\n```\n\"attributes\": [\n \"serial_number\": \"String\",\n \"serial_number_type\": \"String\",\n]\n```\n\n
\n\n<String>.items.identificationAttempts.identifierName\n\n\n\nIdentifier rule used for this CI identification attempt.Data type: String\n\n
\n\n<String>.items.identificationAttempts.searchOnTable\n\n\n\nName of the table searched during the identification process.Data type: String\n\n
\n\n<String>.items.identifierEntrySysId\n\n\n\nSys\\_id for the identifier rule used to identify the CI.Data type: String\n\nTable: Identifier Entry \\[cmdb\\_identifier\\_entry\\]\n\n
\n\n<String>.items.info\n\n\n\nAdditional information about the processing of the item.Data type: Array of Objects\n\n```\n\"info\": [\n {\n \"code\": \"String\",\n \"message\": \"String\",\n \"ruleSysId\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.info.code\n\n\n\nReclassification type that was skipped.Possible values:\n\n- SKIPPED\\_CLASS\\_SWITCH\n- SKIPPED\\_CLASS\\_DOWNGRADE\n- SKIPPED\\_CLASS\\_UPGRADE\n\nData type: String\n\n
\n\n<String>.items.info.message\n\n\n\nMessage that provides additional insights into the reason for skipping the reclassification.Data type: String\n\n
\n\n<String>.items.info.ruleSysId\n\n\n\nSys\\_id of the reclassification restriction rule that was matched. Applicable only when IRE skips reclassification due to reclassification restriction rule. This value is empty if the reclassification is skipped due to a payload or global flag.Data type: String\n\n
\n\n<String>.items.inputIndices\n\n\n\nIndexes of the corresponding input CI. For top-level items, it is a list of integers. For related or lookup CIs, it is list of JSON objects.Data type: Array of Numbers\n\n
\n\n<String>.items.maskedAttributes\n\n\n\nList of attributes whose update by a non-authoritative data source was skipped as defined by the [Reconciliation Rules](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/create-reconciliation-rule.md).Data type: Array\n\n
\n\n<String>.items.operation\n\n\n\nOperation that took place.Possible values:\n\n- INSERT: New CI was inserted into the database.\n- INSERT\\_AS\\_INCOMPLETE: Item was saved in cmdb\\_ire\\_incomplete\\_payloads table.\n- INSERT\\_AS\\_PARTIAL: Item was saved in cmdb\\_ire\\_partial\\_payloads table.\n- UPDATE: Existing CI was updated.\n- UPDATE\\_WITH\\_DOWNGRADE: CI was updated and the class changed to a more generic class \\(ancestor class\\).\n- UPDATE\\_WITH\\_SWITCH: CI was updated and the class changed to a class that is not ancestor or descendent.\n- UPDATE\\_WITH\\_UPDRADE: CI was updated and the class changed to a more specialized class \\(descendent class\\).\n\nData type: String\n\n
\n\n<String>.items.relatedItems\n\n\n\nInformation about the processed related items.Data type: Array of Objects\n\n```\n\"relatedItems\": [\n { \n \"className\": \"String\",\n \"errorCount\": Number,\n \"errors\": [Array],\n \"inputIndices\": [Array],\n \"mergePayloadIds\": [Array],\n \"operation\": \"String\",\n \"sysId\": \"String\",\n \"warningCount\": Number,\n \"warnings\": [Array]\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.className\n\n\n\nClass/table name \\(sys\\_class\\_name\\) of the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.errorCount\n\n\n\nNumber of errors detected while processing the related items.Data type: Number\n\n
\n\n<String>.items.relatedItems.errors\n\n\n\nList of errors that occurred during processing of the related item.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedItems.errors.error\n\n\n\nType of error encountered while processing the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.errors.message\n\n\n\nError message encountered while processing the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.inputIndices\n\n\n\nIndex of the corresponding input item. For top-level items, it is a list of integers. For related or lookup items, it is list of JSON objects.Data type: Array of Numbers or Array of Objects\n\n```\n\"inputIndices\": [\n { \n \"mainIndex\": Number, \n \"subIndex\": Number \n }\n]\n```\n\n
\n\n<String>.items.relatedItems.inputIndices.mainIndex\n\n\n\nIndex value from the request body **items** array that corresponds to the CI parent of the related item. Data type: Number\n\n
\n\n<String>.items.relatedItems.inputIndices.subIndex\n\n\n\nIndex value from the request body **items.lookup** array that corresponds to the related item.Data type: Number\n\n
\n\n<String>.items.relatedItems.mergedPayloadIds\n\n\n\nList of sys\\_ids of the partial payloads that were merged into the CI during processing.Data type: Array\n\n
\n\n<String>.items.relatedItems.operation\n\n\n\nOperation that took place.Possible values:\n\n- INSERT: New related CI was inserted into the database.\n- INSERT\\_AS\\_INCOMPLETE: Item was saved in cmdb\\_ire\\_incomplete\\_payloads table.\n- INSERT\\_AS\\_PARTIAL: Item was saved in cmdb\\_ire\\_partial\\_payloads table.\n- NO\\_CHANGE: No related CI changes were made.\n- UPDATE: Existing related CI was updated.\n- UPDATE\\_WITH\\_DOWNGRADE: Related CI was updated and the class changed to a more generic class \\(ancestor class\\).\n- UPDATE\\_WITH\\_SWITCH: Related CI was updated and the class changed to a class that is not ancestor or descendent.\n- UPDATE\\_WITH\\_UPDRADE: Related CI was updated and the class changed to a more specialized class \\(descendent class\\).\n\nData type: String\n\n
\n\n<String>.items.relatedItems.sysId\n\n\n\nSys\\_id of the related item.Data type: String\n\n
\n\n<String>.items.relatedItems.warningCount\n\n\n\nNumber of warnings encountered when processing the related items.Data type: Number\n\n
\n\n<String>.items.relatedItems.warnings\n\n\n\nDescription of warnings encountered while processing the related items.Data type: Array of Objects\n\n```\n\"warnings\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.items.relatedSysIds\n\n\n\nList of the sys\\_id values of the CIs used during lookup-based identification of related items.Data type: String\n\n
\n\n<String>.items.sys\\_id\n\n\n\nSys\\_id of the CI that was updated or created.Data type: String\n\n
\n\n<String>.relations\n\n\n\nInformation about the processed relations.Data type: Array of Objects\n\n```\n\"relations\": [ \n { \n \"className\": \"String\",\n \"errorCount\": Number,\n \"errors\": [Array],\n \"inputIndices\": [Array],\n \"operation\": \"String\",\n \"sysId\": \"String\" \n }\n]\n```\n\n
\n\n<String>.relations.className\n\n\n\nSys\\_class\\_name of this dependent relationship CI.Only supported value: cmdb\\_rel\\_ci: CI Relationship table.\n\nData type: String\n\n
\n\n<String>.relations.errorCount\n\n\n\nNumber of errors encountered when processing the dependent relationship CI.Data type: Number\n\n
\n\n<String>.relations.errors\n\n\n\nList that describes errors that were encountered while processing this dependent relationship CI.Data type: Array of Objects\n\n```\n\"errors\": [\n {\n \"error\": \"String\",\n \"message\": \"String\"\n }\n]\n```\n\n
\n\n<String>.relations.inputIndices\n\n\n\nIndexes for the dependent relationship CI objects in the request body **relations** array that correspond to this dependent relationship CI.Data type: Array\n\n
\n\n<String>.relations.operation\n\n\n\nType of operation performed.Possible values:\n\n- INSERT: The dependent relationship CI was inserted into the target table as a new record.\n- INSERT\\_AS\\_INCOMPLETE: The dependent relationship CI had errors and was inserted into the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.\n- INSERT\\_AS\\_PARTIAL: The dependent relationship CI had errors and was inserted into the CMDB IRE Partial Payloads \\[cmdb\\_ire\\_partial\\_payloads\\] table.\n- NO\\_CHANGE: No operation was performed.\n- UPDATE: An existing dependent relationship CI in the target table was updated.\n\nData type: String\n\n
\n\n<String>.relations.sysId\n\n\n\nSys\\_id of the dependent relationship CI.Data type: String\n\n
\n\n<String>.summary\n\n\n\nList of JSON properties that provide statistics on how many items were inserted, updated, and such, per class.Data type: Array\n\n
\n\n<String>.summary.<class\\_name>\n\n\n\nStatistics for a specific class.Data type: Object\n\n```\n: {\n \"additionalInsertedItemCount\": Number, \n \"errorCount\": Number,\n \"incompleteItemCount\": Number,\n \"insertedItemCount\": Number,\n \"partialItemCount\": Number,\n \"skippedItemCount\": Number,\n \"unchangedItemCount\": Number,\n \"updatedItemCount\": Number,\n \"warningCount\": Number \n}\n```\n\n
\n\n<String>.summary.<class\\_name>.additionalInsertedItemCount\n\n\n\nNumber of items inserted due to processing of partial payloads.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.errorCount\n\n\n\nNumber of errors encounter when processing items.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.incompleteItemCount\n\n\n\nNumber of items inserted in the CMDB IRE Incomplete Payloads \\[cmdb\\_ire\\_incomplete\\_payloads\\] table.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.insertedItemCount\n\n\n\nNumber of items created.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.partialItemCount\n\n\n\nNumber of items saved in the Partial Payload table \\[cmdb\\_ire\\_partial\\_payloads\\].Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.skippedItemCount\n\n\n\nNumber of items that were skipped.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.unchangedItemCount\n\n\n\nNumber of items that had entries but were not modified.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.updatedItemCount\n\n\n\nNumber of items updated.Data type: Number\n\n
\n\n<String>.summary.<class\\_name>.warningCount\n\n\n\nNumber of items that generated a warning when processed.Data type: Number\n\n
```\nvar payload = {\n\"items\": [\n{\n\"className\": \"cmdb_ci_win_server\",\n\"values\": {\n \"chassis_type\": \"Desktop\",\n \"os\": \"Windows 2012 R2 Datacenter\",\n \"name\": \"Windows2012Server1\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"cpu_count\": \"1\"\n },\n \"lookup\": [\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"0000-0011-1690-8730-8636-5722-52\",\n \"serial_number_type\": \"bios\"\n },\n \"className\": \"cmdb_serial_number\"\n },\n {\n \"values\": {\n \"valid\": \"true\",\n \"serial_number\": \"3311-9736-4988-9744-1749-4183-41\",\n \"serial_number_type\": \"chassis\"\n },\n \"className\": \"cmdb_serial_number\"\n }],\n \n \"internal_id\": \"16777219\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"16777219\",\n \"source_recency_timestamp\": \"2019-10-18 08:31:23\"\n }},\n {\n \"className\": \"cmdb_ci_spkg\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter\",\n \"key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL\"\n },\n \n \"related\": [\n {\n \"internal_id\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\",\n \"values\": {\n \"name\": \"Windows 2012 R2 Datacenter-SAMLABVM52\"\n },\n \"className\": \"cmdb_software_instance\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }},\n {\n \"internal_id\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777229\",\n \"values\": {\n },\n \"className\": \"cmdb_software_instance\",\n \"sys_object_source_info\": {\n \"source_feed\": \"SN Discovery Feed 1\",\n \"source_name\": \"ServiceNow\",\n \"source_native_key\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777229\"\n }}\n],\n \"settings\" : {\n \"skipReclassificationRestrictionRules\" : \"true\",\n \"updateWithoutDowngrade\" : \"true\",\n \"updateWithoutUpgrade\" : \"true\",\n \"updateWithoutSwitch\" : \"true\"\n }},\n {\n \"className\": \"cmdb_ci_app_server_tomcat\",\n \"values\": {\n \"running_process_key_parameters\": \"/opt/OV/nonOV/tomcat/b/temp org.apache.catalina.startup.Bootstrap start\",\n \"install_directory\": \"/opt/OV/nonOV/tomcat/b\",\n \"name\": \"Tomcat@hpom9:3443\",\n \"server_port\": \"8006\",\n \"sys_class_name\": \"cmdb_ci_app_server_tomcat\"\n },\n \n \"internal_id\": \"tomcat_id\"\n }],\n \n\"relations\": [\n {\n \"parent_id\": \"tomcat_id\",\n \"child_id\": \"16777219\",\n \"type\": \"Runs on::Runs\"\n }],\n \n\"referenceItems\": [\n {\n \"referenceField\": \"installed_on\",\n \"referenced\": \"16777219\",\n \"referencedBy\": \"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777219\"\n }]};\n \nvar input = new JSON().encode(payload);\nvar output = SNC.IdentificationEngineScriptableApi.identifyCIEnhanced('ServiceNow', input, {});\n```\n\nOutput:\n\n```\n{\n \"items\": [\n {\n \"className\": \"cmdb_ci_win_server\",\n \"operation\": \"INSERT\",\n \"relatedSysIds\": [\n null,\n null\n ],\n \"relatedItems\": [\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"className\": \"cmdb_serial_number\",\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 0\n }\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n },\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"className\": \"cmdb_serial_number\",\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 0,\n \"subIndex\": 1\n }\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n }\n ],\n \"identificationAttempts\": [\n {\n \"attributes\": [],\n \"info\": \"sys_object_source NO_MATCH\",\n \"identifierName\": \"\",\n \"attemptResult\": \"NO_MATCH\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"serial_number\",\n \"serial_number_type\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"searchOnTable\": \"cmdb_serial_number\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"serial_number\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"name\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"NO_MATCH\",\n \"searchOnTable\": \"cmdb_ci_hardware\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"mac_address\",\n \"name\"\n ],\n \"identifierName\": \"Hardware Rule\",\n \"attemptResult\": \"SKIPPED\",\n \"searchOnTable\": \"cmdb_ci_network_adapter\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n },\n {\n \"className\": \"cmdb_ci_spkg\",\n \"operation\": \"INSERT\",\n \"relatedSysIds\": [\n null\n ],\n \"relatedItems\": [\n {\n \"errors\": [],\n \"operation\": \"INSERT\",\n \"className\": \"cmdb_software_instance\",\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 1,\n \"subIndex\": 0\n }\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n },\n {\n \"errors\": [],\n \"warnings\": [\n {\n \"error\": \"MISSING_MATCHING_ATTRIBUTES\",\n \"message\": \"In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_software_instance]. Add these input values in payload item '{\\\"className\\\":\\\"cmdb_software_instance\\\",\\\"values\\\":{},\\\"internal_id\\\":\\\"f7273cccec30101056cd4bb46eb4db5d\\\",\\\"sys_object_source_info\\\":{\\\"source_feed\\\":\\\"SN Discovery Feed 1\\\",\\\"source_name\\\":\\\"ServiceNow\\\",\\\"source_native_key\\\":\\\"Microsoft Windows Server 2012 R2 Datacenter_:::_NULL|16777229\\\"},\\\"settings\\\":{},\\\"sys_ire_info\\\":{\\\"ire_received_time\\\":\\\"2020-05-10 17:57:48\\\"}}'\"\n }\n ],\n \"operation\": \"INSERT_AS_PARTIAL\",\n \"className\": \"cmdb_software_instance\",\n \"errorCount\": 0,\n \"sysId\": \"Unknown\",\n \"markers\": [],\n \"inputIndices\": [\n {\n \"mainIndex\": 1,\n \"subIndex\": 1\n }\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 1\n }\n ],\n \"identificationAttempts\": [\n {\n \"attributes\": [],\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"hybridEntryCiAttributes\": []\n },\n {\n \"attributes\": [\n \"key\"\n ],\n \"identifierName\": \"Software\",\n \"attemptResult\": \"NO_MATCH\",\n \"searchOnTable\": \"cmdb_ci_spkg\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 1\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n },\n {\n \"className\": \"cmdb_ci_app_server_tomcat\",\n \"operation\": \"INSERT\",\n \"identificationAttempts\": [\n {\n \"attributes\": [],\n \"info\": \"sys_object_source SKIPPED\",\n \"identifierName\": \"\",\n \"attemptResult\": \"SKIPPED\",\n \"hybridEntryCiAttributes\": []\n }\n ],\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 2\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n }\n ],\n \"additionalCommittedItems\": [],\n \"relations\": [\n {\n \"className\": \"cmdb_rel_ci\",\n \"operation\": \"INSERT\",\n \"errorCount\": 0,\n \"markers\": [],\n \"inputIndices\": [\n 0\n ],\n \"mergedPayloadIds\": [],\n \"warningCount\": 0\n }\n ],\n \"additionalCommittedRelations\": []\n}  \n```\n\n## IdentificationEngineScriptableApi - runIdentificationAudit\\(GlideRecord now\\_GR\\)\n\nRuns an identification audit against the specified configuration item \\(CI\\) to detect duplicates.\n\nIf duplicates are found, duplication tasks are created. Only use this method on CI types with independent identification rules.\n\n|Name|Type|Description|\n|----|----|-----------|\n|now\\_GR|GlideRecord|CI on which to run the audit to detect duplicates. The CI must have independent identification rules.|\n\n|Type|Description|\n|----|-----------|\n|void| |\n\nThe following example shows how to check the server for duplicate tasks and creates a remediate duplicate task if any exist.\n\n```\nvar grServer = new GlideRecord('cmdb_ci_server');\ngrServer.query();\nwhile (grServer.next()) {\n SNC.IdentificationEngineScriptableApi.runIdentificationAudit(grServer);\n}\n```\n\n### Scoped equivalent\n\nTo use the runIdentificationAudit\\(GlideRecord now\\_GR\\) method in a scoped application, use the corresponding scoped IdentificationEngine method: [runIdentificationAudit\\(GlideRecord now\\_GR\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/IdentificationEngineScopedAPI.md).\n\n"}}