API d’instance CMDB

CMDB Instance : DELETE /now/cmdb/instance/{classname}/{sys_id}/relation/{rel_sys_id}

Supprime la relation de l’élément de configuration (CI) spécifié.

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

URL par défaut : /api/now/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne
rel_sys_id	Sys_id de la relation à supprimer. Type de données : chaîne
sys_id	Sys_id du CI. Type de données : chaîne

Tableau 2. Paramètres de requête
Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
En-tête	Description
Néant

Tableau 5. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)


Nom	Description
Néant

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/0f4ac6c4b750230096c3e4f6ee11a9fe/relation/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--user 'username':'password'

CMDB Instance : GET /now/cmdb/instance/{classname}

Renvoie les éléments de configuration (CI) disponibles pour une classe spécifiée Base de données de gestion des configurations (CMDB) (table).

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}

URL par défaut : /api/now/cmdb/instance/{className}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
sysparm_limit	Nombre maximal d’enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement sysparm_offset . Cette limite est appliquée avant l’évaluation de l’ACL. Si aucun enregistrement ne revient, y compris les enregistrements auxquels vous avez accès, réorganisez l’ordre des enregistrements afin que les enregistrements auxquels vous avez accès reviennent en premier. Remarque : Des valeurs anormalement élevées sysparm_limit peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 10 000
sysparm_offset	Démarrage de l’index d’enregistrement pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en petits blocs gérables. Par exemple, la première fois que vous appelez ce point sysparm_offset de terminaison est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez `sysparm_offset=sysparm_offset+sysparm_limit` jusqu’à ce que vous atteigniez la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_query	Requête codée utilisée pour filtrer l’ensemble de résultats. Vous pouvez utiliser un filtre d’interface utilisateur pour obtenir une requête correctement codée. Syntaxe : `sysparm_query=<col_name><operator><value>`. Les noms de colonnes, les opérateurs et les valeurs sont sensibles à la casse. <col_name> : nom de la colonne de table sur laquelle filtrer. <opérateur> : prend en charge les valeurs suivantes : `=` : <col_name> correspond exactement à <value>. `!=` : <col_name> ne correspond pas à <value>. `LIKE` : <col_name> contient la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. `STARTSWITH` : <col_name> commence par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. `ENDSWITH` : <col_name> se termine par la chaîne spécifiée <value>. Fonctionne uniquement pour les champs <col_name> dont le type de données est chaîne. `^` : opérateur AND pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats répondent aux deux conditions. `^OU` : opérateur OU pour ajouter une condition de requête supplémentaire. Les enregistrements inclus dans l’ensemble de résultats remplissent au moins une des conditions. < valeur > : valeur sur laquelle filtrer. Pour plus d’informations sur les opérateurs, reportez-vous à la section Operators available for filters and queries. Les requêtes peuvent contenir plusieurs conditions. Par exemple, la requête suivante renvoie les enregistrements où l’appelant est l’utilisateur actuel et où l’enregistrement est actif. `sysparm_query=caller_id=javascript :gs.getUserID()^active=true` Les requêtes codées prennent également en charge l’ordre par fonctionnalités croissantes et décroissantes. Pour trier les réponses en fonction de certains champs, utilisez les clauses `ORDERBY` et `ORDERBYDESC` dans sysparm_query. Syntaxe : `TRIER PAR<col_name>` `ORDERBYDESC<col_name>` Par exemple, la requête suivante obtient tous les enregistrements actifs et classe les résultats par ordre croissant par numéro, puis par ordre décroissant par catégorie. `sysparm_query=actif=vrai^ORDERBYNUMBER^ORDERBYDESCcategory` Par défaut, si une partie d’une requête n’est pas valide, comme un nom de champ non valide, l’instance ignore la partie non valide. Il renvoie ensuite les lignes en utilisant uniquement la partie valide de la requête. Définissez la propriété glide.invalid_query.returns_no_rows sur `true` pour ne renvoyer aucune ligne sur une requête non valide. Remarque : La glide.invalid_query.returns_no_rows propriété contrôle le comportement de toutes les requêtes dans l’instance, notamment dans les listes, les scripts (GlideRecord.query()) et les API de service Web. Type de données : chaîne

Tableau 9. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 10. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 11. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)


Nom	Description
nom	Nom d’un CI dans la classe spécifiée. Type de données : chaîne
sys_id	Sys_id du CI. Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

