API Service Graph Services

L’API Service Graph 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 version de ServiceNow Store.

Cette API ne peut être utilisée que lorsque le module d’extension CMDB Application API and 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 les opérations critiques qui prennent en charge l’automatisation dans l’ensemble de l’entreprise, vous pouvez exploiter les API ou exécuter les opérations de ligne de commande fournies par l’interface de ligne de commande de l’application CMDB et l’application de stockage API au lieu d’utiliser l’interface utilisateur. L’application CMDB Application CLI et 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.

Les commandes de l’API et de l’interface de ligne de commande de l’application CMDB activent les tâches suivantes :

• Enregistrement et création d’un service d’application et établissement de relations en amont
• Obtention des détails d’un service d’application donné et de ses relations en amont
• Connexion de constructions de niveau supérieur telles que les applications d’entreprise et les 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 la solution de ligne de commande, consultez Commandes disponibles de l’interface de ligne de commande et de l’API de l’application CMDB.

Services SG – POST – /sg_services/app_service/convert

Convertit un service d’application manuel ou de type vide en service d’application calculé. Lors de la conversion, l’enregistrement du service d’application est déplacé dans la table [cmdb_ci_service_calculated] avec la classe nouvellement affectée.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<nom du champ IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 Service d’application [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.

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
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.

Tableau 6. 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 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
statut	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.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<nom du champ IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 Service d’application [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.

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
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.

Tableau 12. 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 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
statut	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 SG – POST – /sg_services/app_service/find

Recherche les détails d’un service d’application donné et de 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 un nombre illimité de services d’application.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 14. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<champs IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 Service d’application [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.

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
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.

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 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, le nom ou la 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": [ { "name": "String", "number": "String", "sys_id": "String", "class_name": "String", "relationship": "String" } ]
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.number	Numéro unique de la relation. Type de données : chaîne
relations.relation	La 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 Service d’application [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 réponse comprend le service d’application et les informations sur la relation.

{
  "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 SG – POST – /sg_services/app_service/remplir

Remplit un service d’application avec une méthode de remplissage de service.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<nom du champ IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 la propriété qui l’accompagne pour identifier le contenu de la population. Un seul objet d’accompagnement est valide par type. Type de données : objet
population_method.group_id	ID du groupe CMDB configuré avec le type de population cmdb_group. Type de données : « chaîne » "population_method": { "group_id": "String", "type": "cmdb_group" } Type de population associé : cmdb_group
population_method.niveaux	Nombre de niveaux à utiliser dans la création du service. Si la valeur du niveau n’est pas fournie, le système vérifie le sys_property correspondant à 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 "population_method": { "levels": Number, "type": "dynamic_service" } Type de population associé : dynamic_service Par défaut : 3 si aucune valeur de niveau n’est définie pour le sys_property
population_method.service_candidate	Identificateur unique du candidat de service. Type de données : chaîne "population_method": { "service_candidate": "String", "type": "tag_based_service_family" } Type de population associé : tag_based_service_family
population_method.relations_service_	Liste des objets contenant des données hiérarchiques pour les CI au sein du service d’application. Tous les CI forment des paires avec un CI parent et un CI enfant. Le CI de niveau supérieur, appelé point d’entrée d’un service d’application, n’a pas de CI parent. Type de données : tableau "population_method": { "service_relations":[ { "child": "String", "parent": "String" } ], "type": "service_hierarchy" } Type de population associée : service_hierarchy
population_method.service_relations.child	Nom d’un CI enfant lié au CI. Type de données : chaîne
population_method.relations_services.parent	Nom d’un CI parent lié 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 "population_method": { "tags": [ { "tag": "String", "value": "String" } ], "type": "tag_list" } Type de population associé : tag_list
population_method.tags.tag	Nom de la 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 : cmdb_group service_hierarchy dynamic_service tag_list tag_based_service_family
sys_id	Sys_id du service d’application répertorié dans la table Service d’application [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.

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.

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

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.

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 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
statut	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 de 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 réussi d’un service d’application.

{
  "result": {
  "status": "success"
  }
}

Services SG – 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.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 26. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<nom du champ IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 "relationships": { "business_app": [Array], "business_service_offering": [Array], "parent_app_service": [Array], "technical_service_offering": [Array] } 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. <nom du champ IRE> Numéro sys_id Type de données : tableau
relationships.business_service_offering	Liste des 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. <nom du champ IRE> Numéro sys_id 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. <nom du champ IRE> Numéro sys_id Type de données : tableau
relationships.technical_service_offering	Liste d’objets représentant les types de relations d’offres de services techniques. Ces valeurs peuvent être définies à l’aide des éléments suivants en tant que paires clé-valeur. <nom du champ IRE> Numéro sys_id Type de données : tableau
sys_id	Sys_id du service d’application répertorié dans la table Service d’application [cmdb_ci_service_auto]. Type de données : chaîne
balises	Liste des objets contenant des définitions de balises sous forme de paires clé-valeur. "tags": [ { "key": "String", "value": "String" }] 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.

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.

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

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.

Tableau 30. 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 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": { "name": "String", "number": "String", "sys_id": "String" }
app_service.name	Nom du service d'application. Type de données : chaîne
Numéro app_service	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 Service d’application [cmdb_ci_service_auto]. Type de données : chaîne
message	Message décrivant l’état. Valeurs possibles : Le service existe déjà Service enregistré avec succès Type de données : chaîne
statut	État indiquant si le service a été enregistré. Valeurs possibles : Insérer : le service d’application a été créé avec succès. Aucune action : le service d’application existe déjà. Aucune action n’a été effectuée. 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 réponse comprend des informations sur l’ID et le statut.

{
  "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

Établit des relations en amont telles que les applications d’entreprise, les 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.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 32. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
enfant	Informations identifiant le service d’application enfant avec lequel créer une relation. L’enfant se trouve dans la table Service d’application [cmdb_ci_service_auto]. Un groupe de CI dynamique peut être ajouté en tant qu’enfant, mais ne peut pas être parent. Type de données : objet "child": { "<service_app_identifier>": "String" }
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 ordre de priorité de traitement : sys_id : Sys_id du service d’application enfant. Numéro : numéro unique qui identifie le service d’application enfant. <Nom de champ IRE> champs IRE identifiant le service d’application. Par exemple, le nom ou la version. 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>": "String", "class_name": "String" }
parent.<service_app_identifier>	Informations identifiant le service d’application. Une seule option est requise. Chaque option est répertoriée par ordre de priorité de traitement : sys_id : Sys_id le service d’application répertorié dans Service d’application [cmdb_ci_service_auto]. Numéro : numéro unique qui identifie le service d’application. <nom de champ IRE> : un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la version. Type de données : chaîne
parent.class_name	Nom de la classe qui contient le service d’application. Le nom de la classe parente doit provenir de l’une des tables suivantes : cmdb_ci_service_auto cmdb_ci_service_discovered cmdb_ci_service_by_tags cmdb_ci_service_calculated service_offering cmdb_ci_business_app 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.

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.

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

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.

Tableau 36. 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 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
statut	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 du service d’application.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 38. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
enfant	Informations décrivant la relation enfant à supprimer de l’application de service. Type de données : objet "child": { "<IRE field name>": "String", "number": "String", "sys_id": "String" }
nom du champ child.<IRE >	Un ou plusieurs champs IRE identifiant le service d’application enfant. Par exemple, le nom ou la 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 le service d’application [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 "parent": { "<IRE field name>": "String", "number": "String", "sys_id": "String", "class_name": "String" }
Nom du champ parent.<IRE >	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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 Service d’application [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 la classe parente doit provenir de l’une des tables suivantes : cmdb_ci_service_auto cmdb_ci_service_discovered cmdb_ci_service_by_tags cmdb_ci_service_calculated service_offering cmdb_ci_business_app 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.

Tableau 40. 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 41. En-têtes de réponses

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.

Tableau 42. 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 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
statut	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 SG – POST – /sg_services/app_service/state

Modifie l’état du cycle de vie du service d’application sur Activer, désactiver ou mettre hors service.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 44. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
<nom du champ IRE>	Un ou plusieurs champs IRE identifiant le service d’application. Par exemple, le nom ou la 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. Ces valeurs sont mises à jour dans la table Services d’application [cmdb_ci_service_auto]. Valeurs valides : ACTIVER – Le cycle de vie est opérationnel et en cours d’utilisation. operational_status=Opérationnel life_cycle_stage=Opérationnel life_cycle_stage_status=En cours d’utilisation DÉSACTIVER – Le cycle de vie n’est pas opérationnel et est au stade de la conception. operational_status=Non opérationnel life_cycle_stage=Conception life_cycle_stage_status=Version RETRAITE – Fin de vie. operational_status=Mis hors service life_cycle_stage=Fin de vie life_cycle_stage_status=Mis hors service Type de données : chaîne
sys_id	Sys_id du service d’application répertorié dans la table Service d’application [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.

Tableau 46. 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 47. En-têtes de réponses

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.

Tableau 48. 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 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
statut	Indique la réussite ou l’échec. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment changer l’état du cycle de vie d’un service d’application pour l’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 SG – 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é.

Les propriétés suivantes pour identifier un CI sont prioritaires comme suit :

1. sys_id : si sys_id, le système utilise uniquement le sys_id et ignore les valeurs supplémentaires.
2. nombre : s’il est fourni sans le sys_id, le système utilise uniquement le numéro et ignore les valeurs supplémentaires.
3. <Nom du champ IRE> : le système n’utilise ces valeurs que si le sys_id ou le numéro ne sont pas fournis.

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

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

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

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, le nom ou la 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 en tant qu’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 Service d’application [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.

Tableau 51. 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 52. En-têtes de réponses

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.

Tableau 53. 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 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, le nom ou la 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 Service d’application [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 des informations d’identification du service d’application et des champs mis à jour.

{
  "result": {
  "sys_id": "123456",
  "number": "SVCKji0w9e",
  "name": "Test Register",
  "environment": "Test",
  "version": "1.0"
  }
}