API ouverte de l’inventaire des ressources

L’API Open d’inventaire des ressources fournit des points de terminaison pour créer, récupérer et supprimer des ressources.

Utilisez cette API pour gérer les ressources dans les tables suivantes.

• Câble [cmdb_ci_cable]
• Titulaire de l’équipement [cmdb_ci_equipment_holder]
• Carte d’interface [cmdb_ci_interface_card]
• Adresse IP [cmdb_ci_ip_address]
• Connexion logique [cmdb_ci_ni_logical_path]
• Interface réseau [cmdb_ci_ni_interface]
• Site réseau [cmdb_ci_ni_site]
• Connexion physique [cmdb_ci_ni_physical_link]
• Fil [cmdb_ci_strand]
• Topologie [cmdb_ci_topology]
• Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées.
• Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder].
• Tables enfants qui étendent l’une des tables suivantes :
  • Câble [cmdb_ci_cable]
  • Titulaire de l’équipement [cmdb_ci_equipment_holder]
  • Fil [cmdb_ci_strand]

Cette API est incluse dans l’application Network Inventory Core, disponible sur le ServiceNow Store.

Cette API est fournie dans l’espace de noms sn_ni_core .

L’utilisateur appelant doit avoir le rôle sn_ni_core.inventory_integrator.

Cette API peut être étendue pour apporter des personnalisations autour des paramètres requis, de la validation du corps de la demande et des mappages de champs. Pour en savoir plus, voir Inventaire des ressources Guide du développeur Open API.

L’API Open Resource Inventory est une ServiceNow® implémentation de la spécification REST de l’API TM Forum Resource Inventory. Cette implémentation est basée sur le Guide de l’utilisateur de l’API d’inventaire des ressources TMF639 v4.0.1, juillet 2020.

API ouverte de l’inventaire des ressources : DELETE /sn_ni_core/resource/{id}

Supprime un enregistrement de ressource spécifié.

Format d'URL

URL par défaut : /api/sn_ni_core/resource/{id}

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom

Description

id

Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Remarque : Les ressources de la table Adresse IP [cmdb_ci_ip_address] ne peuvent pas être supprimées à l’aide de cette API. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

Tableau 3. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

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 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
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Tableau 5. En-têtes de réponses

En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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
215	Demande reçue avec succès pour traitement. La demande est effectuée de manière asynchrone.
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.
403	Interdit. Échec de la suppression des ressources. La ressource peut être requise par ses ressources connexes.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
Aucun

Demande cURL

Cet exemple supprime une ressource.

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

Corps de la réponse.

""

API ouverte d’inventaire des ressources : GET /sn_ni_core/resource

Récupère une liste de tous les enregistrements de ressources.

Format d'URL

URL par défaut : /api/sn_ni_core/resource

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
Aucun

Tableau 8. Paramètres de requête

Nom	Description
@type	Requis. Nom de table du type de ressource à récupérer. Vous ne pouvez récupérer qu’un seul type de ressource par appel d’API. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description à utiliser pour filtrer les ressources. Seules les ressources avec la description spécifiée sont renvoyées dans la réponse. Type de données : chaîne
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Valeurs valides : description href id nom remarque lieu Fête connexe resourceCharacteristics resourceRelationship resourceSpecification startOperatingDate Type de données : chaîne Par défaut : renvoie tous les champs.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Par défaut : 20 Type de données : nombre
nom	Nom à utiliser pour filtrer les ressources. Seules les ressources portant le nom spécifié sont renvoyées dans la réponse. Type de données : chaîne
décalage	Index de début auquel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre
resourceSpecification.id	Spécification de ressource sys_id à utiliser pour filtrer les ressources. Le sys_id doit provenir d’un modèle figurant dans l’une des tables suivantes. Modèles de titulaires d’équipement [sn_ni_core_equipment_holder_product_model] Modèles d’équipement [sn_ni_core_equipment_product_model] Modèles de carte d’interface [sn_ni_core_interface_card_product_model] Modèles de connexion logique [sn_ni_core_logical_connection_product_model] Modèles d’interfaces réseau [sn_ni_core_network_interface_product_model] Modèles de connexion physique [sn_ni_core_physical_connection_product_model] Seules les ressources dont le modèle correspond aux sys_id spécifiés sont renvoyées dans la réponse. Type de données : chaîne

Tableau 9. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

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 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. Prend uniquement en charge application/json.

Tableau 11. En-têtes de réponses