"result": [
  {
    "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
    "name": "PS LinuxApp01"
  },
  {
    "sys_id": "3a5dd3dbc0a8ce0100655f1ec66ed42c",
    "name": "PS LinuxApp02"
  }
]

CMDB Instance : GET /now/cmdb/instance/{classname}/{sys_id}

Renvoie les attributs et les informations de relation pour un enregistrement d’élément de configuration (CI) spécifié.

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}/{sys_id}

URL par défaut : /api/now/cmdb/instance/{className}/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne
sys_id	Sys_id de l’enregistrement CI à récupérer. Type de données : chaîne

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 16. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 17. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)

Tableau 19. Paramètres de réponse
Nom	Description
attributs	Attributs de données actuellement dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet `"error": { "detail": "String", "message": "String" }`
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
inbound_relations	Liste des objets qui définissent les relations entrantes associées au CI. Type de données : tableau `"inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
inbound_relations.sys_id	Sys_id de la relation CI entrante. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
inbound_relations.cible	Informations décrivant la relation entrante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.target.display_value	Nom de la relation entrante à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation entrante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
inbound_relations.valeur.cible.	Sys_id du CI entrant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Informations sur le type de relation entrante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.type.display_value	Nom du type entrant à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer le type de relation entrante à partir de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
inbound_relations.type.valeur	Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes associées au CI. Type de données : tableau `"outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
outbound_relations.sys_id	Sys_id de la relation CI sortant. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
outbound_relations.cible	Requis. Informations sur la relation sortante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.target.display_value	Nom de la relation sortante à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation sortante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
outbound_relations.valeur.cible.	Sys_id du CI sortant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Informations sur le type de relation sortante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.type.display_value	Nom du type sortant à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer la relation sortante de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
outbound_relations.type.valeur	Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "3a67513fc0a8ce0100914a76cea11b02",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Intranet",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-08 11:16:51",
      "discovery_source": "",
      "first_discovered": "",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "glide.maint",
      "warranty_expiration": "",
      "ram": "2048",
      "cpu_name": "",
      "cpu_speed": "2800",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "40",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "2020-01-04 07:00:00",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": {
        "display_value": "Lynda Caraway",
        "link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
        "value": "8a826bf03710200044e0bfc8bcbe5d72"
      },
      "os_domain": "",
      "last_discovered": "",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": {
        "display_value": "Iris",
        "link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
        "value": "c115c2f737e3100044e0bfc8bcbe5d46"
      },
      "cpu_count": "1",
      "vendor": {
        "display_value": "Cloudward Inc",
        "link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
        "value": "3efe8c4c37423000158bbfc8bcbe5d7d"
      },
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "2.6.9-22.0.1.ELsmp",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "P1000091 - Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
        "value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "system",
      "sys_created_on": "2008-10-26 17:17:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "Intel",
      "install_date": "2019-08-18 08:00:00",
      "asset_tag": "P1000091",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "false",
      "delivery_date": "",
      "hardware_status": "",
      "install_status": "1",
      "supported_by": "",
      "name": "PS LinuxApp01",
      "subcategory": "",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": {
        "display_value": "ACME Corporation",
        "link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
        "value": "e7c1f3d53790200044e0bfc8bcbe5deb"
      },
      "justification": "",
      "department": "",
      "cost": "45557.5",
      "comments": "",
      "os": "Linux Red Hat",
      "sys_mod_count": "24",
      "monitor": "false",
      "model_id": {
        "display_value": "Iris 5875",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
        "value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": {
        "display_value": "322 West 52nd Street, New York,NY",
        "link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
        "value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
      },
      "category": "Do not migrate to asset",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "3a5e4d8ac0a8ce010005145afb730818",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
          "value": "3a27d4370a0a0bb4006316812bf45439"
        }
      },
      {
        "sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache02",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
          "value": "3a27f1520a0a0bb400ecd6ff7afcf036"
        }
      },
      {
        "sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS Apache03",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
          "value": "3a2810c20a0a0bb400268337d6e942ca"
        }
      }
    ]
  }
}

CMDB Instance : POST /now/cmdb/instance/{classname}

Crée un élément de configuration (CI) unique avec les relations sortantes et entrantes spécifiées dans la table spécifiée Base de données de gestion des configurations (CMDB) .

Remarque :

