SG Services API
L’API Service Graph Services fournit des points de terminaison pour créer et gérer les services d’application et les relations en amont entre eux.
Demander des applications dans l'App Store
Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les notes de publication du ServiceNow Store.
Cette API ne peut être utilisée que lorsque le module d’extension API de l’application CMDB et CLI (sn_service_graph) est activé. Cette API est utilisée dans l’espace de noms sn_service_graph .
L’utilisation de cette API ne nécessite pas de détails concernant les tables sources ou les types de relations.
Pour scripter des opérations critiques qui prennent en charge l’automatisation dans l’ensemble de l’entreprise, vous pouvez utiliser des API ou exécuter des opérations de ligne de commande fournies par l’interface de ligne de commande CMDB et l’application de magasin d’API au lieu d’utiliser l’interface utilisateur. L’application CMDB Application CLI and API store fournit un cadre de travail robuste qui consolide toutes les API associées aux services d’application et les lignes de commande qui vous permettent d’accéder à l’interface de ces API.
- Enregistrement et création d’un service d’application et établissement de relations en amont
- Obtention de détails sur un service d’application donné et ses relations en amont
- Connecter des constructions de niveau supérieur telles que des applications d’entreprise et des offres de services d’entreprise
- Remplissage d’un service d’application avec un type de population donné
- Modification de l’état d’un service d’application
Pour obtenir la solution de ligne de commande, consultez Commandes disponibles de l’API et de l’interface de ligne de commande de l’application CMDB.
Services Service Graph – POST/sg_services/app_service/convert
Convertit un service d’application de type manuel ou vide en un service d’application calculé. Lors de la conversion, l’enregistrement de service d’application est déplacé vers la table [cmdb_ci_service_calculated] avec la classe nouvellement affectée.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/convert
URL par défaut : /api/sn_service_graph/sg_services/app_service/convert
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| niveaux | Nombre de niveaux à inclure dans la conversion. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment convertir un type de service d’application.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/convert" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\",
\"levels\" : 8
}" \
--user 'username':'password'
Résultats indiquant une conversion réussie en service d’application calculé.
{
"result": {
"status": "success"
}
}
Services SG – POST /sg_services/app_service/delete
Supprime un service d’application.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/delete
URL par défaut : /api/sn_service_graph/sg_services/app_service/delete
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment supprimer un service d’application.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\"
}" \
--user 'username':'password'
Résultats indiquant la suppression réussie d’un service d’application.
{
"result": {
"status": "success"
}
}
Services Service Graph – POST /sg_services/app_service/find
Recherche les détails d’un service d’application donné et ses relations en amont.
Les utilisateurs disposant du rôle app_service_user peuvent utiliser cette API, mais les résultats sont limités aux services d’application à l’état Opérationnel. Le rôle app_service_admin permet d’afficher de manière illimitée les services d’application.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/find
URL par défaut : /api/sn_service_graph/sg_services/app_service/find
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <champs IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| operational_status | Statut opérationnel du service d’application. Par exemple, actif. Type de données : chaîne |
| Relations | Liste des objets définissant les relations en amont du service d’application. Type de données : tableau |
| relationships.class_name | Nom de la classe qui contient le service d’application. Type de données : chaîne |
| relationships.name | Nom de la relation. Type de données : chaîne |
| relations.numéro | Numéro unique de la relation. Type de données : chaîne |
| relations.relation | Règle de relation. Type de données : chaîne |
| relationships.sys_id | Sys_id de la relation. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment trouver les détails d’un service d’application.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/find" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Test App Service1\"
}" \
--user 'username':'password'
Le corps de la réponse inclut le service d’application et les informations relatives aux relations.
{
"result": {
"aliases": null,
"asset": null,
"asset_tag": null,
"assigned": "",
"assigned_to": null,
"assignment_group": null,
"attestation_score": null,
"attested": "0",
"attested_by": null,
"attested_date": "",
"attributes": null,
"bucket": null,
"business_contact": null,
"business_need": null,
"business_relation_manager": null,
"business_unit": null,
"busines_criticality": "4 - not critical",
"can_print": "0",
"category": null,
"change_control": null,
"checked_in": "",
"checked_out": "",
"checkout": null,
"comments": null,
"company": null,
"compatibility_dependencies": null,
"consumer_type": "internal",
"correlation_id": null,
"cost": null,
"cost_cc": "USD",
"cost_center": null,
"delivery_date": "",
"delivery_manager": null,
"department": null,
"discovery_source": "Manual Entry",
"dns_domain": null,
"due": "",
"due_in": null,
"duplicate_of": null,
"end_date": "",
"environment": null,
"fault_count": "0",
"first_discovered": "2021-07-19 20:09:48",
"fqdn": null,
"gl_account": null,
"hide_from_dashboard": "0",
"install_date": "",
"install_status": "1",
"invoice_number": null,
"ip_address": null,
"justification": null,
"last_discovered": "2021-07-19 20:09:48",
"last_review_date": "",
"layer": null,
"lease_id": null,
"life_cycle_stage": null,
"life_cycle_stage_status": null,
"location": null,
"mac_address": null,
"maintenance_schedule": null,
"managed_by": null,
"managed_by_group": null,
"manufacturer": null,
"model_id": null,
"model_number": null,
"monitor": "0",
"monitoring_requirements": null,
"name": "Test App Service1",
"number": "SNSVC0001014",
"operational_status": "2",
"order_date": "",
"owned_by": null,
"parent": null,
"portfolio_status": "pipeline",
"po_number": null,
"prerequisites": null,
"price_model": "per_unit",
"price_unit": null,
"published_ref": null,
"purchase_date": "",
"schedule": null,
"serial_number": null,
"service_classification": "Application Service",
"service_level_requirement": null,
"service_owner_delegate": null,
"service_status": "requirements",
"severity": null,
"short_description": null,
"skip_sync": "0",
"sla": null,
"spm_service_portfolio": null,
"spm_taxonomy_node": null,
"stakeholders": null,
"start_date": "",
"state": null,
"subcategory": null,
"supported_by": null,
"support_group": null,
"sys_class_name": "cmdb_ci_service_auto",
"sys_class_path": "/!!/!7/!(",
"sys_created_by": "admin",
"sys_created_on": "2021-07-19 20:09:48",
"sys_domain": "global",
"sys_domain_path": "/",
"sys_id": "a2f0618040697410f87713b656474255",
"sys_mod_count": "0",
"sys_updated_by": "admin",
"sys_updated_on": "2021-07-19 20:09:48",
"unit_description": null,
"unverified": "0",
"used_for": "Production",
"user_group": null,
"vendor": null,
"version": null,
"view_service": "61e1cb757f23220002d31ccebefa9120",
"warranty_expiration": "",
"relationships": [
{
"name": "Test Biz App1",
"sys_id": "0250a94040697410f87713b656474250",
"number": "APM0001001",
"class_name": "cmdb_ci_business_app",
"relationship": "Consumes::Consumed by"
},
{
"name": "Tech Service Offering1",
"sys_id": "98d0ed4040697410f87713b6564742ef",
"number": "BSN0001005",
"class_name": "service_offering",
"relationship": "Contains::Contained by"
}
]
}
}
Services Service Graph – PUBLIER /sg_services/app_service/renseigner
Remplit un service d’application avec une méthode de remplissage de service.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/populate
URL par défaut : /api/sn_service_graph/sg_services/app_service/populate
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| population_method | Requis. Identifie la méthode de remplissage et sa propriété d’accompagnement pour identifier le contenu du remplissage. Un seul objet d’accompagnement est valide par type. Type de données : objet |
| population_method.group_id | ID de groupe du groupe CMDB configuré avec le type de population cmdb_group. Type de données : « chaîne »
Type de population associée : cmdb_group |
| population_method.niveaux | Nombre de niveaux à utiliser dans la conception du service. Si la valeur de niveau n’est pas fournie, le système vérifie le sys_property pour la valeur. Si svc.manual.convert.levels.default_value n’est pas renseigné, une valeur par défaut de 3 est utilisée. Type de données : nombre
Type de population associée : dynamic_service Par défaut : 3 si aucune valeur de niveau n’est définie pour le sys_property |
| population_method.candidat_service | Identificateur unique du candidat de service. Type de données : chaîne
Type de population associée : tag_based_service_family |
| population_method.service_relations | Liste des objets contenant des données de hiérarchie pour les CI au sein du service d’application. Tous les CI forment des paires avec un CI parent et enfant. Le CI de niveau supérieur, désigné comme le point d’entrée d’un service d’application, n’a pas de CI parent. Type de données : tableau
Type de population associée : service_hierarchy |
| population_method.service_relations.child | Nom d’un CI enfant associé au CI. Type de données : chaîne |
| population_method.service_relations.parent | Nom d’un CI parent associé au CI. Type de données : chaîne |
| population_method.balises | Liste des objets contenant des balises à associer au CI. Ces informations figurent dans la table Valeurs de clé [cmdb_key_value]. Type de données : tableau
Type de population associée : tag_list |
| population_method.balises.balises | Nom de balise. Type de données : chaîne |
| population_method.balises.valeur | Valeur de la balise. Type de données : chaîne |
| population_method.type | Requis. Type de population à ajouter au service d’application. Type de données : objet Valeurs valides :
|
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment renseigner un service d’application avec un type dynamic_service.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/populate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\",
\"population_method\": {
\"type\": \"dynamic_service\",
\"levels\" : 8
}
}" \
--user 'username':'password'
Résultats indiquant un remplissage correct d’un service d’application.
{
"result": {
"status": "success"
}
}
Services Service Graph – POST/sg_services/app_service/register
Crée un service d’application, balise et construit des relations en amont telles que des applications d’entreprise, des offres de service d’entreprise et d’autres services d’application.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/register
URL par défaut : /api/sn_service_graph/sg_services/app_service/register
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| Relations | Relations en amont classées par type. Type de données : objet
Le nombre maximal de relations est de 25. |
| relationships.business_app | Liste d’objets représentant les types de relations d’application d’entreprise. Ces valeurs peuvent être définies à l’aide de l’un des éléments suivants en tant que paires clé-valeur.
Type de données : tableau |
| relationships.business_service_offering | Liste d’objets représentant les types de relations d’offre de service d’entreprise. Ces valeurs peuvent être définies à l’aide des éléments suivants en tant que paires clé-valeur.
Type de données : tableau |
| relationships.parent_app_service | Liste d’objets représentant les types de relations de service d’application. Ces valeurs peuvent être définies à l’aide des éléments suivants en tant que paires clé-valeur.
Type de données : tableau |
| relationships.technical_service_offering | Liste d’objets représentant l’offre de gestion des technologies (anciennement offre de service technique), types de relations. Ces valeurs peuvent être définies à l’aide des éléments suivants en tant que paires clé-valeur.
Type de données : tableau |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
| balises | Liste des objets contenant des définitions de balises en tant que paires clé-valeur.
Type de données : tableau |
| tags.key | Nom de la catégorie de la balise. Type de données : chaîne |
| Balises.valeur | Valeur de la balise. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| En-tête | Description |
|---|---|
| app_service | Détails du service d’application. Type de données : objet |
| app_service.nom | Nom du service d'application. Type de données : chaîne |
| app_service.numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| app_service.sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
| message | Message décrivant l’état. Valeurs possibles :
Type de données : chaîne |
| état | État indiquant si le service a été inscrit. Valeurs possibles :
Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment enregistrer un service d’application.
curl "instance.service-now.com/api/sn_service_graph/sg_services/app_service/register" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\",
\"number\": \" SNSVC0001014\",
\"relationships\": {
\"business_application\": [
{
\"sys_id\": \"0250a94040697410f87713b656474250\"
},
{
\"number\": \"APM0001002\"
},
{
\"name\": \"Test Biz App1\"
}
],
\"business_service_offering\": [
{
\"sys_id\": \"ed32e98040697410f87713b656474259\"
}
],
\"technical_service_offering\": [
{
\"sys_id\": \"80e12d8040697410f87713b65647421c\"
},
{
\"number\": \"BSN0001005\"
},
{
\"name\": \"Tech Service Offering2\"
}
],
\"parent_app_service\": [
{
\"sys_id\": \"a2f0618040697410f87713b656474255\"
}
]
},
\"tags\": [
{
\"key\": \"key1\",
\"value\": \"value1\"
},
{
\"key\": \"key2\",
\"value\": \"value2\"
}
]
}" \
--user 'username':'password'
Le corps de la réponse comprend des informations d’identification et d’état.
{
"result": {
"app_service": {
"sys_id": "5780cb604061f410f87713b656474271",
"name": "Test Register",
"number": " SNSVC0001014"
},
"message": "Service registered successfully",
"status": "INSERT"
}
}
Services SG – POST / sg_services/app_service/relationship/create
Construit des relations en amont telles que des applications d’entreprise, des offres de service d’entreprise et d’autres services d’application.
Cette API crée une relation en prenant l’entrée avec un seul parent et un objet enfant correspondant.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/create
URL par défaut : /api/sn_service_graph/sg_services/app_service/relationship/create
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| enfant | Informations identifiant le service d’application enfant avec lequel créer une relation. Un groupe de CI dynamique peut être ajouté en tant qu’enfant, mais ne peut pas être parent. Type de données : objet Table : Instance de service [cmdb_ci_service_auto] |
| enfant.<service_app_identifier> | Détails identifiant le service d’application enfant avec lequel créer une relation. Une seule option est requise. Chaque option est répertoriée par priorité de traitement :
Type de données : chaîne |
| parent | Détails identifiant le service d’application parent avec lequel créer une relation. Type de données : objet |
| parent.<service_app_identifier> | Informations identifiant le service d’application. Une seule option est requise. Chaque option est répertoriée par priorité de traitement :
Type de données : chaîne |
| parent.class_name | Nom de la classe qui contient le service d’application. Le nom de classe parent doit provenir de l’une des tables suivantes :
Par défaut : cmdb_ci_service_auto 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment créer une relation à partir d’un service d’application.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"child\": {
\"name\": \"wdfsdf\",
\"environment\": \"Test\",
\"version\": \"1.0\"
},
\"parent\": {
\"sys_id\": \"abcdefg\",
\"name\": \"business App1\",
\"class_name\": \"service_offering\"
}
}" \
--user 'username':'password'
Résultats indiquant la création réussie d’une relation de service d’application.
{
"result": {
"status": "success"
}
}
Services SG : POST/sg_services/app_service/relationship/delete
Supprime une relation en amont de service d’application.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/relationship/delete
URL par défaut : /api/sn_service_graph/sg_services/app_service/relationship/delete
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| enfant | Informations décrivant la relation enfant à supprimer de l’application de service. Type de données : objet |
| nom du champ child.<IRE> | Un ou plusieurs champs IRE identifiant le service d’application enfant. Par exemple, nom ou version. Type de données : chaîne |
| numéro.enfant | Numéro unique qui identifie le service d’application enfant. Type de données : chaîne |
| child.sys_id | Sys_id du service d’application enfant répertorié dans l’instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
| parent | Détails identifiant le service d’application parent à partir duquel supprimer une relation. Type de données : objet |
| Nom du champ parent.<IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| numéro.parent | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| parent.sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
| parent.class_name | Nom de la classe qui contient le service d’application. Le nom de classe parent doit provenir de l’une des tables suivantes :
Par défaut : cmdb_ci_service_auto 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment supprimer une relation d’un service d’application.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/relationship/delete" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"child\": {
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\"
},
\"parent\": {
\"sys_id\": \"abcdefg\",
\"name\": \"business App1\",
\"class_name\": \"service_offering\"
}
}" \
--user 'username':'password'
Résultats indiquant la suppression réussie d’une relation de service d’application.
{
"result": {
"status": "success"
}
}
Services Service Graph – POST /sg_services/app_service/state
Modifie l’état du cycle de vie du service d’application en activer, désactiver ou mettre hors service.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/state
URL par défaut : /api/sn_service_graph/sg_services/app_service/state
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| État | Requis. État du cycle de vie du service d’application. Valeurs valides :
Type de données : chaîne Stocké dans : Instance de service [cmdb_ci_service_auto] |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| état | Indique la réussite ou l’échec. Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment modifier l’état du cycle de vie d’un service d’application à activer.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/state" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\",
\"state\": \"activate\"
}
}" \
--user 'username':'password'
Résultats indiquant une opération réussie.
{
"result": {
"status": "success"
}
}
Services Service Graph – POST/sg_services/app_service/update
Met à jour un service d’application existant fourni et crée des balises pour le service d’application donné.
- sys_id : si sys_id, le système utilise uniquement le sys_id et ignore toute valeur supplémentaire.
- nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore toute valeur supplémentaire.
- <Nom du champ IRE> le système n’utilise ces valeurs que si le sys_id ou le numéro n’est pas fourni.
Format d'URL
URL versionnée : /api/sn_service_graph/{api_version}/sg_services/app_service/update
URL par défaut : /api/sn_service_graph/sg_services/app_service/update
Paramètres de demande pris en charge
| 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 différente de la dernière. Type de données : chaîne |
| Nom | Description |
|---|---|
| <champs ou balises à mettre à jour> | Utilisez des paires clé-valeur pour identifier chaque champ ou balise à mettre à jour. Seules les informations de base peuvent être mises à jour, aucune relation en amont ne peut être mise à jour. Type de données : chaîne |
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Vous pouvez envoyer le sys_id, le numéro ou l’IRE pour identifier un service d’application ; Toutefois, aucun de ces champs ne peut être mis à jour lorsqu’il est utilisé comme identificateur. Pour mettre à jour les champs IRE, l’entrée doit inclure le sys_id ou le numéro comme identificateur. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. 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.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 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 l’utilisateur ne dispose pas du rôle app_service_admin. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| <nom du champ IRE> | Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, nom ou version. Type de données : chaîne |
| Numéro | Numéro unique qui identifie le service d’application. Type de données : chaîne |
| sys_id | Sys_id du service d’application répertorié dans la table Instance de service [cmdb_ci_service_auto]. Type de données : chaîne |
| <champs mis à jour> | Si la mise à jour réussit, chaque champ modifié envoyé dans la charge utile est répertorié dans le corps de la réponse. |
Demande cURL
L’exemple suivant montre comment mettre à jour un service d’application en utilisant le nom comme champ IRE.
curl "https://instance.service-now.com/api/sn_service_graph/sg_services/app_service/update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
{
\"name\": \"Test Register\",
\"environment\": \"Test\",
\"version\": \"1.0\"
}
}" \
--user 'username':'password'
La réponse inclut les informations d’identification du service d’application et les champs mis à jour.
{
"result": {
"sys_id": "123456",
"number": "SVCKji0w9e",
"name": "Test Register",
"environment": "Test",
"version": "1.0"
}
}