En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si offset=2 and limit=3, la valeur de l’en-tête Content-Range est les éléments 3 à 5.
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Lien	Contient les liens suivants pour parcourir les résultats de la requête. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. Remarque : Si le nombre total d’enregistrements est supérieur à 100 000, cet en-tête renvoie toujours 100 000.

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é correctement traitée.
206	Contenu partiel. La demande a été traitée avec succès et a renvoyé une plage partielle de contenu spécifiée par un appel paginé.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne
nom	Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Le texte de la note. Type de données : chaîne
lieu	Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
relatedParty.role	Rôle de la partie connexe. Type de données : chaîne Table : dans le champ Type de groupe de la table Équipes [cmdb_rel_team].
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. Type de données : chaîne

Demande cURL

Cet exemple récupère les namechamps , idet pour href les cinq premiers enregistrements de ressources du site réseau.

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

Corps de la réponse.

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

API ouverte de l’inventaire des ressources : GET /sn_ni_core/resource/{id}

Récupère un enregistrement de ressource spécifié.

Format d'URL

URL par défaut : /api/sn_ni_core/resource/{id}

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès

Nom

Description

id

Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne

Tableau 14. Paramètres de requête

Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Valeurs valides : description href id nom remarque lieu Fête connexe resourceCharacteristics resourceRelationship resourceSpecification startOperatingDate Type de données : chaîne Par défaut : renvoie tous les champs.

Tableau 15. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

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 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. Prend uniquement en charge application/json.

Tableau 17. En-têtes de réponses

En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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é correctement traitée.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne
nom	Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Le texte de la note. Type de données : chaîne
lieu	Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. Type de données : chaîne

Demande cURL

Cet exemple récupère un enregistrement de ressource spécifié.

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

Corps de la réponse.

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

API ouverte de l’inventaire des ressources : PATCH /sn_ni_core/resource/{id}

Met à jour un enregistrement de ressource spécifié.

Format d'URL

URL par défaut : /api/sn_ni_core/resource/{id}

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès

Nom

Description

id

Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Aucun

Tableau 21. Paramètres de corps de demande (XML ou JSON)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
nom	Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Requis si le note paramètre est utilisé. Le texte de la note. Type de données : chaîne
lieu	Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Requis si le place paramètre est utilisé. Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ] Remarque : La suppression des enregistrements relatedParty d’une ressource n’est pas prise en charge par ce point de terminaison. Les enregistrements peuvent être supprimés manuellement de la table Équipes [cmdb_rel_team].
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Requis si le relatedParty paramètre est utilisé. Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
relatedParty.role	Rôle de la partie connexe. Type de données : chaîne Table : dans le champ Type de groupe de la table Équipes [cmdb_rel_team].
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Requis si le resourceCharacteristic paramètre est utilisé. Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Requis si le resourceCharacteristic paramètre est utilisé. Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Requis si le resourceRelationship paramètre est utilisé. Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Requis si le resourceRelationship paramètre est utilisé. Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Requis si le resourceRelationship paramètre est utilisé. Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Requis si le resourceSpecification paramètre est utilisé. Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. 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 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 22. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Type de contenu	Format de données du corps de la demande. Prend uniquement en charge application/merge-patch+json.

Tableau 23. En-têtes de réponses

En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.

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 24. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
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.
415	Le corps de la demande est dans un format non pris en charge ou l’en-tête de demande de type de contenu est mal défini.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne
nom	Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Le texte de la note. Type de données : chaîne
lieu	Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
relatedParty.role	Rôle de la partie connexe. Type de données : chaîne Table : dans le champ Type de groupe de la table Équipes [cmdb_rel_team].
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. Type de données : chaîne

Demande cURL

Cet exemple met à jour le nom d’une ressource.

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

Corps de la réponse.

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

API ouverte de l’inventaire des ressources : POST /sn_ni_core/resource

Crée un enregistrement de ressource.

Format d'URL

URL par défaut : /api/sn_ni_core/resource

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès

Nom	Description
Aucun

Tableau 26. Paramètres de requête

Nom	Description
Aucun

Tableau 27. Paramètres du corps de la demande (JSON)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
nom	Requis. Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Requis si le note paramètre est utilisé. Le texte de la note. Type de données : chaîne
lieu	Requis pour les ressources de titulaire d’équipement où le type de conteneur est Cage, Baie, Armoire, Rack, Ligne ou Ensemble de modèles d’inventaire. Requis pour toutes les ressources d’équipement. Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Requis si le place paramètre est utilisé. Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Requis si le relatedParty paramètre est utilisé. Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Requis si le resourceCharacteristic paramètre est utilisé. Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Requis si le resourceCharacteristic paramètre est utilisé. Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Requis si le resourceRelationship paramètre est utilisé. Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Requis si le resourceRelationship paramètre est utilisé. Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Requis si le resourceRelationship paramètre est utilisé. Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Requis si le resourceSpecification paramètre est utilisé. Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. 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 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 28. En-têtes de demandes

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.