Si une règle d’identification dépendante est définie pour la CMDB classe, la charge utile en entrée doit contenir les sys_id d’un CI existant. Par exemple, pour outbound_relations, le target paramètre doit contenir la sys_id d’un CI existant, qui devient alors l’enfant. Pour inbound_relations, il devient le parent.


  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}

URL par défaut : /api/now/cmdb/instance/{className}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 20. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne

Tableau 21. Paramètres de requête
Nom	Description
Néant

Tableau 22. Paramètres de corps de demande (XML ou JSON)
Nom	Description
attributs	Attributs de données à définir dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
inbound_relations	Liste des objets qui définissent les relations entrantes à associer au CI. Type de données : tableau `"inbound_relations": [ { "target": "String", "type": "String" } ]`
inbound_relations.cible	Requis si inbound_relations est spécifié. Sys_id de la relation entrante cible à associer au CI spécifié. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Requis si inbound_relations est spécifié. Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes à associer au CI. Type de données : tableau `"outbound_relations": [ { "target": "String", "type": "String" } ]`
outbound_relations.cible	Requis si outbound_relations est spécifié. Sys_id de la relation sortante cible. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Requis si outbound_relations est spécifié. Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
source	Requis. Entité qui a mis à jour les informations. Il doit s’agir de l’une des valeurs de choix spécifiées dans le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 23. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 24. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 25. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)

Tableau 26. Paramètres de réponse
Nom	Description
attributs	Attributs de données actuellement dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet `"error": { "detail": "String", "message": "String" }`
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
inbound_relations	Liste des objets qui définissent les relations entrantes associées au CI. Type de données : tableau `"inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
inbound_relations.sys_id	Sys_id de la relation CI entrante. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
inbound_relations.cible	Informations décrivant la relation entrante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.target.display_value	Nom de la relation entrante à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation entrante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
inbound_relations.valeur.cible.	Sys_id du CI entrant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Informations sur le type de relation entrante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.type.display_value	Nom du type entrant à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer le type de relation entrante à partir de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
inbound_relations.type.valeur	Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes associées au CI. Type de données : tableau `"outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
outbound_relations.sys_id	Sys_id de la relation CI sortant. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
outbound_relations.cible	Requis. Informations sur la relation sortante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.target.display_value	Nom de la relation sortante à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation sortante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
outbound_relations.valeur.cible.	Sys_id du CI sortant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Informations sur le type de relation sortante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.type.display_value	Nom du type sortant à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer la relation sortante de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
outbound_relations.type.valeur	Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "attributes": {
    "name" : "lnux999",
    "firewall_status": "Intranet"
  },
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Intranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:27:28",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:27:28",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": "",
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "lnux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "0",
            "monitor": "false",
            "model_id": "",
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison pour une classe qui a une règle d’identification dépendante définie. Ils outbound_relations.target doivent être inclus dans la charge utile et contenir les sys_id d’un CI existant.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations":
      {
        "target": "b4fd7c8437201000deeabfc8bcbe5dc1",
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
      }
    }
  }
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "505cfa3a53662110af64ddeeff7b1217",
        "type": {
          "display_value": "Runs on::Runs",
          "link": http://instance.servicenow.com/api/now/table/cmdb_rel_type/60bc4e22c0a8010e01f074cbe6bd73c3,
          "value": "60bc4e22c0a8010e01f074cbe6bd73c3"
        },
        "target": {
          "display_value": "*ANNIE-IBM",
          "link": http://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/b4fd7c8437201000deeabfc8bcbe5dc1,
          "value": "b4fd7c8437201000deeabfc8bcbe5dc1"
        }
      }
    ],
    "attributes": {
      "attested_date": "",
      "operational_status": "1",
      "running_process_command": "",
      "sys_updated_on": "2023-05-05 21:28:24",
      "type": "",
      "running_process_key_parameters": "",
      "rp_command_hash": "",
      "discovery_source": "ServiceNow",
      "first_discovered": "2023-05-05 21:28:24",
      "due_in": "",
      "service_pack": "",
      "used_for": "Production",
      "is_clustered": "false",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "admin",
      "warranty_expiration": "",
      "owned_by": "",
      "checked_out": "",
      "rp_key_parameters_hash": "",
      "sys_domain_path": "/",
      "business_unit": "",
      "version": "",
      "cpu_sockets": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "managed_by": "",
      "port_dynamic": "false",
      "last_discovered": "2023-05-05 21:28:24",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_db_mssql_instance",
      "manufacturer": "",
      "cl_port": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "config_file": "",
      "assigned_to": "",
      "start_date": "",
      "instance_name": "Iname",
      "serial_number": "",
      "engine_edition": "",
      "support_group": "",
      "version_name": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": "",
      "config_directory": "",
      "tcp_port": "",
      "listener_name": "",
      "skip_sync": "false",
      "pid": "",
      "attestation_score": "",
      "sys_updated_by": "admin",
      "install_directory": "",
      "sys_created_on": "2023-05-05 21:28:24",
      "sys_domain": {
        "display_value": "global",
        "link": http://instance.servicenow.com/api/now/table/sys_user_group/global,
        "value": "global"
      },
      "install_date": "",
      "asset_tag": "",
      "fqdn": "",
      "change_control": "",
      "delivery_date": "",
      "install_status": "1",
      "supported_by": "",
      "name": "test",
      "subcategory": "Database",
      "assignment_group": "",
      "edition": "",
      "managed_by_group": "",
      "sys_id": "185cba3a53662110af64ddeeff7b12af",
      "po_number": "",
      "database": "",
      "checked_in": "",
      "sys_class_path": "/!!/!(/!2/!,",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "attestation_status": "Not Yet Reviewed",
      "sys_mod_count": "0",
      "monitor": "false",
      "model_id": "",
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Resource",
      "fault_count": "0",
      "lease_id": ""
    },
    "inbound_relations": []
  }
}

