API Identification et réconciliation
L’API Identification et réconciliation utilise le moteur Identification et réconciliation (IRE) pour minimiser la création d’éléments de configuration (CI) en double et pour rapprocher les attributs de CI en acceptant uniquement les informations provenant de sources autorisées lors de la mise à jour du Base de données de gestion des configurations (CMDB).
Les utilisateurs doivent disposer du rôle itil ou asset pour utiliser cette API.
Pour plus d’informations sur l’IRE, consultez Moteur Identification et réconciliation (IRE).
Identification et réconciliation : POST /now/identifyreconcile
Insère ou met à jour des éléments de configuration (CI) dans le CMDB en appliquant des règles d’identification et de réconciliation à la charge utile spécifiée (corps de la demande). Utilisez cette API au lieu de la mettre à jour CMDB directement.
Utilisez le point de terminaison pour simuler la Identification et réconciliation : POST /now/identifyreconcile/query soumission d’une charge utile à ce point de terminaison sans valider les modifications apportées à la base de données.
Utilisez le Identification et réconciliation : POST /now/identifyreconcile/enhanced point de terminaison à la place si vous devez spécifier des options IRE améliorées. Pour en savoir plus sur les options IRE améliorées, consultez Moteur Identification et réconciliation (IRE).
Format d'URL
URL versionnée : /api/now/{api_version}/identifyreconcile
URL par défaut : /api/now/identifyreconcile
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_data_source | Identifie la source des informations sur le CI. Il doit s’agir de l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne Par défaut : insérez la charge utile de l’API dans la table des charges utiles incomplètes. |
| Nom | Description |
|---|---|
| Éléments | Tableau d’objets dans lequel chaque objet décrit un CI à créer ou à mettre à jour. Type de données : tableau |
| items.className | Requis. sys_class_name (nom de classe/table) du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB table, comme cmdb_ci_linux_server ou cmdb_ci_win_server. Type de données : chaîne |
| items.internal_id | Identificateur unique de cet élément dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.rechercher | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’identification basé sur la recherche. Ces enregistrements sont utilisés pour identifier l’élément de configuration de niveau supérieur en fonction d’une table de recherche qui fait référence à la table Élément de configuration [cmdb_ci]. Type de données : tableau |
| items.lookup.className | Requis. sys_class_name ou nom de classe/table du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB classe/table, telle que cmdb_serial_number ou cmdb_ci_network_adapter, ou une classe nonCMDB hiérarchique. Type de données : chaîne |
| items.lookup.internal_id | Identificateur unique pour cet enregistrement de recherche dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.lookup.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.lookup.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.recherche.valeurs | Objet décrivant les champs de cet élément de recherche sous forme de paires nom/valeur, où le nom est le nom du champ. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.connexes | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’élément à créer ou à mettre à jour, basé sur une table connexe qui fait référence au CI de niveau supérieur en cours d’identification. Les règles de la table Entrée connexe [cmdb_related_entry] définissent le type d’enregistrements que peut trouver ce tableau. La table associée peut étendre ou non la table Élément de configuration [cmdb_ci]. Ces enregistrements ne sont pas utilisés pour identifier l’élément de configuration. Type de données : tableau |
| items.related.className | Requis. Le nom de sys_class_name ou de classe/table de l’élément connexe à créer ou à mettre à jour. Type de données : chaîne |
| items.related.internal_id | Identificateur unique pour cet élément connexe dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.related.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.related.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie cet élément connexe. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.related.sys_object_source_info.source_name | Source de données pour les informations sur l’élément connexe. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.related.sys_object_source_info.source_native_key | Clé/ID unique de la source pour l’élément connexe. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.related.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles l’élément connexe a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| valeurs.connexes.éléments. | Objet décrivant les champs à créer ou à mettre à jour pour cet élément connexe en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.paramètres | Objet contenant des paramètres définissant les types de mises à jour autorisés. Type de données : objet |
| items.settings.skipReclassificationRestrictionRules | Marqueur indiquant si IRE doit ignorer l’exécution de la règle de restriction de classification qui correspond à la classe de l’élément de charge utile. Valeurs valides :
Valeur par défaut : false |
| items.settings.updateWithoutDowngrade | Indique si la mise à jour et le passage à une version antérieure sont autorisés pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutSwitch | Indique si ce CI peut être mis à jour et si sa classe peut être changée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutUpgrade | Indique si la mise à jour et la mise à niveau sont autorisées pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.sys_objet_source_info | Objet décrivant un identificateur de CI unique. Type de données : objet |
| items.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.valeurs | Objet décrivant les champs à créer ou à mettre à jour pour ce CI en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments de référence | Tableau d’objets dans lequel chaque objet décrit une référence entre deux éléments de la charge utile. Type de données : tableau |
| referenceItems.referenced | Défini internal_id pour l’élément référencé par un autre élément. Type de données : chaîne |
| referenceItems.referencedBy | Défini internal_id pour l’élément qui fait référence à un autre élément. Type de données : chaîne |
| referenceItems.referenceField | Nom du champ de référence dans la classe/table pour l’élément referencedBy . Type de données : chaîne |
| Relations | Tableau d’objets dans lequel chaque objet décrit une relation entre deux éléments définis dans la charge utile. Un objet de ce tableau peut utiliser l’un des deux formats suivants :
Type de données : tableau
|
| relations.enfant | L’index entier de l’objet CI dans le items tableau qui représente l’enfant dans la relation. Type de données : nombre |
| relations.child_id | L’élément internal_id enfant dans la relation. Type de données : chaîne |
| relations.parent | Index entier de l’objet CI dans le items tableau qui représente le parent dans la relation. Type de données : nombre |
| relations.parent_id | L’élément internal_id parent dans la relation. Type de données : chaîne |
| relations.sys_rel_source_info | Informations sur la source de détection pour la relation. Pour les relations de non-dépendance, ces informations se trouvent dans la table Sources de relation [sys_rel_source]. Type de données : objet |
| relations.sys_rel_source_info.source_name | Nom de la source de détection. Par défaut : source de détection transmise dans le paramètre de méthode d’API. |
| relations.sys_rel_source_info.source_feed | Toute chaîne qui est une sous-détection/analyse au sein de la source de détection. Par défaut : « INCONNU » est stocké dans la colonne source_feed lors de la création d’un enregistrement dans sys_rel_source table. |
| relations.type | Type de relation existant entre les éléments parents et enfants. Il doit s’agir d’une valeur de champ de nom de la table Type de relation CI [cmdb_rel_type]. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Tableau des résultats produits par la requête. Type de données : tableau |
| result.additionalCommittedItems | Tableau d’objets dans lequel chaque objet décrit un CI non inclus dans le corps de la demande items Tableau à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedItems.className | sys_class_name de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI supplémentaire. Type de données : nombre |
| résultat.additionalCommittedItems.errors | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.errors.error | Type d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errors.message | Message d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.attributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI supplémentaire. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.inputIndex | Tableau des valeurs d’index pour les CI du tableau de corps items de la demande qui correspondent à ce CI supplémentaire. Type de données : tableau |
| result.additionalCommittedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedItems.mergedPayloads | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées pendant le traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.operation | Opération effectuée pour ce CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.sysId | La sys_id trouvée pour ce CI supplémentaire grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.warnings | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.warnings.error | Type d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.warnings.message | Message d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedRelations | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant non inclus dans la liste du corps relations de la demande à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedRelations.className | sys_class_name de ce CI de relation dépendante supplémentaire. Seule valeur prise en charge :
Type de données : chaîne |
| result.additionalCommittedRelations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : nombre |
| résultat.additionalRelationsEngagées.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionalRelationsEngagées.errors.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.errors.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante supplémentaire. Type de données : tableau |
| result.additionalCommittedRelations.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedRelations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionnellesRelationsEngagées.opération | Opération exécutée pour ce CI de relation dépendante supplémentaire. Valeurs possibles :
Type de données : chaîne |
| éléments.résultats | Tableau d’objets dans lequel chaque objet décrit un CI inclus dans le tableau de corps items de la demande. Type de données : tableau |
| result.items.additionalRelatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) de la table Charges utiles partielles IRE [cmdb_ire_partial_payloads] CMDB. Type de données : tableau |
| result.items.additionalRelatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.additionalRelatedItems.inputIndex | Tableau des valeurs d’index des CI du tableau de corps items de la demande qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.additionalRelatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées au cours du traitement de cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.sysId | sys_id de ce CI connexe. Type de données : chaîne |
| result.items.className | sys_class_name de ce CI. Type de données : chaîne |
| result.items.duplicateLookupIndex | Objet contenant des tableaux de valeurs d’index pour items.lookup les éléments de tableau qui font référence au même CI associé. Le nom du tableau indique le premier élément du tableau de corps items.lookup de la demande qui fait référence à un CI connexe donné. Ses valeurs correspondent à l’ensemble des éléments supplémentaires du même tableau qui font référence au même CI associé. Type de données : objet Cet exemple montre un cas où le deuxième élément du items.lookup tableau fait référence au même CI connexe qu’un élément ultérieur de ce tableau : |
| result.items.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI. Type de données : nombre |
| résultat.éléments.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.errors.message | Message d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI. Type de données : tableau |
| result.items.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI. Valeurs possibles :
Type de données : chaîne |
| result.items.identificationAttempts.attributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.hybridEntryCiAttributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI. Valeurs notables :
Type de données : chaîne |
| result.items.info | Liste d’objets contenant des informations supplémentaires sur le traitement de l’élément. Type de données : tableau |
| résultat.articles.info.code | Type de reclassification qui a été ignoré. Valeurs possibles :
|
| résultat.éléments.info.message | Message qui fournit des informations supplémentaires sur le motif de l’omission de la reclassification. Type de données : chaîne |
| result.items.info.ruleSysId | Sys_id de la règle de restriction de reclassification qui a été mise en correspondance. Applicable uniquement lorsque le moteur IRE ignore la reclassification en raison de la règle de restriction de classification. Cette valeur est vide si la reclassification est ignorée en raison d’une charge utile ou d’un marqueur global. Type de données : chaîne |
| result.items.inputIndex | Tableau des valeurs d’index pour les CI provenant du tableau du corps items de la demande correspondant à ce CI. Type de données : tableau |
| resultat.éléments.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.mergedPayloadIds | Tableau des valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées au cours du traitement de ce CI. Type de données : tableau |
| résultat.éléments.opération | Opération exécutée pour ce CI. Valeurs possibles :
Type de données : chaîne |
| result.items.relatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) à partir du tableau de corps items.lookup de la demande. Type de données : tableau |
| result.items.relatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.relatedItems.inputIndex | Tableau des valeurs d’index pour les CI et les éléments de recherche dans le corps items de la demande et items.lookup les tableaux qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.relatedItems.inputIndices.mainIndex | Valeur d’index du tableau de corps items de la demande qui correspond au parent CI de l’élément connexe. Type de données : nombre |
| result.items.relatedItems.inputIndices.subIndex | Valeur d’index du tableau de corps items.lookup de la demande qui correspond à l’élément connexe. Type de données : nombre |
| result.items.relatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.relatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les entrées de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées dans ce CI pendant le traitement. Type de données : tableau |
| result.items.relatedSysIds | Tableau des valeurs de sys_id pour les éléments connexes (éléments de recherche de table) provenant du tableau de corps items.lookup de la demande. Type de données : tableau Valeurs notables :
|
| result.items.sysId | La sys_id trouvée pour ce CI grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| resultat.éléments.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| résultat.éléments.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.logContextId | ID de contexte signalé pour cette charge utile. Type de données : chaîne |
| relations.résultats | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant du tableau de corps relations de la demande. Type de données : tableau |
| result.relations.className | La sys_class_name de ce CI de relation dépendante. Seule valeur prise en charge :
Type de données : chaîne |
| result.relations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante. Type de données : nombre |
| result.relations.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| resultat.relations.erreurs.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| result.relations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante. Type de données : tableau |
| result.relations.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.relations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.opération | Opération exécutée pour ce CI de relation dépendant. Valeurs possibles :
Type de données : chaîne |
| résultats.relations.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| résultat.relations.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
Demande cURL
Soumettez une charge utile contenant un serveur Linux (avec des recherches d’éléments connexes de numéro de série et d’adaptateur réseau) et un commutateur IP, avec une relation dépendante de la connexion IP.
curl "https://instance.servicenow.com/api/now/identifyreconcile" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{ \
"items": [{ \
"className": "cmdb_ci_linux_server", \
"values": { \
"sys_class_name": "cmdb_ci_linux_server", \
"name": "lnux101", \
"host_name": "lnux101.servicenow.com", \
"ip_address": "10.11.12.173", \
"os_name": "Linux Red Hat" \
}, \
"lookup": [{ \
"className": "cmdb_serial_number", \
"values": { \
"serial_number": "lnux101", \
"serial_number_type": "uuid", \
"valid": "true" \
} \
}, { \
"className": "cmdb_ci_network_adapter", \
"values": { \
"name": "eth0", \
"ip_address": "10.11.12.173", \
"mac_address": "00:55:51:21:26:2f" \
} \
}] \
}, { \
"className": "cmdb_ci_ip_switch", \
"values": { \
"name": "IP-Switch-1", \
"serial_number": "Switch23587", \
"serial_number_type": "uuid" \
} \
}], \
"relations": [{ \
"parent": 0, \
"child": 1, \
"type": "IP Connection::IP Connection" \
}]
}'
Le CI du serveur Linux est identifié via une recherche de règle de matériel pour son nom dans la table Matériel [cmdb_ci_hardware] et est traité comme une mise à jour d’un CI existant dans la table du serveur Linux [cmdb_ci_linux_server]. Le commutateur IP est identifié de la même façon via une recherche de règle de matériel pour son nom dans la table Matériel et met à jour un CI existant dans la table Commutateur IP [cmdb_ci_ip_switch]. Enfin, la relation dépendante de la connexion IP entre le serveur et le commutateur est insérée en tant que nouvel enregistrement dans la table Relations CI [cmdb_rel_ci].
{
"result": {
"items": [{
"className": "cmdb_ci_linux_server",
"operation": "UPDATE",
"sysId": "539747cac0a801640163e60735fbbf6e",
"relatedSysIds": [null, null],
"relatedItems": [{
"markers": [],
"inputIndices": [{
"mainIndex": 0,
"subIndex": 0
}],
"mergedPayloadIds": [],
"className": "cmdb_serial_number"
}, {
"markers": [],
"inputIndices": [{
"mainIndex": 0,
"subIndex": 1
}],
"mergedPayloadIds": [],
"className": "cmdb_ci_network_adapter"
}],
"additionalRelatedItems": [],
"identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
"identificationAttempts": [{
"identifierName": "Hardware Rule",
"attemptResult": "NO_MATCH",
"attributes": ["serial_number", "serial_number_type"],
"searchOnTable": "cmdb_serial_number",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "MATCHED",
"attributes": ["name"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}],
"markers": [],
"inputIndices": [0],
"mergedPayloadIds": [],
"errorCount": 0
}, {
"className": "cmdb_ci_ip_switch",
"operation": "UPDATE",
"sysId": "304481257f701200bee45f19befa915b",
"identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
"identificationAttempts": [{
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number", "serial_number_type"],
"searchOnTable": "cmdb_serial_number",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "NO_MATCH",
"attributes": ["serial_number"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "MATCHED",
"attributes": ["name"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}],
"markers": [],
"inputIndices": [1],
"mergedPayloadIds": [],
"errorCount": 0
}],
"additionalCommittedItems": [],
"relations": [{
"className": "cmdb_rel_ci",
"operation": "INSERT",
"markers": [],
"inputIndices": [0],
"mergedPayloadIds": [],
"errorCount": 0
}],
"additionalCommittedRelations": []
}
}
Identification et réconciliation : POST /now/identifyreconcile/enhanced
Insère ou met à jour des éléments de configuration (CI) dans le CMDB en appliquant des règles d’identification et de réconciliation à la charge utile spécifiée (corps de la demande). Utilisez cette API au lieu de la mettre à jour CMDB directement.
Utilisez le point de terminaison pour simuler la Identification et réconciliation : POST /now/identifyreconcile/queryEnhanced soumission d’une charge utile à ce point de terminaison sans valider les modifications apportées à la base de données.
- Charges utiles partielles
- Dans le cas d’un avertissement ou d’une erreur pour un élément, indique si une opération d’élément est INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
- Renvoie la sys_ids des charges utiles partielles qui ont été fusionnées avec les charges utiles partielles existantes.
- Prend en charge la fonctionnalité de déduplication de charge utile.
- Génère un résumé.
Format d'URL
URL versionnée : /api/now/{api_version}/identifyreconcile/enhanced
URL par défaut : /api/now/identifyreconcile/enhanced
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| options | Liste de paires nom-valeur séparées par des virgules représentant les options IRE améliorées appliquées pour la demande. Par exemple, pour remplacer les valeurs par défaut des charges utiles partielles, des validations partielles, des charges utiles dédupliquées et générer des options IRE améliorées : partial_payloads :faux,partial_commits :faux,deduplicate_payloads :faux,generate_summary :vrai Remarque : Par défaut ou si partial_payloads est défini sur vrai, les deux partial_commits et deduplicate_payloads sont activés, même s’ils sont définis sur faux, car ces fonctionnalités sont essentielles pour la fonctionnalité des charges utiles partielles. Pour en savoir plus sur les options IRE améliorées, consultez Moteur Identification et réconciliation (IRE). Valeurs valides pour chaque paire nom-valeur :
Type de données : chaîne |
| sysparm_data_source | Identifie la source des informations sur le CI. Il doit s’agir de l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne Par défaut : insérez la charge utile de l’API dans la table des charges utiles incomplètes. |
| Nom | Description |
|---|---|
| Éléments | Tableau d’objets dans lequel chaque objet décrit un CI à créer ou à mettre à jour. Type de données : tableau |
| items.className | Requis. sys_class_name (nom de classe/table) du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB table, comme cmdb_ci_linux_server ou cmdb_ci_win_server. Type de données : chaîne |
| items.internal_id | Identificateur unique de cet élément dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.rechercher | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’identification basé sur la recherche. Ces enregistrements sont utilisés pour identifier l’élément de configuration de niveau supérieur en fonction d’une table de recherche qui fait référence à la table Élément de configuration [cmdb_ci]. Type de données : tableau |
| items.lookup.className | Requis. sys_class_name ou nom de classe/table du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB classe/table, telle que cmdb_serial_number ou cmdb_ci_network_adapter, ou une classe nonCMDB hiérarchique. Type de données : chaîne |
| items.lookup.internal_id | Identificateur unique pour cet enregistrement de recherche dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.lookup.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.lookup.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.recherche.valeurs | Objet décrivant les champs de cet élément de recherche sous forme de paires nom/valeur, où le nom est le nom du champ. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.connexes | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’élément à créer ou à mettre à jour, basé sur une table connexe qui fait référence au CI de niveau supérieur en cours d’identification. Les règles de la table Entrée connexe [cmdb_related_entry] définissent le type d’enregistrements que peut trouver ce tableau. La table associée peut étendre ou non la table Élément de configuration [cmdb_ci]. Ces enregistrements ne sont pas utilisés pour identifier l’élément de configuration. Type de données : tableau |
| items.related.className | Requis. Le nom de sys_class_name ou de classe/table de l’élément connexe à créer ou à mettre à jour. Type de données : chaîne |
| items.related.internal_id | Identificateur unique pour cet élément connexe dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.related.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.related.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie cet élément connexe. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.related.sys_object_source_info.source_name | Source de données pour les informations sur l’élément connexe. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.related.sys_object_source_info.source_native_key | Clé/ID unique de la source pour l’élément connexe. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.related.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles l’élément connexe a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| valeurs.connexes.éléments. | Objet décrivant les champs à créer ou à mettre à jour pour cet élément connexe en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.paramètres | Objet contenant des paramètres définissant les types de mises à jour autorisés. Type de données : objet |
| items.settings.skipReclassificationRestrictionRules | Marqueur indiquant si IRE doit ignorer l’exécution de la règle de restriction de classification qui correspond à la classe de l’élément de charge utile. Valeurs valides :
Valeur par défaut : false |
| items.settings.updateWithoutDowngrade | Indique si la mise à jour et le passage à une version antérieure sont autorisés pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutSwitch | Indique si ce CI peut être mis à jour et si sa classe peut être changée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutUpgrade | Indique si la mise à jour et la mise à niveau sont autorisées pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.sys_objet_source_info | Objet décrivant un identificateur de CI unique. Type de données : objet |
| items.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.valeurs | Objet décrivant les champs à créer ou à mettre à jour pour ce CI en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments de référence | Tableau d’objets dans lequel chaque objet décrit une référence entre deux éléments de la charge utile. Type de données : tableau |
| referenceItems.referenced | Défini internal_id pour l’élément référencé par un autre élément. Type de données : chaîne |
| referenceItems.referencedBy | Défini internal_id pour l’élément qui fait référence à un autre élément. Type de données : chaîne |
| referenceItems.referenceField | Nom du champ de référence dans la classe/table pour l’élément referencedBy . Type de données : chaîne |
| Relations | Tableau d’objets dans lequel chaque objet décrit une relation entre deux éléments définis dans la charge utile. Un objet de ce tableau peut utiliser l’un des deux formats suivants :
Type de données : tableau
|
| relations.enfant | L’index entier de l’objet CI dans le items tableau qui représente l’enfant dans la relation. Type de données : nombre |
| relations.child_id | L’élément internal_id enfant dans la relation. Type de données : chaîne |
| relations.parent | Index entier de l’objet CI dans le items tableau qui représente le parent dans la relation. Type de données : nombre |
| relations.parent_id | L’élément internal_id parent dans la relation. Type de données : chaîne |
| relations.sys_rel_source_info | Informations sur la source de détection pour la relation. Pour les relations de non-dépendance, ces informations se trouvent dans la table Sources de relation [sys_rel_source]. Type de données : objet |
| relations.sys_rel_source_info.source_name | Nom de la source de détection. Par défaut : source de détection transmise dans le paramètre de méthode d’API. |
| relations.sys_rel_source_info.source_feed | Toute chaîne qui est une sous-détection/analyse au sein de la source de détection. Par défaut : « INCONNU » est stocké dans la colonne source_feed lors de la création d’un enregistrement dans sys_rel_source table. |
| relations.type | Type de relation existant entre les éléments parents et enfants. Il doit s’agir d’une valeur de champ de nom de la table Type de relation CI [cmdb_rel_type]. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. Détail du message d’erreur « Chunk [...] is not a valid entry » indique que le paramètre de requête n’est options pas dans le format de paire nom-valeur correct. Par exemple, la spécification d’un options paramètre |
Paramètres de corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Tableau des résultats produits par la requête. Type de données : tableau |
| result.additionalCommittedItems | Tableau d’objets dans lequel chaque objet décrit un CI non inclus dans le corps de la demande items Tableau à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedItems.className | sys_class_name de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI supplémentaire. Type de données : nombre |
| résultat.additionalCommittedItems.errors | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.errors.error | Type d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errors.message | Message d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.attributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI supplémentaire. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.inputIndex | Tableau des valeurs d’index pour les CI du tableau de corps items de la demande qui correspondent à ce CI supplémentaire. Type de données : tableau |
| result.additionalCommittedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedItems.mergedPayloads | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées pendant le traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.operation | Opération effectuée pour ce CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.sysId | La sys_id trouvée pour ce CI supplémentaire grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.warnings | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.warnings.error | Type d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.warnings.message | Message d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedRelations | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant non inclus dans la liste du corps relations de la demande à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedRelations.className | sys_class_name de ce CI de relation dépendante supplémentaire. Seule valeur prise en charge :
Type de données : chaîne |
| result.additionalCommittedRelations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : nombre |
| résultat.additionalRelationsEngagées.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionalRelationsEngagées.errors.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.errors.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante supplémentaire. Type de données : tableau |
| result.additionalCommittedRelations.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedRelations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionnellesRelationsEngagées.opération | Opération exécutée pour ce CI de relation dépendante supplémentaire. Valeurs possibles :
Type de données : chaîne |
| éléments.résultats | Tableau d’objets dans lequel chaque objet décrit un CI inclus dans le tableau de corps items de la demande. Type de données : tableau |
| result.items.additionalRelatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) de la table Charges utiles partielles IRE [cmdb_ire_partial_payloads] CMDB. Type de données : tableau |
| result.items.additionalRelatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.additionalRelatedItems.inputIndex | Tableau des valeurs d’index des CI du tableau de corps items de la demande qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.additionalRelatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées au cours du traitement de cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.sysId | sys_id de ce CI connexe. Type de données : chaîne |
| result.items.className | sys_class_name de ce CI. Type de données : chaîne |
| result.items.duplicateLookupIndex | Objet contenant des tableaux de valeurs d’index pour items.lookup les éléments de tableau qui font référence au même CI associé. Le nom du tableau indique le premier élément du tableau de corps items.lookup de la demande qui fait référence à un CI connexe donné. Ses valeurs correspondent à l’ensemble des éléments supplémentaires du même tableau qui font référence au même CI associé. Type de données : objet Cet exemple montre un cas où le deuxième élément du items.lookup tableau fait référence au même CI connexe qu’un élément ultérieur de ce tableau : |
| result.items.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI. Type de données : nombre |
| résultat.éléments.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.errors.message | Message d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI. Type de données : tableau |
| result.items.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI. Valeurs possibles :
Type de données : chaîne |
| result.items.identificationAttempts.attributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.hybridEntryCiAttributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI. Valeurs notables :
Type de données : chaîne |
| result.items.info | Liste d’objets contenant des informations supplémentaires sur le traitement de l’élément. Type de données : tableau |
| résultat.articles.info.code | Type de reclassification qui a été ignoré. Valeurs possibles :
|
| résultat.éléments.info.message | Message qui fournit des informations supplémentaires sur le motif de l’omission de la reclassification. Type de données : chaîne |
| result.items.info.ruleSysId | Sys_id de la règle de restriction de reclassification qui a été mise en correspondance. Applicable uniquement lorsque le moteur IRE ignore la reclassification en raison de la règle de restriction de classification. Cette valeur est vide si la reclassification est ignorée en raison d’une charge utile ou d’un marqueur global. Type de données : chaîne |
| result.items.inputIndex | Tableau des valeurs d’index pour les CI provenant du tableau du corps items de la demande correspondant à ce CI. Type de données : tableau |
| resultat.éléments.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.mergedPayloadIds | Tableau des valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées au cours du traitement de ce CI. Type de données : tableau |
| résultat.éléments.opération | Opération exécutée pour ce CI. Valeurs possibles :
Type de données : chaîne |
| result.items.relatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) à partir du tableau de corps items.lookup de la demande. Type de données : tableau |
| result.items.relatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.relatedItems.inputIndex | Tableau des valeurs d’index pour les CI et les éléments de recherche dans le corps items de la demande et items.lookup les tableaux qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.relatedItems.inputIndices.mainIndex | Valeur d’index du tableau de corps items de la demande qui correspond au parent CI de l’élément connexe. Type de données : nombre |
| result.items.relatedItems.inputIndices.subIndex | Valeur d’index du tableau de corps items.lookup de la demande qui correspond à l’élément connexe. Type de données : nombre |
| result.items.relatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.relatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les entrées de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées dans ce CI pendant le traitement. Type de données : tableau |
| result.items.relatedSysIds | Tableau des valeurs de sys_id pour les éléments connexes (éléments de recherche de table) provenant du tableau de corps items.lookup de la demande. Type de données : tableau Valeurs notables :
|
| result.items.sysId | La sys_id trouvée pour ce CI grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| resultat.éléments.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| résultat.éléments.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.logContextId | ID de contexte signalé pour cette charge utile. Type de données : chaîne |
| relations.résultats | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant du tableau de corps relations de la demande. Type de données : tableau |
| result.relations.className | La sys_class_name de ce CI de relation dépendante. Seule valeur prise en charge :
Type de données : chaîne |
| result.relations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante. Type de données : nombre |
| result.relations.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| resultat.relations.erreurs.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| result.relations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante. Type de données : tableau |
| result.relations.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.relations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.opération | Opération exécutée pour ce CI de relation dépendant. Valeurs possibles :
Type de données : chaîne |
| résultats.relations.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| résultat.relations.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
Demande cURL
Envoyez une charge utile partielle pour un CI d’ordinateur.
curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{ \
"items" : [ \
{ \
"className" : "cmdb_ci_computer", \
"sys_object_source_info" : { \
"source_name" : "ServiceNow", \
"source_native_key" : "ncomputer3367" \
}, \
"values" : { \
"cpu_core_count" : "6", \
"ram" : "8192", \
"manufacturer" : "DELL", \
"company" : "My Company" \
} \
} \
] \
}'
La réponse montre que la charge utile a été insérée dans la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads].
{
"result": {
"items": [{
"className": "cmdb_ci_computer",
"operation": "INSERT_AS_PARTIAL",
"sysId": "Unknown",
"partialSysIds": ["1aec79151bb45010593876a61a4bcb28"],
"identifierEntrySysId": "Unknown",
"errors": [],
"warnings": [{
"error": "MISSING_MATCHING_ATTRIBUTES",
"message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'"
}],
"identificationAttempts": [{
"info": "sys_object_source NO_MATCH",
"identifierName": "",
"attemptResult": "NO_MATCH",
"attributes": [],
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number", "serial_number_type"],
"searchOnTable": "cmdb_serial_number",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["serial_number"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["name"],
"searchOnTable": "cmdb_ci_hardware",
"hybridEntryCiAttributes": []
}, {
"identifierName": "Hardware Rule",
"attemptResult": "SKIPPED",
"attributes": ["mac_address", "name"],
"searchOnTable": "cmdb_ci_network_adapter",
"hybridEntryCiAttributes": []
}],
"errorCount": 0,
"markers": [],
"warningCount": 1,
"mergedPayloadIds": ["7ddcb9551bb45010593876a61a4bcb08"],
"inputIndices": [0]
}],
"additionalCommittedItems": [],
"relations": [],
"additionalCommittedRelations": []
}
}
Soumettez une deuxième charge utile partielle qui complète la description du CI de l’ordinateur, avec l’option IRE amélioré de génération de synthèse activée.
curl "https://instance.servicenow.com/api/now/identifyreconcile/enhanced?options=generate_summary:true" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{ \
}'
La réponse indique que le CI de l’ordinateur est inséré et affiche un résumé des opérations effectuées.
{
"result": {
"relations": [],
"hasError": false,
"additionalCommittedItems": [],
"hasWarning": false,
"items": [
{
"relatedSysIds": [
"735c79151bb45010593876a61a4bcb67"
],
"identifierEntrySysId": "Unknown",
"sysId": "ff5c79151bb45010593876a61a4bcb64",
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_computer",
"inputIndices": [
0
],
"operation": "INSERT",
"relatedItems": [
{
"operation": "INSERT",
"warningCount": 0,
"errors": [],
"sysId": "735c79151bb45010593876a61a4bcb67",
"className": "cmdb_ci_network_adapter",
"errorCount": 0,
"markers": [],
"inputIndices": [
{
"subIndex": 0,
"mainIndex": 0
}
],
"mergedPayloadIds": []
}
],
"mergedPayloadIds": [
"fe4c39151bb45010593876a61a4bcbd3"
],
"identificationAttempts": [
{
"info": "sys_object_source NO_MATCH",
"attemptResult": "NO_MATCH",
"identifierName": "",
"attributes": [],
"hybridEntryCiAttributes": []
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "NO_MATCH",
"identifierName": "Hardware Rule",
"attributes": [
"mac_address",
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_network_adapter"
}
],
"warningCount": 0
}
],
"additionalCommittedRelations": [],
"summary": {
"cmdb_ci_network_adapter": {
"mergedPartialPayloads": 0,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
},
"cmdb_ci_computer": {
"mergedPartialPayloads": 1,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
}
}
}
}
Identification et réconciliation : POST /now/identifyreconcile/query
Détermine l’opération CMDB (insertion/mise à jour) à effectuer avec la charge utile spécifiée (corps de la demande), sans valider les opérations dans la base de données.
Utilisez ce point de terminaison pour simuler la soumission d’une charge utile (corps de la Identification et réconciliation : POST /now/identifyreconcile demande) au point de terminaison.
Utilisez le Identification et réconciliation : POST /now/identifyreconcile/enhanced point de terminaison à la place si vous devez spécifier des options IRE améliorées. Pour en savoir plus sur les options IRE améliorées, consultez Moteur Identification et réconciliation (IRE).
Format d'URL
URL versionnée : /api/now/{api_version}/identifyreconcile/query
URL par défaut : /api/now/identifyreconcile/query
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| sysparm_data_source | Identifie la source des informations sur le CI. Il doit s’agir de l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne Par défaut : insérez la charge utile de l’API dans la table des charges utiles incomplètes. |
| Nom | Description |
|---|---|
| Éléments | Tableau d’objets dans lequel chaque objet décrit un CI à créer ou à mettre à jour. Type de données : tableau |
| items.className | Requis. sys_class_name (nom de classe/table) du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB table, comme cmdb_ci_linux_server ou cmdb_ci_win_server. Type de données : chaîne |
| items.internal_id | Identificateur unique de cet élément dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.rechercher | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’identification basé sur la recherche. Ces enregistrements sont utilisés pour identifier l’élément de configuration de niveau supérieur en fonction d’une table de recherche qui fait référence à la table Élément de configuration [cmdb_ci]. Type de données : tableau |
| items.lookup.className | Requis. sys_class_name ou nom de classe/table du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB classe/table, telle que cmdb_serial_number ou cmdb_ci_network_adapter, ou une classe nonCMDB hiérarchique. Type de données : chaîne |
| items.lookup.internal_id | Identificateur unique pour cet enregistrement de recherche dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.lookup.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.lookup.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.recherche.valeurs | Objet décrivant les champs de cet élément de recherche sous forme de paires nom/valeur, où le nom est le nom du champ. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.connexes | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’élément à créer ou à mettre à jour, basé sur une table connexe qui fait référence au CI de niveau supérieur en cours d’identification. Les règles de la table Entrée connexe [cmdb_related_entry] définissent le type d’enregistrements que peut trouver ce tableau. La table associée peut étendre ou non la table Élément de configuration [cmdb_ci]. Ces enregistrements ne sont pas utilisés pour identifier l’élément de configuration. Type de données : tableau |
| items.related.className | Requis. Le nom de sys_class_name ou de classe/table de l’élément connexe à créer ou à mettre à jour. Type de données : chaîne |
| items.related.internal_id | Identificateur unique pour cet élément connexe dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.related.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.related.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie cet élément connexe. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.related.sys_object_source_info.source_name | Source de données pour les informations sur l’élément connexe. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.related.sys_object_source_info.source_native_key | Clé/ID unique de la source pour l’élément connexe. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.related.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles l’élément connexe a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| valeurs.connexes.éléments. | Objet décrivant les champs à créer ou à mettre à jour pour cet élément connexe en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.paramètres | Objet contenant des paramètres définissant les types de mises à jour autorisés. Type de données : objet |
| items.settings.skipReclassificationRestrictionRules | Marqueur indiquant si IRE doit ignorer l’exécution de la règle de restriction de classification qui correspond à la classe de l’élément de charge utile. Valeurs valides :
Valeur par défaut : false |
| items.settings.updateWithoutDowngrade | Indique si la mise à jour et le passage à une version antérieure sont autorisés pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutSwitch | Indique si ce CI peut être mis à jour et si sa classe peut être changée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutUpgrade | Indique si la mise à jour et la mise à niveau sont autorisées pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.sys_objet_source_info | Objet décrivant un identificateur de CI unique. Type de données : objet |
| items.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.valeurs | Objet décrivant les champs à créer ou à mettre à jour pour ce CI en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments de référence | Tableau d’objets dans lequel chaque objet décrit une référence entre deux éléments de la charge utile. Type de données : tableau |
| referenceItems.referenced | Défini internal_id pour l’élément référencé par un autre élément. Type de données : chaîne |
| referenceItems.referencedBy | Défini internal_id pour l’élément qui fait référence à un autre élément. Type de données : chaîne |
| referenceItems.referenceField | Nom du champ de référence dans la classe/table pour l’élément referencedBy . Type de données : chaîne |
| Relations | Tableau d’objets dans lequel chaque objet décrit une relation entre deux éléments définis dans la charge utile. Un objet de ce tableau peut utiliser l’un des deux formats suivants :
Type de données : tableau
|
| relations.enfant | L’index entier de l’objet CI dans le items tableau qui représente l’enfant dans la relation. Type de données : nombre |
| relations.child_id | L’élément internal_id enfant dans la relation. Type de données : chaîne |
| relations.parent | Index entier de l’objet CI dans le items tableau qui représente le parent dans la relation. Type de données : nombre |
| relations.parent_id | L’élément internal_id parent dans la relation. Type de données : chaîne |
| relations.sys_rel_source_info | Informations sur la source de détection pour la relation. Pour les relations de non-dépendance, ces informations se trouvent dans la table Sources de relation [sys_rel_source]. Type de données : objet |
| relations.sys_rel_source_info.source_name | Nom de la source de détection. Par défaut : source de détection transmise dans le paramètre de méthode d’API. |
| relations.sys_rel_source_info.source_feed | Toute chaîne qui est une sous-détection/analyse au sein de la source de détection. Par défaut : « INCONNU » est stocké dans la colonne source_feed lors de la création d’un enregistrement dans sys_rel_source table. |
| relations.type | Type de relation existant entre les éléments parents et enfants. Il doit s’agir d’une valeur de champ de nom de la table Type de relation CI [cmdb_rel_type]. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Tableau des résultats produits par la requête. Type de données : tableau |
| result.additionalCommittedItems | Tableau d’objets dans lequel chaque objet décrit un CI non inclus dans le corps de la demande items Tableau à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedItems.className | sys_class_name de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI supplémentaire. Type de données : nombre |
| résultat.additionalCommittedItems.errors | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.errors.error | Type d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errors.message | Message d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.attributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI supplémentaire. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.inputIndex | Tableau des valeurs d’index pour les CI du tableau de corps items de la demande qui correspondent à ce CI supplémentaire. Type de données : tableau |
| result.additionalCommittedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedItems.mergedPayloads | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées pendant le traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.operation | Opération effectuée pour ce CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.sysId | La sys_id trouvée pour ce CI supplémentaire grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.warnings | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.warnings.error | Type d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.warnings.message | Message d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedRelations | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant non inclus dans la liste du corps relations de la demande à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedRelations.className | sys_class_name de ce CI de relation dépendante supplémentaire. Seule valeur prise en charge :
Type de données : chaîne |
| result.additionalCommittedRelations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : nombre |
| résultat.additionalRelationsEngagées.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionalRelationsEngagées.errors.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.errors.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante supplémentaire. Type de données : tableau |
| result.additionalCommittedRelations.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedRelations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionnellesRelationsEngagées.opération | Opération exécutée pour ce CI de relation dépendante supplémentaire. Valeurs possibles :
Type de données : chaîne |
| éléments.résultats | Tableau d’objets dans lequel chaque objet décrit un CI inclus dans le tableau de corps items de la demande. Type de données : tableau |
| result.items.additionalRelatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) de la table Charges utiles partielles IRE [cmdb_ire_partial_payloads] CMDB. Type de données : tableau |
| result.items.additionalRelatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.additionalRelatedItems.inputIndex | Tableau des valeurs d’index des CI du tableau de corps items de la demande qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.additionalRelatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées au cours du traitement de cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.sysId | sys_id de ce CI connexe. Type de données : chaîne |
| result.items.className | sys_class_name de ce CI. Type de données : chaîne |
| result.items.duplicateLookupIndex | Objet contenant des tableaux de valeurs d’index pour items.lookup les éléments de tableau qui font référence au même CI associé. Le nom du tableau indique le premier élément du tableau de corps items.lookup de la demande qui fait référence à un CI connexe donné. Ses valeurs correspondent à l’ensemble des éléments supplémentaires du même tableau qui font référence au même CI associé. Type de données : objet Cet exemple montre un cas où le deuxième élément du items.lookup tableau fait référence au même CI connexe qu’un élément ultérieur de ce tableau : |
| result.items.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI. Type de données : nombre |
| résultat.éléments.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.errors.message | Message d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI. Type de données : tableau |
| result.items.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI. Valeurs possibles :
Type de données : chaîne |
| result.items.identificationAttempts.attributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.hybridEntryCiAttributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI. Valeurs notables :
Type de données : chaîne |
| result.items.info | Liste d’objets contenant des informations supplémentaires sur le traitement de l’élément. Type de données : tableau |
| résultat.articles.info.code | Type de reclassification qui a été ignoré. Valeurs possibles :
|
| résultat.éléments.info.message | Message qui fournit des informations supplémentaires sur le motif de l’omission de la reclassification. Type de données : chaîne |
| result.items.info.ruleSysId | Sys_id de la règle de restriction de reclassification qui a été mise en correspondance. Applicable uniquement lorsque le moteur IRE ignore la reclassification en raison de la règle de restriction de classification. Cette valeur est vide si la reclassification est ignorée en raison d’une charge utile ou d’un marqueur global. Type de données : chaîne |
| result.items.inputIndex | Tableau des valeurs d’index pour les CI provenant du tableau du corps items de la demande correspondant à ce CI. Type de données : tableau |
| resultat.éléments.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.mergedPayloadIds | Tableau des valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées au cours du traitement de ce CI. Type de données : tableau |
| résultat.éléments.opération | Opération exécutée pour ce CI. Valeurs possibles :
Type de données : chaîne |
| result.items.relatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) à partir du tableau de corps items.lookup de la demande. Type de données : tableau |
| result.items.relatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.relatedItems.inputIndex | Tableau des valeurs d’index pour les CI et les éléments de recherche dans le corps items de la demande et items.lookup les tableaux qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.relatedItems.inputIndices.mainIndex | Valeur d’index du tableau de corps items de la demande qui correspond au parent CI de l’élément connexe. Type de données : nombre |
| result.items.relatedItems.inputIndices.subIndex | Valeur d’index du tableau de corps items.lookup de la demande qui correspond à l’élément connexe. Type de données : nombre |
| result.items.relatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.relatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les entrées de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées dans ce CI pendant le traitement. Type de données : tableau |
| result.items.relatedSysIds | Tableau des valeurs de sys_id pour les éléments connexes (éléments de recherche de table) provenant du tableau de corps items.lookup de la demande. Type de données : tableau Valeurs notables :
|
| result.items.sysId | La sys_id trouvée pour ce CI grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| resultat.éléments.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| résultat.éléments.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.logContextId | ID de contexte signalé pour cette charge utile. Type de données : chaîne |
| relations.résultats | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant du tableau de corps relations de la demande. Type de données : tableau |
| result.relations.className | La sys_class_name de ce CI de relation dépendante. Seule valeur prise en charge :
Type de données : chaîne |
| result.relations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante. Type de données : nombre |
| result.relations.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| resultat.relations.erreurs.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| result.relations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante. Type de données : tableau |
| result.relations.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.relations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.opération | Opération exécutée pour ce CI de relation dépendant. Valeurs possibles :
Type de données : chaîne |
| résultats.relations.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| résultat.relations.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
Demande cURL
Simulez la soumission d’une charge utile contenant un serveur Linux (avec des recherches d’éléments connexes pour les numéros de série et les cartes réseau) et un commutateur IP, avec une relation de connexion IP entre eux.
curl "https://instance.servicenow.com/api/now/identifyreconcile/query" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{ \
"items": [{ \
"className": "cmdb_ci_linux_server", \
"values": { \
"sys_class_name": "cmdb_ci_linux_server", \
"name": "lnux101", \
"host_name": "lnux101.servicenow.com", \
"ip_address": "10.11.12.173", \
"os_name": "Linux Red Hat" \
}, \
"lookup": [{ \
"className": "cmdb_serial_number", \
"values": { \
"serial_number": "lnux101", \
"serial_number_type": "uuid", \
"valid": "true" \
} \
}, { \
"className": "cmdb_ci_network_adapter", \
"values": { \
"name": "eth0", \
"ip_address": "10.11.12.173", \
"mac_address": "00:55:51:21:26:2f" \
} \
}] \
}, { \
"className": "cmdb_ci_ip_switch", \
"values": { \
"name": "IP-Switch-1", \
"serial_number": "Switch23587", \
"serial_number_type": "uuid" \
} \
}], \
"relations": [{ \
"parent": 0, \
"child": 1, \
"type": "IP Connection::IP Connection" \
}] \
}'
Le CI du serveur Linux est identifié via une recherche de règle de matériel pour son nom dans la table Matériel [cmdb_ci_hardware] et est traité comme une mise à jour d’un CI existant dans la table du serveur Linux [cmdb_ci_linux_server]. Le commutateur IP est identifié de la même façon via une recherche de règle de matériel pour son nom dans la table Matériel et met à jour un CI existant dans la table Commutateur IP [cmdb_ci_ip_switch]. Enfin, la relation de connexion IP entre le serveur et le commutateur est insérée en tant que nouvel enregistrement dans la table Relations CI [cmdb_rel_ci].
{
"result": {
"relations": [
{
"operation": "INSERT",
"mergedPayloadIds": [],
"className": "cmdb_rel_ci",
"errorCount": 0,
"markers": [],
"inputIndices": [
0
]
}
],
"items": [
{
"relatedSysIds": [
null,
null
],
"identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
"sysId": "539747cac0a801640163e60735fbbf6e",
"errorCount": 0,
"markers": [],
"identificationAttempts": [
{
"attemptResult": "NO_MATCH",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "MATCHED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
}
],
"inputIndices": [
0
],
"additionalRelatedItems": [],
"operation": "UPDATE",
"relatedItems": [
{
"markers": [],
"mergedPayloadIds": [],
"inputIndices": [
{
"subIndex": 0,
"mainIndex": 0
}
],
"className": "cmdb_serial_number"
},
{
"markers": [],
"mergedPayloadIds": [],
"inputIndices": [
{
"subIndex": 1,
"mainIndex": 0
}
],
"className": "cmdb_ci_network_adapter"
}
],
"mergedPayloadIds": [],
"className": "cmdb_ci_linux_server"
},
{
"operation": "UPDATE",
"identifierEntrySysId": "556eb250c3400200d8d4bea192d3ae92",
"mergedPayloadIds": [],
"sysId": "304481257f701200bee45f19befa915b",
"identificationAttempts": [
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "NO_MATCH",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "MATCHED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
}
],
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_ip_switch",
"inputIndices": [
1
]
}
],
"additionalCommittedRelations": [],
"additionalCommittedItems": []
}
}
Identification et réconciliation : POST /now/identifyreconcile/queryEnhanced
Détermine l’opération CMDB (insertion/mise à jour) à effectuer avec la charge utile spécifiée (corps de la demande), sans valider les opérations dans la base de données.
Utilisez ce point de terminaison pour simuler la soumission d’une charge utile (corps de la Identification et réconciliation : POST /now/identifyreconcile/enhanced demande) au point de terminaison.
- Charges utiles partielles
- Dans le cas d’un avertissement ou d’une erreur pour un élément, indique si une opération d’élément est INSERT_AS_PARTIAL ou INSERT_INCOMPLETE.
- Renvoie la sys_ids des charges utiles partielles qui ont été fusionnées avec les charges utiles partielles existantes.
- Prend en charge la fonctionnalité de déduplication de charge utile.
- Génère un résumé.
Format d'URL
URL versionnée : /api/now/{api_version}/identifyreconcile/queryEnhanced
URL par défaut : /api/now/identifyreconcile/queryEnhanced
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| options | Liste de paires nom-valeur séparées par des virgules représentant les options IRE améliorées appliquées pour la demande. Par exemple, pour remplacer les valeurs par défaut des charges utiles partielles, des validations partielles, des charges utiles dédupliquées et générer des options IRE améliorées : partial_payloads :faux,partial_commits :faux,deduplicate_payloads :faux,generate_summary :vrai Remarque : Par défaut ou si partial_payloads est défini sur vrai, les deux partial_commits et deduplicate_payloads sont activés, même s’ils sont définis sur faux, car ces fonctionnalités sont essentielles pour la fonctionnalité des charges utiles partielles. Pour en savoir plus sur les options IRE améliorées, consultez Moteur Identification et réconciliation (IRE). Valeurs valides pour chaque paire nom-valeur :
Type de données : chaîne |
| sysparm_data_source | Identifie la source des informations sur le CI. Il doit s’agir de l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne Par défaut : insérez la charge utile de l’API dans la table des charges utiles incomplètes. |
| Nom | Description |
|---|---|
| Éléments | Tableau d’objets dans lequel chaque objet décrit un CI à créer ou à mettre à jour. Type de données : tableau |
| items.className | Requis. sys_class_name (nom de classe/table) du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB table, comme cmdb_ci_linux_server ou cmdb_ci_win_server. Type de données : chaîne |
| items.internal_id | Identificateur unique de cet élément dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.rechercher | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’identification basé sur la recherche. Ces enregistrements sont utilisés pour identifier l’élément de configuration de niveau supérieur en fonction d’une table de recherche qui fait référence à la table Élément de configuration [cmdb_ci]. Type de données : tableau |
| items.lookup.className | Requis. sys_class_name ou nom de classe/table du CI à créer ou à mettre à jour. Cette valeur peut être n’importe quelle CMDB classe/table, telle que cmdb_serial_number ou cmdb_ci_network_adapter, ou une classe nonCMDB hiérarchique. Type de données : chaîne |
| items.lookup.internal_id | Identificateur unique pour cet enregistrement de recherche dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.lookup.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.lookup.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.lookup.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.recherche.valeurs | Objet décrivant les champs de cet élément de recherche sous forme de paires nom/valeur, où le nom est le nom du champ. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.connexes | Tableau d’objets dans lequel chaque objet décrit un enregistrement d’élément à créer ou à mettre à jour, basé sur une table connexe qui fait référence au CI de niveau supérieur en cours d’identification. Les règles de la table Entrée connexe [cmdb_related_entry] définissent le type d’enregistrements que peut trouver ce tableau. La table associée peut étendre ou non la table Élément de configuration [cmdb_ci]. Ces enregistrements ne sont pas utilisés pour identifier l’élément de configuration. Type de données : tableau |
| items.related.className | Requis. Le nom de sys_class_name ou de classe/table de l’élément connexe à créer ou à mettre à jour. Type de données : chaîne |
| items.related.internal_id | Identificateur unique pour cet élément connexe dans cette charge utile. Peut prendre n’importe quelle valeur, mais doit être unique dans la charge utile. Type de données : chaîne |
| items.related.sys_object_source_info | Objet décrivant un identificateur CI unique pour une source de données spécifiée. Différentes sources peuvent avoir des paires nom-valeur différentes pour le même CI. Type de données : objet |
| items.related.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie cet élément connexe. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.related.sys_object_source_info.source_name | Source de données pour les informations sur l’élément connexe. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.related.sys_object_source_info.source_native_key | Clé/ID unique de la source pour l’élément connexe. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.related.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles l’élément connexe a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| valeurs.connexes.éléments. | Objet décrivant les champs à créer ou à mettre à jour pour cet élément connexe en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments.paramètres | Objet contenant des paramètres définissant les types de mises à jour autorisés. Type de données : objet |
| items.settings.skipReclassificationRestrictionRules | Marqueur indiquant si IRE doit ignorer l’exécution de la règle de restriction de classification qui correspond à la classe de l’élément de charge utile. Valeurs valides :
Valeur par défaut : false |
| items.settings.updateWithoutDowngrade | Indique si la mise à jour et le passage à une version antérieure sont autorisés pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutSwitch | Indique si ce CI peut être mis à jour et si sa classe peut être changée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.settings.updateWithoutUpgrade | Indique si la mise à jour et la mise à niveau sont autorisées pour ce CI. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| items.sys_objet_source_info | Objet décrivant un identificateur de CI unique. Type de données : objet |
| items.sys_object_source_info.source_feed | Nom qui identifie de façon unique le flux qui envoie ce CI. À utiliser si la source peut avoir plusieurs flux. Type de données : chaîne |
| items.sys_object_source_info.source_name | Source de données pour les informations sur le CI. Cette valeur doit être l’une des valeurs de choix définies pour le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne |
| items.sys_object_source_info.source_native_key | Clé/ID unique de la source pour le CI. Peut être n’importe quelle chaîne unique à l’élément. Type de données : chaîne |
| items.sys_object_source_info.source_recency_timestamp | Date et heure UTC auxquelles le CI a été analysé. Type de données : chaîne Format : AAAA-MM-JJ hh :mm :ss |
| éléments.valeurs | Objet décrivant les champs à créer ou à mettre à jour pour ce CI en tant que paires nom/valeur, où le nom est le nom du champ. Pour un champ de référence, la valeur doit être le sys_id référencé. Type de données : objet Les noms et les types de champs dépendent des champs sélectionnés par l’utilisateur, tels que : |
| éléments de référence | Tableau d’objets dans lequel chaque objet décrit une référence entre deux éléments de la charge utile. Type de données : tableau |
| referenceItems.referenced | Défini internal_id pour l’élément référencé par un autre élément. Type de données : chaîne |
| referenceItems.referencedBy | Défini internal_id pour l’élément qui fait référence à un autre élément. Type de données : chaîne |
| referenceItems.referenceField | Nom du champ de référence dans la classe/table pour l’élément referencedBy . Type de données : chaîne |
| Relations | Tableau d’objets dans lequel chaque objet décrit une relation entre deux éléments définis dans la charge utile. Un objet de ce tableau peut utiliser l’un des deux formats suivants :
Type de données : tableau
|
| relations.enfant | L’index entier de l’objet CI dans le items tableau qui représente l’enfant dans la relation. Type de données : nombre |
| relations.child_id | L’élément internal_id enfant dans la relation. Type de données : chaîne |
| relations.parent | Index entier de l’objet CI dans le items tableau qui représente le parent dans la relation. Type de données : nombre |
| relations.parent_id | L’élément internal_id parent dans la relation. Type de données : chaîne |
| relations.sys_rel_source_info | Informations sur la source de détection pour la relation. Pour les relations de non-dépendance, ces informations se trouvent dans la table Sources de relation [sys_rel_source]. Type de données : objet |
| relations.sys_rel_source_info.source_name | Nom de la source de détection. Par défaut : source de détection transmise dans le paramètre de méthode d’API. |
| relations.sys_rel_source_info.source_feed | Toute chaîne qui est une sous-détection/analyse au sein de la source de détection. Par défaut : « INCONNU » est stocké dans la colonne source_feed lors de la création d’un enregistrement dans sys_rel_source table. |
| relations.type | Type de relation existant entre les éléments parents et enfants. Il doit s’agir d’une valeur de champ de nom de la table Type de relation CI [cmdb_rel_type]. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. Détail du message d’erreur « Chunk [...] is not a valid entry » indique que le paramètre de requête n’est options pas dans le format de paire nom-valeur correct. Par exemple, la spécification d’un options paramètre |
Paramètres de corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| résultat | Tableau des résultats produits par la requête. Type de données : tableau |
| result.additionalCommittedItems | Tableau d’objets dans lequel chaque objet décrit un CI non inclus dans le corps de la demande items Tableau à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedItems.className | sys_class_name de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI supplémentaire. Type de données : nombre |
| résultat.additionalCommittedItems.errors | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.errors.error | Type d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.errors.message | Message d’erreur rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.attributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.hybridEntryCiAttributes | Tableau des attributs d’entrée d’identificateur de CI utilisés lors de cette tentative d’identification de CI supplémentaire. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.additionalCommittedItems.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI supplémentaire. Type de données : chaîne |
| result.additionalCommittedItems.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI supplémentaire. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.inputIndex | Tableau des valeurs d’index pour les CI du tableau de corps items de la demande qui correspondent à ce CI supplémentaire. Type de données : tableau |
| result.additionalCommittedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedItems.mergedPayloads | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées pendant le traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.operation | Opération effectuée pour ce CI supplémentaire. Valeurs possibles :
Type de données : chaîne |
| result.additionalCommittedItems.sysId | La sys_id trouvée pour ce CI supplémentaire grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| result.additionalCommittedItems.warnings | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : tableau |
| résultat.additionalCommittedItems.warnings.error | Type d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedItems.warnings.message | Message d’avertissement rencontré lors du traitement de ce CI supplémentaire. Type de données : chaîne |
| résultat.additionalCommittedRelations | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant non inclus dans la liste du corps relations de la demande à insérer ou à mettre à jour. Type de données : tableau |
| result.additionalCommittedRelations.className | sys_class_name de ce CI de relation dépendante supplémentaire. Seule valeur prise en charge :
Type de données : chaîne |
| result.additionalCommittedRelations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : nombre |
| résultat.additionalRelationsEngagées.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionalRelationsEngagées.errors.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.errors.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante supplémentaire. Type de données : chaîne |
| result.additionalCommittedRelations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante supplémentaire. Type de données : tableau |
| result.additionalCommittedRelations.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.additionalCommittedRelations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante supplémentaire. Type de données : tableau |
| résultat.additionnellesRelationsEngagées.opération | Opération exécutée pour ce CI de relation dépendante supplémentaire. Valeurs possibles :
Type de données : chaîne |
| éléments.résultats | Tableau d’objets dans lequel chaque objet décrit un CI inclus dans le tableau de corps items de la demande. Type de données : tableau |
| result.items.additionalRelatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) de la table Charges utiles partielles IRE [cmdb_ire_partial_payloads] CMDB. Type de données : tableau |
| result.items.additionalRelatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.additionalRelatedItems.inputIndex | Tableau des valeurs d’index des CI du tableau de corps items de la demande qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.additionalRelatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées au cours du traitement de cet élément connexe. Type de données : tableau |
| result.items.additionalRelatedItems.sysId | sys_id de ce CI connexe. Type de données : chaîne |
| result.items.className | sys_class_name de ce CI. Type de données : chaîne |
| result.items.duplicateLookupIndex | Objet contenant des tableaux de valeurs d’index pour items.lookup les éléments de tableau qui font référence au même CI associé. Le nom du tableau indique le premier élément du tableau de corps items.lookup de la demande qui fait référence à un CI connexe donné. Ses valeurs correspondent à l’ensemble des éléments supplémentaires du même tableau qui font référence au même CI associé. Type de données : objet Cet exemple montre un cas où le deuxième élément du items.lookup tableau fait référence au même CI connexe qu’un élément ultérieur de ce tableau : |
| result.items.errorCount | Nombre d’erreurs rencontrées lors du traitement de ce CI. Type de données : nombre |
| résultat.éléments.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.errors.message | Message d’erreur rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.items.identificationAttempts | Tableau d’objets dans lequel chaque objet décrit une tentative d’identification de ce CI. Type de données : tableau |
| result.items.identificationAttempts.attemptResult | Résultat de cette tentative d’identification de CI. Valeurs possibles :
Type de données : chaîne |
| result.items.identificationAttempts.attributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.hybridEntryCiAttributes | Tableau d’attributs d’entrée d’identificateur CI utilisés pendant cette tentative d’identification CI. Type de données : tableau Les noms et types d’attributs dépendent des données du corps de la demande et de l’identificateur utilisé, par exemple : |
| result.items.identificationAttempts.identifierName | Règle d’identificateur utilisée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identificationAttempts.searchOnTable | Nom de la table recherchée pour cette tentative d’identification de CI. Type de données : chaîne |
| result.items.identifierEntrySysId | sys_id de la règle d’identificateur utilisée pour identifier ce CI. Valeurs notables :
Type de données : chaîne |
| result.items.info | Liste d’objets contenant des informations supplémentaires sur le traitement de l’élément. Type de données : tableau |
| résultat.articles.info.code | Type de reclassification qui a été ignoré. Valeurs possibles :
|
| résultat.éléments.info.message | Message qui fournit des informations supplémentaires sur le motif de l’omission de la reclassification. Type de données : chaîne |
| result.items.info.ruleSysId | Sys_id de la règle de restriction de reclassification qui a été mise en correspondance. Applicable uniquement lorsque le moteur IRE ignore la reclassification en raison de la règle de restriction de classification. Cette valeur est vide si la reclassification est ignorée en raison d’une charge utile ou d’un marqueur global. Type de données : chaîne |
| result.items.inputIndex | Tableau des valeurs d’index pour les CI provenant du tableau du corps items de la demande correspondant à ce CI. Type de données : tableau |
| resultat.éléments.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.mergedPayloadIds | Tableau des valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles [cmdb_ire_partial_payloads] IRE CMDB qui ont été fusionnées au cours du traitement de ce CI. Type de données : tableau |
| résultat.éléments.opération | Opération exécutée pour ce CI. Valeurs possibles :
Type de données : chaîne |
| result.items.relatedItems | Tableau d’objets dans lequel chaque objet décrit un CI connexe (CI de recherche de table) à partir du tableau de corps items.lookup de la demande. Type de données : tableau |
| result.items.relatedItems.className | sys_class_name de l’élément connexe. Type de données : chaîne |
| result.items.relatedItems.inputIndex | Tableau des valeurs d’index pour les CI et les éléments de recherche dans le corps items de la demande et items.lookup les tableaux qui correspondent à cet élément connexe. Type de données : tableau |
| result.items.relatedItems.inputIndices.mainIndex | Valeur d’index du tableau de corps items de la demande qui correspond au parent CI de l’élément connexe. Type de données : nombre |
| result.items.relatedItems.inputIndices.subIndex | Valeur d’index du tableau de corps items.lookup de la demande qui correspond à l’élément connexe. Type de données : nombre |
| result.items.relatedItems.markers | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.items.relatedItems.mergedPayloadIds | Tableau de valeurs sys_id pour les entrées de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées dans ce CI pendant le traitement. Type de données : tableau |
| result.items.relatedSysIds | Tableau des valeurs de sys_id pour les éléments connexes (éléments de recherche de table) provenant du tableau de corps items.lookup de la demande. Type de données : tableau Valeurs notables :
|
| result.items.sysId | La sys_id trouvée pour ce CI grâce à l’identification. Valeurs notables :
Type de données : chaîne |
| resultat.éléments.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI. Type de données : tableau |
| résultat.éléments.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| résultat.éléments.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI. Type de données : chaîne |
| result.logContextId | ID de contexte signalé pour cette charge utile. Type de données : chaîne |
| relations.résultats | Tableau d’objets dans lequel chaque objet décrit un CI de relation dépendant du tableau de corps relations de la demande. Type de données : tableau |
| result.relations.className | La sys_class_name de ce CI de relation dépendante. Seule valeur prise en charge :
Type de données : chaîne |
| result.relations.errorCount | Le nombre d’erreurs rencontrées lors du traitement de ce CI de relation dépendante. Type de données : nombre |
| result.relations.erreurs | Tableau d’objets dans lequel chaque objet décrit une erreur rencontrée lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.erreurs.erreur | Type d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| resultat.relations.erreurs.message | Message d’erreur rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| result.relations.inputIndex | Tableau des valeurs d’index pour les objets CI de relation dépendante dans le tableau de corps relations de la demande qui correspondent à ce CI de relation dépendante. Type de données : tableau |
| result.relations.marqueurs | Tableau de valeurs de marqueurs pour une utilisation interne. Type de données : tableau |
| result.relations.mergedPayloadIds | Tableau de valeurs d’sys_id pour les charges utiles partielles de la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads] qui ont été fusionnées pendant le traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.opération | Opération exécutée pour ce CI de relation dépendant. Valeurs possibles :
Type de données : chaîne |
| résultats.relations.avertissements | Tableau d’objets dans lequel chaque objet décrit un avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : tableau |
| résultat.relations.avertissements.erreur | Type d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
| résultat.relations.avertissements.message | Message d’avertissement rencontré lors du traitement de ce CI de relation dépendante. Type de données : chaîne |
Demande cURL
Simulez la soumission d’une charge utile partielle pour un CI d’ordinateur.
curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data '{ \
"items" : [ \
{ \
"className" : "cmdb_ci_computer", \
"sys_object_source_info" : { \
"source_name" : "ServiceNow", \
"source_native_key" : "ncomputer3367" \
}, \
"values" : { \
"cpu_core_count" : "6", \
"ram" : "8192", \
"manufacturer" : "DELL", \
"company" : "My Company" \
} \
} \
] \
}'
La réponse indique que la charge utile sera insérée dans la table Charges utiles partielles IRE CMDB [cmdb_ire_partial_payloads].
{
"result": {
"relations": [],
"items": [
{
"identifierEntrySysId": "Unknown",
"partialSysIds": [
"1aec79151bb45010593876a61a4bcb28"
],
"sysId": "Unknown",
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_computer",
"inputIndices": [
0
],
"operation": "INSERT_AS_PARTIAL",
"errors": [],
"identificationAttempts": [
{
"info": "sys_object_source NO_MATCH",
"attemptResult": "NO_MATCH",
"identifierName": "",
"attributes": [],
"hybridEntryCiAttributes": []
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"mac_address",
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_network_adapter"
}
],
"warningCount": 1,
"warnings": [
{
"message": "In payload missing minimum set of input values for criterion (matching) attributes from identify rule for table [cmdb_ci_hardware]. Add these input values in payload item '{\"className\":\"cmdb_ci_computer\",\"values\":{\"discovery_source\":\"ServiceNow\",\"company\":\"My Company\",\"cpu_core_count\":\"6\",\"ram\":\"8192\",\"manufacturer\":\"DELL\"},\"sys_object_source_info\":{\"source_name\":\"ServiceNow\",\"source_native_key\":\"ncomputer3367\"},\"settings\":{},\"sys_ire_info\":{\"ire_received_time\":\"2020-05-14 20:14:51\"}}'",
"error": "MISSING_MATCHING_ATTRIBUTES"
}
],
"mergedPayloadIds": [
"7ddcb9551bb45010593876a61a4bcb08"
]
}
],
"additionalCommittedRelations": [],
"additionalCommittedItems": []
}
}
Simulez la soumission d’une deuxième charge utile partielle qui compléterait la description du CI de l’ordinateur, avec l’option IRE améliorée de génération de synthèse activée.
curl "https://instance.servicenow.com/api/now/identifyreconcile/queryEnhanced?options=generate_summary:true" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username:password" \
--data '{ \
}'
La réponse indique que le CI de l’ordinateur sera inséré et affiche un résumé des opérations qui seront effectuées.
{
"result": {
"relations": [],
"hasError": false,
"additionalCommittedItems": [],
"hasWarning": false,
"items": [
{
"relatedSysIds": [
"735c79151bb45010593876a61a4bcb67"
],
"identifierEntrySysId": "Unknown",
"sysId": "ff5c79151bb45010593876a61a4bcb64",
"errorCount": 0,
"markers": [],
"className": "cmdb_ci_computer",
"inputIndices": [
0
],
"operation": "INSERT",
"relatedItems": [
{
"operation": "INSERT",
"warningCount": 0,
"errors": [],
"sysId": "735c79151bb45010593876a61a4bcb67",
"className": "cmdb_ci_network_adapter",
"errorCount": 0,
"markers": [],
"inputIndices": [
{
"subIndex": 0,
"mainIndex": 0
}
],
"mergedPayloadIds": []
}
],
"mergedPayloadIds": [
"fe4c39151bb45010593876a61a4bcbd3"
],
"identificationAttempts": [
{
"info": "sys_object_source NO_MATCH",
"attemptResult": "NO_MATCH",
"identifierName": "",
"attributes": [],
"hybridEntryCiAttributes": []
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number",
"serial_number_type"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_serial_number"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"serial_number"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "SKIPPED",
"identifierName": "Hardware Rule",
"attributes": [
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_hardware"
},
{
"attemptResult": "NO_MATCH",
"identifierName": "Hardware Rule",
"attributes": [
"mac_address",
"name"
],
"hybridEntryCiAttributes": [],
"searchOnTable": "cmdb_ci_network_adapter"
}
],
"warningCount": 0
}
],
"additionalCommittedRelations": [],
"summary": {
"cmdb_ci_network_adapter": {
"mergedPartialPayloads": 0,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
},
"cmdb_ci_computer": {
"mergedPartialPayloads": 1,
"inserted": 1,
"partial": 0,
"warnings": 0,
"incomplete": 0,
"additionalInserted": 0,
"unchanged": 0,
"skipped": 0,
"updated": 0,
"errors": 0
}
}
}
}