Tableau 29. En-têtes de réponses

En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Emplacement	URL de la ressource créée.

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 30. Codes d'état

Code d'état	Description
215	Demande reçue avec succès pour traitement. La demande est effectuée de manière asynchrone.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
@type	Type de ressource. Valeurs valides : cmdb_ci_cable (câble) cmdb_ci_interface_card (carte d’interface) cmdb_ci_ip_address (adresse IP) cmdb_ci_ni_logical_path (connexion logique) cmdb_ci_ni_interface (interface réseau) cmdb_ci_ni_site (site réseau) cmdb_ci_ni_physical_link (connexion physique) cmdb_ci_strand (fil) cmdb_ci_topology (topologie) Nom d’une table spécifiée par le sn_ni_core.equipment_tables sys_property, ou nom d’une table qui étend les tables spécifiées. Nom d’une table qui étend le titulaire de l’équipement [cmdb_ci_equipment_holder]. Type de données : chaîne
description	Description de la ressource. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Sys_id de la ressource. Situé dans l’une des tables suivantes en fonction du type de ressource. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne
nom	Nom de la ressource. Type de données : chaîne
remarque	Liste des remarques relatives à la ressource. Type de données : tableau d’objets "note": [ { "text": "String" } ]
note.text	Le texte de la note. Type de données : chaîne
lieu	Site réseau de la ressource. Ce paramètre n’est pas pris en charge pour les ressources de site réseau, de connexion physique ou de connexion logique. Type de données : objet "place": { "@referredType": "String", "href": "String", "id": "String" }
place.@referredType	Type de lieu. Cette valeur est toujours GeographicAddress. Type de données : chaîne
lieu.href	Lien relatif à l’enregistrement du lieu. Type de données : chaîne
place.id	Sys_id de l’enregistrement du lieu. Type de données : chaîne Table : Site réseau [cmdb_ci_ni_site]
Fête connexe	Détails sur les contacts de la ressource. Type de données : tableau d’objets "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedParty.@referredType	Type de partie liée. Situé dans le champ Type . Type de données : chaîne Table : dans le champ type de la table Groupe [sys_user_group].
relatedParty.href	Lien relatif vers l’enregistrement de partie connexe. Type de données : chaîne
relatedParty.id	Sys_id de l’enregistrement de partie liée. Type de données : chaîne Table : Groupe [sys_user_group]
resourceCharacteristics	Liste des caractéristiques de la ressource. Les types de ressources suivants nécessitent des caractéristiques de ressource spécifiques. Pour les ressources de connexion physique et de connexion logique, une caractéristique du port A ou du port Z est requise. Si l’état de l’étape du cycle de vie de la ressource est En cours d’utilisation, les ports A et Z sont requis. Pour les ressources de titulaire d’équipement, une caractéristique de type de conteneur est requise. Type de données : tableau d’objets "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Nom de champ de la table de ressources spécifiée par le @type paramètre. Vous ne pouvez pas utiliser les champs model_id, nom, network_site, operation_notes, operational_status, short_description, start_date ou tout autre champ préfixé sys_ tel que sys_id. Type de données : chaîne
resourceCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
resourceCharacteristic.valueType	Type de valeur. Valeurs valides : booléen Date/Heure flottant entier ph_number référence chaîne Type de données : chaîne
resourceRelationship	Liste des ressources associées. Les types de ressources suivants nécessitent des ressources connexes spécifiques. Pour les ressources de carte d’interface, une relation avec une ressource de titulaire d’équipement où le type de conteneur est Emplacement ou Sous-emplacement est requise. Pour les ressources d’interface réseau, une relation avec une ressource de carte d’interface ou d’équipement est requise. Pour les ressources de titulaire d’équipement où le type de conteneur est logement ou sous-emplacement, une relation avec une ressource de carte d’équipement ou d’interface est requise. Type de données : tableau "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Type de relation entre les deux ressources au format [ce descripteur de ressource] ::[descripteur de ressource connexe]. Par exemple, Contient ::Contenu par indique que la ressource connexe est l’enfant de cette ressource. Les valeurs valides pour les descripteurs se trouvent dans la table Type de relation CI [cmdb_rel_type] dans les colonnes Descripteur parent et Descripteur enfant . Type de données : chaîne
resourceRelationship.resource	Détails sur la ressource connexe. La ressource connexe doit être de l’un des types de ressources suivants. Câble Équipement Titulaire de l'équipement Carte d'interface Connexion logique Interface réseau Site réseau Connexion physique Fil Topologie Type de données : objet "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id de la ressource connexe. Situé dans l’une des tables suivantes en fonction du type de ressource associée. Carte d’interface [cmdb_ci_interface_card] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder] Type de données : chaîne
resourceRelationship.resource.href	Lien relatif vers l’enregistrement de ressource connexe. Type de données : chaîne
resourceSpecification	Spécification de ressource. Type de données : objet "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id du modèle associé pour la ressource. Situé dans l’une des tables suivantes en fonction du type de modèle. Modèles de câbles [sn_ent_cable_model] Modèles de titulaires d’équipement [sn_ent_nw_holder_model] Modèles d’équipement [sn_ent_nw_equipment_model] Modèles de cartes d’interface [sn_ent_nw_interface_model] Modèles de connexion logique [sn_ent_logical_nw_connection_model] Modèles d’interfaces réseau [sn_ent_nw_interface_model] Modèles de connexion physique [sn_ent_physical_nw_connection_model] Modèles de fil [sn_ent_strand_model] Modèles de topologie [sn_ent_network_topology_model] Type de données : chaîne
startOperatingDate	Date et heure auxquelles la ressource a commencé à fonctionner. Type de données : chaîne