Demande cURL

L’exemple de code suivant montre ce qui est renvoyé lorsqu’une sys_id n’est pas transmise pour une classe pour laquelle une règle d’identification dépendante est définie. Le même résultat se produit si l’sys_id n’est pas valide.

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data "{
  "attributes": {
    "name": "test",
    "sys_class_name":"cmdb_ci_db_mssql_instance",
    "instance_name":"Iname"
  },
  "source": "ServiceNow",
  "depends_on": {
    "outbound_relations": {
        "type": "60bc4e22c0a8010e01f074cbe6bd73c3"
    }
  }
}

{
  "error": {
    "detail": "Exception while executing request: null Check logs for error trace or enable glide.rest.debug property to verify REST request processing",
    "message": "Exception while executing request: null"
  },
  "status": "failure"
}

CMDB Instance : PUT /now/cmdb/instance/{classname}/{sys_id}

Met à jour l’enregistrement de l’élément de configuration (CI) spécifié avec les paires nom-valeur de l’attribut spécifié. Ce point de terminaison ne crée, ne met pas à jour ou ne supprime pas les relations associées.

Remarque :

Ce point de terminaison n’est pas conforme aux spécifications HTML. Les points de terminaison PUT standard sont destructeurs en ce sens qu’ils suppriment tous les éléments qui ne sont pas inclus dans la demande. Ce point de terminaison ne supprime pas les éléments non spécifiés.

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}/{sys_id}

URL par défaut : /api/now/cmdb/instance/{className}/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 27. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de CI à mettre à jour. Type de données : chaîne

Tableau 28. Paramètres de requête
Nom	Description
Néant

Tableau 29. Paramètres de corps de demande (XML ou JSON)
Nom	Description
attributs	Attributs de données à remplacer dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Pour en savoir plus sur l’attestation, reportez-vous à la section CIs attestation. Type de données : objet
source	Requis. Entité qui a mis à jour les informations. Il doit s’agir de l’une des valeurs de choix spécifiées dans le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 30. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 31. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 32. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)

Tableau 33. Paramètres de réponse
Nom	Description
attributs	Attributs de données actuellement dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet `"error": { "detail": "String", "message": "String" }`
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
inbound_relations	Liste des objets qui définissent les relations entrantes associées au CI. Type de données : tableau `"inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
inbound_relations.sys_id	Sys_id de la relation CI entrante. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
inbound_relations.cible	Informations décrivant la relation entrante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.target.display_value	Nom de la relation entrante à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation entrante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
inbound_relations.valeur.cible.	Sys_id du CI entrant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Informations sur le type de relation entrante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.type.display_value	Nom du type entrant à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer le type de relation entrante à partir de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
inbound_relations.type.valeur	Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes associées au CI. Type de données : tableau `"outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
outbound_relations.sys_id	Sys_id de la relation CI sortant. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
outbound_relations.cible	Requis. Informations sur la relation sortante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.target.display_value	Nom de la relation sortante à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation sortante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
outbound_relations.valeur.cible.	Sys_id du CI sortant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Informations sur le type de relation sortante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.type.display_value	Nom du type sortant à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer la relation sortante de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
outbound_relations.type.valeur	Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "attributes": {
    "firewall_status": "Extranet",
    "discovery_source": "ServiceNows",
    "name": "Linux299",
    "used_for": "Pre-production",
    "container": "Box"
  },
  "source": "ServiceNow"
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Extranet",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 20:59:40",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Pre-production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 20:59:40",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.service-now.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "3",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.service-now.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB Instance : POST /now/cmdb/instance/{classname}/{sys_id}/relation

Ajoute une relation entrante et/ou sortante à l’élément de configuration (CI) spécifié. Le CI spécifié est le parent.

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation

URL par défaut : /api/now/cmdb/instance/{className}/{sys_id}/relation

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 34. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de CI à mettre à jour. Type de données : chaîne

Tableau 35. Paramètres de requête
Nom	Description
Néant

Tableau 36. Paramètres de corps de demande (XML ou JSON)
Nom	Description
inbound_relations	Liste des objets qui définissent les relations entrantes à associer au CI. Type de données : tableau `"inbound_relations": [ { "target": "String", "type": "String" } ]`
inbound_relations.cible	Requis si inbound_relations est spécifié. Sys_id de la relation entrante cible à associer au CI spécifié. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Requis si inbound_relations est spécifié. Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes à associer au CI. Type de données : tableau `"outbound_relations": [ { "target": "String", "type": "String" } ]`
outbound_relations.cible	Requis si outbound_relations est spécifié. Sys_id de la relation sortante cible. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Requis si outbound_relations est spécifié. Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
source	Requis. Entité qui a mis à jour les informations. Il doit s’agir de l’une des valeurs de choix spécifiées dans le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 37. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 38. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 39. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)

Tableau 40. Paramètres de réponse
Nom	Description
attributs	Attributs de données actuellement dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet `"error": { "detail": "String", "message": "String" }`
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
inbound_relations	Liste des objets qui définissent les relations entrantes associées au CI. Type de données : tableau `"inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
inbound_relations.sys_id	Sys_id de la relation CI entrante. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
inbound_relations.cible	Informations décrivant la relation entrante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.target.display_value	Nom de la relation entrante à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation entrante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
inbound_relations.valeur.cible.	Sys_id du CI entrant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Informations sur le type de relation entrante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.type.display_value	Nom du type entrant à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer le type de relation entrante à partir de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
inbound_relations.type.valeur	Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes associées au CI. Type de données : tableau `"outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
outbound_relations.sys_id	Sys_id de la relation CI sortant. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
outbound_relations.cible	Requis. Informations sur la relation sortante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.target.display_value	Nom de la relation sortante à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation sortante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
outbound_relations.valeur.cible.	Sys_id du CI sortant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Informations sur le type de relation sortante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.type.display_value	Nom du type sortant à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer la relation sortante de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
outbound_relations.type.valeur	Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/3a290cc60a0a0bb400000bdb386af1cf/relation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
  "outbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    },
    {
      "type" : "607ad1b2c0a8010e01941856b365af90",
      "target" : "3a307c930a0a0bb400353965d0b8861f"
    }
  ],
  "source": "ServiceNow",
  "inbound_relations": [
    {
      "type" : "1a9cb166f1571100a92eb60da2bce5c5",
      "target" : "3a27d4370a0a0bb4006316812bf45439"
    }
  ]
}