Demande cURL

Cet exemple crée un site réseau à Denver, Colorado.

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

Corps de la réponse.

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

API ouverte de l’inventaire des ressources : POST /sn_ni_core/resourceinventoryviatemplate

Crée un élément de configuration de ressource (CI) et une hiérarchie des CI connexes en fonction d’un modèle.

Avant d’appeler ce point de terminaison, vous devez créer un modèle d’inventaire dans la table Modèle d’inventaire [sn_ni_core_inventory_template]. Vous pouvez définir toute la hiérarchie des CI associés dans un modèle d’inventaire. Vous pouvez ensuite créer tous les CI et relations via une seule demande d’API.

Format d'URL

URL par défaut : /api/sn_ni_core/resourceinventoryviatemplate

Paramètres de demande pris en charge

Tableau 31. Paramètres de chemin d'accès

Nom	Description
Aucun

Tableau 32. Paramètres de requête

Nom	Description
Aucun

Tableau 33. Paramètres du corps de la demande (JSON)

Nom	Description
Substitue	Liste des colonnes à remplacer et des valeurs à utiliser. Type de données : objet "overrides": { "column_name": "String" }
overrides.column_name	Requis si le overrides paramètre est utilisé. Nom et valeur de la colonne. Type de données : chaîne
parentId	Requis. Sys_id du CI parent. Situé dans l’une des tables suivantes en fonction du type de CI parent. Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Carte d’interface [cmdb_ci_interface_card] Adresse IP [cmdb_ci_ip_address] Connexion logique [cmdb_ci_ni_logical_path] Interface réseau [cmdb_ci_ni_interface] Site réseau [cmdb_ci_ni_site] Connexion physique [cmdb_ci_ni_physical_link] Fil [cmdb_ci_strand] Topologie [cmdb_ci_topology] Tables spécifiées par le sn_ni_core.equipment_tables sys_property et toutes les tables qui étendent les tables spécifiées. Tables qui étendent le titulaire de l’équipement [cmdb_ci_equipment_holder]. Tables enfants qui étendent l’une des tables suivantes : Câble [cmdb_ci_cable] Titulaire de l’équipement [cmdb_ci_equipment_holder] Fil [cmdb_ci_strand] Type de données : chaîne
ID de modèle	Requis. Sys_id du modèle. Type de données : chaîne Table : Modèle d’inventaire [sn_ni_core_inventory_template]
remplacements des modèles	Liste de remplacements de modèles. Type de données : tableau d’objets "templateOverrides": [ { "overrideTemplateId": "String", "templateId": "String" } ]
templateOverrides.overrideTemplateId	Requis si le templateOverrides paramètre est utilisé. Modèle disponible sys_id. Type de données : chaîne
templateOverrides.templateId	Requis si le templateOverrides paramètre est utilisé. Modèle connexe sys_id. 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 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 34. En-têtes de demandes

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.

Tableau 35. En-têtes de réponses

En-tête	Description
Type de contenu	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Emplacement	URL du CI créé en haut de la hiérarchie.

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 36. Codes d'état

Code d'état	Description
201	Ressource créée.
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.
500	Erreur. Une erreur s’est produite avec la demande. Par exemple, la demande a échoué aux contrôles de validation.

Paramètres de corps de réponse (JSON)

Nom	Description
résultat	Objet de résultat contenant des informations sur les CI créés. Type de données : objet "result": { "sys_id": "String" }
result.sys_id	Sys_id du CI créé au sommet de la hiérarchie. Type de données : chaîne

Demande cURL

Cet exemple crée une hiérarchie des CI à l’aide d’un modèle.

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

Corps de la réponse.

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