{
    "result": {
        "outbound_relations": [
            {
                "sys_id": "403ff2641b425010593876a61a4bcb4b",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            },
            {
                "sys_id": "443ff2641b425010593876a61a4bcb4c",
                "type": {
                    "display_value": "Exchanges data with::Exchanges data with",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
                    "value": "607ad1b2c0a8010e01941856b365af90"
                },
                "target": {
                    "display_value": "PS ORA01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
                    "value": "3a307c930a0a0bb400353965d0b8861f"
                }
            }
        ],
        "attributes": {
            "firewall_status": "Active",
            "os_address_width": "",
            "attested_date": "",
            "operational_status": "1",
            "os_service_pack": "",
            "cpu_core_thread": "",
            "cpu_manufacturer": "",
            "sys_updated_on": "2020-07-13 21:24:05",
            "discovery_source": "ServiceNow",
            "first_discovered": "2020-07-13 20:27:28",
            "due_in": "",
            "used_for": "Production",
            "invoice_number": "",
            "gl_account": "",
            "sys_created_by": "dora.gray",
            "warranty_expiration": "",
            "ram": "",
            "cpu_name": "",
            "cpu_speed": "",
            "owned_by": "",
            "checked_out": "",
            "kernel_release": "",
            "sys_domain_path": "/",
            "classification": "Production",
            "disk_space": "",
            "object_id": "",
            "maintenance_schedule": "",
            "cost_center": "",
            "attested_by": "",
            "dns_domain": "",
            "assigned": "",
            "purchase_date": "",
            "life_cycle_stage": "",
            "short_description": "",
            "cd_speed": "",
            "floppy": "",
            "managed_by": "",
            "os_domain": "",
            "last_discovered": "2020-07-13 21:24:05",
            "can_print": "false",
            "sys_class_name": "cmdb_ci_linux_server",
            "manufacturer": "",
            "cpu_count": "",
            "vendor": "",
            "life_cycle_stage_status": "",
            "model_number": "",
            "assigned_to": "",
            "start_date": "",
            "os_version": "",
            "serial_number": "",
            "cd_rom": "false",
            "support_group": "",
            "unverified": "false",
            "correlation_id": "",
            "attributes": "",
            "asset": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
                "value": "21cfba641b425010593876a61a4bcb52"
            },
            "form_factor": "",
            "cpu_core_count": "",
            "skip_sync": "false",
            "attestation_score": "",
            "sys_updated_by": "dora.gray",
            "sys_created_on": "2020-07-13 20:27:28",
            "sys_domain": {
                "display_value": "global",
                "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
                "value": "global"
            },
            "cpu_type": "",
            "install_date": "",
            "asset_tag": "",
            "dr_backup": "",
            "hardware_substatus": "",
            "fqdn": "",
            "change_control": "",
            "internet_facing": "true",
            "delivery_date": "",
            "hardware_status": "installed",
            "install_status": "1",
            "supported_by": "",
            "name": "Linux299",
            "subcategory": "Computer",
            "default_gateway": "",
            "chassis_type": "",
            "virtual": "false",
            "assignment_group": "",
            "managed_by_group": "",
            "sys_id": "0c3ff2641b425010593876a61a4bcb39",
            "po_number": "",
            "checked_in": "",
            "sys_class_path": "/!!/!2/!(/!!/!0",
            "mac_address": "",
            "company": "",
            "justification": "",
            "department": "",
            "cost": "",
            "comments": "",
            "os": "",
            "sys_mod_count": "4",
            "monitor": "false",
            "model_id": {
                "display_value": "Unknown",
                "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
                "value": "0ce0a2681b4e1010593876a61a4bcba6"
            },
            "ip_address": "",
            "duplicate_of": "",
            "sys_tags": "",
            "cost_cc": "USD",
            "order_date": "",
            "schedule": "",
            "environment": "",
            "due": "",
            "attested": "false",
            "location": "",
            "category": "Hardware",
            "fault_count": "0",
            "host_name": "",
            "lease_id": ""
        },
        "inbound_relations": [
            {
                "sys_id": "c03ff2641b425010593876a61a4bcb49",
                "type": {
                    "display_value": "Depends on::Used by",
                    "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
                    "value": "1a9cb166f1571100a92eb60da2bce5c5"
                },
                "target": {
                    "display_value": "PS Apache01",
                    "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
                    "value": "3a27d4370a0a0bb4006316812bf45439"
                }
            }
        ]
    }
}

CMDB Instance : PATCH /now/cmdb/instance/{classname}/{sys_id}

Remplace les attributs dans l’enregistrement d’élément de configuration (CI) spécifié par les paires nom-valeur spécifiées. Ce point de terminaison ne crée, ne met pas à jour ou ne supprime pas les relations associées.

Format d'URL

URL versionnée : /api/now/{api_version}/cmdb/instance/{className}/{sys_id}

URL par défaut : /api/now/cmdb/instance/{className}/{sys_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST scriptées, des informations supplémentaires sur la version se trouvent dans le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 41. Paramètres de chemin d'accès
Nom	Description
className	CMDB nom de classe. Il s’agit du nom de la table qui contient les enregistrements de CI souhaités, tels que cmdb_ci_linux_server ou cmdb_ci_apache_web_server. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de CI à mettre à jour. Type de données : chaîne

Tableau 42. Paramètres de requête
Nom	Description
Néant

Tableau 43. Paramètres de corps de demande (XML ou JSON)
Nom	Description
attributs	Attributs de données à remplacer dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Pour en savoir plus sur l’attestation, reportez-vous à la section CIs attestation. Type de données : objet
source	Requis. Entité qui a mis à jour les informations. Il doit s’agir de l’une des valeurs de choix spécifiées dans le champ discovery_source de la table Élément de configuration [cmdb_ci]. Type de données : chaîne

En-têtes

Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 44. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Format des données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 45. En-têtes de réponses
En-tête	Description
Néant

Codes d'état

Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 46. Codes d'état
Code d'état	Description
200	Réussi. La demande a été traitée avec succès.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d’identification de l’utilisateur sont incorrectes ou n’ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est désactivée.
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 du corps de la réponse (JSON ou XML)

Tableau 47. Paramètres de réponse
Nom	Description
attributs	Attributs de données actuellement dans l’enregistrement CI. Les attributs disponibles dépendent de la classe spécifiée CMDB . Vous pouvez localiser les attributs disponibles dans la table associée CMDB qui commence généralement par « cmdb_ci », comme cmdb_ci_linux_server ou cmdb_ci_mfp_printer. Type de données : objet
erreur	Informations sur les erreurs rencontrées lors du traitement de la demande de point de terminaison. Type de données : objet `"error": { "detail": "String", "message": "String" }`
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message qui identifie l’erreur. Type de données : chaîne
inbound_relations	Liste des objets qui définissent les relations entrantes associées au CI. Type de données : tableau `"inbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
inbound_relations.sys_id	Sys_id de la relation CI entrante. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
inbound_relations.cible	Informations décrivant la relation entrante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.target.display_value	Nom de la relation entrante à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation entrante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
inbound_relations.valeur.cible.	Sys_id du CI entrant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
inbound_relations.type	Informations sur le type de relation entrante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
inbound_relations.type.display_value	Nom du type entrant à afficher dans une interface utilisateur. Type de données : chaîne
inbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer le type de relation entrante à partir de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
inbound_relations.type.valeur	Sys_id du type de relation entrante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
outbound_relations	Liste des objets qui définissent les relations sortantes associées au CI. Type de données : tableau `"outbound_relations": [ { "sys_id": "String", "target": {Object}, "type": {Object} } ]`
outbound_relations.sys_id	Sys_id de la relation CI sortant. Situé dans la table Relation de CI [cmdb_rel_ci]. Type de données : chaîne
outbound_relations.cible	Requis. Informations sur la relation sortante cible. Type de données : objet `"target": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.target.display_value	Nom de la relation sortante à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.target.link	CMDB URL du point de terminaison REST à utiliser pour récupérer la relation sortante à partir de la table Élément de configuration [cmdb_ci]. Type de données : chaîne
outbound_relations.valeur.cible.	Sys_id du CI sortant. Situé dans la table Configuration Item (Élément de configuration) [cmdb_ci]. Type de données : chaîne
outbound_relations.type	Informations sur le type de relation sortante. Type de données : objet `"type": { "display_value": "String", "link": "String", "value": "String" }`
outbound_relations.type.display_value	Nom du type sortant à afficher dans une interface utilisateur. Type de données : chaîne
outbound_relations.type.link	Table URL du point de terminaison REST à utiliser pour récupérer la relation sortante de la table Type de relation de CI [cmdb_rel_type]. Type de données : chaîne
outbound_relations.type.valeur	Sys_id du type de relation sortante. Situé dans la table CI Relationship Type (Type de relation CI) [cmdb_rel_type]. Type de données : chaîne
statut	S’affiche uniquement en cas d’erreur. État du traitement du point de terminaison. Valeur possible : échec Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_class_sw/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password"\
--data {
    "attributes": {
      "firewall_status": "Active",
      "name": "Linux299",
      "used_for": "Production"
    },
    "source": "ServiceNow"
}

{
  "result": {
    "outbound_relations": [
      {
        "sys_id": "403ff2641b425010593876a61a4bcb4b",
        "type": {
          "display_value": "Depends on::Used by",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
          "value": "1a9cb166f1571100a92eb60da2bce5c5"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      },
      {
        "sys_id": "443ff2641b425010593876a61a4bcb4c",
        "type": {
          "display_value": "Exchanges data with::Exchanges data with",
          "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
          "value": "607ad1b2c0a8010e01941856b365af90"
        },
        "target": {
          "display_value": "PS ORA01",
          "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
          "value": "3a307c930a0a0bb400353965d0b8861f"
        }
      }
    ],
    "attributes": {
      "firewall_status": "Active",
      "os_address_width": "",
      "attested_date": "",
      "operational_status": "1",
      "os_service_pack": "",
      "cpu_core_thread": "",
      "cpu_manufacturer": "",
      "sys_updated_on": "2020-07-13 21:24:05",
      "discovery_source": "ServiceNow",
      "first_discovered": "2020-07-13 20:27:28",
      "due_in": "",
      "used_for": "Production",
      "invoice_number": "",
      "gl_account": "",
      "sys_created_by": "dora.gray",
      "warranty_expiration": "",
      "ram": "",
      "cpu_name": "",
      "cpu_speed": "",
      "owned_by": "",
      "checked_out": "",
      "kernel_release": "",
      "sys_domain_path": "/",
      "classification": "Production",
      "disk_space": "",
      "object_id": "",
      "maintenance_schedule": "",
      "cost_center": "",
      "attested_by": "",
      "dns_domain": "",
      "assigned": "",
      "purchase_date": "",
      "life_cycle_stage": "",
      "short_description": "",
      "cd_speed": "",
      "floppy": "",
      "managed_by": "",
      "os_domain": "",
      "last_discovered": "2020-07-13 21:24:05",
      "can_print": "false",
      "sys_class_name": "cmdb_ci_linux_server",
      "manufacturer": "",
      "cpu_count": "",
      "vendor": "",
      "life_cycle_stage_status": "",
      "model_number": "",
      "assigned_to": "",
      "start_date": "",
      "os_version": "",
      "serial_number": "",
      "cd_rom": "false",
      "support_group": "",
      "unverified": "false",
      "correlation_id": "",
      "attributes": "",
      "asset": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
        "value": "21cfba641b425010593876a61a4bcb52"
      },
      "form_factor": "",
      "cpu_core_count": "",
      "skip_sync": "false",
      "attestation_score": "",
      "sys_updated_by": "dora.gray",
      "sys_created_on": "2020-07-13 20:27:28",
      "sys_domain": {
        "display_value": "global",
        "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
        "value": "global"
      },
      "cpu_type": "",
      "install_date": "",
      "asset_tag": "",
      "dr_backup": "",
      "hardware_substatus": "",
      "fqdn": "",
      "change_control": "",
      "internet_facing": "true",
      "delivery_date": "",
      "hardware_status": "installed",
      "install_status": "1",
      "supported_by": "",
      "name": "Linux299",
      "subcategory": "Computer",
      "default_gateway": "",
      "chassis_type": "",
      "virtual": "false",
      "assignment_group": "",
      "managed_by_group": "",
      "sys_id": "0c3ff2641b425010593876a61a4bcb39",
      "po_number": "",
      "checked_in": "",
      "sys_class_path": "/!!/!2/!(/!!/!0",
      "mac_address": "",
      "company": "",
      "justification": "",
      "department": "",
      "cost": "",
      "comments": "",
      "os": "",
      "sys_mod_count": "4",
      "monitor": "false",
      "model_id": {
        "display_value": "Unknown",
        "link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
        "value": "0ce0a2681b4e1010593876a61a4bcba6"
      },
      "ip_address": "",
      "duplicate_of": "",
      "sys_tags": "",
      "cost_cc": "USD",
      "order_date": "",
      "schedule": "",
      "environment": "",
      "due": "",
      "attested": "false",
      "location": "",
      "category": "Hardware",
      "fault_count": "0",
      "host_name": "",
      "lease_id": ""
    },
    "inbound_relations": [
      {
        "sys_id": "c03ff2641b425010593876a61a4bcb49",
         "type": {
           "display_value": "Depends on::Used by",
            "link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
            "value": "1a9cb166f1571100a92eb60da2bce5c5"
          },
          "target": {
            "display_value": "PS Apache01",
            "link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
            "value": "3a27d4370a0a0bb4006316812bf45439"
          }
        }
      ]
    }
}