API Intégration continue/Offre en continu (CICD)

L’API CICD fournit des points de terminaison qui permettent l’intégration avec des outils communs DevOps pour la création de pipelines. Ces outils incluent Jenkins, Azure Pipelines, GitLab, GitHub ActionsAtlassian , Bamboo/Pipelines, etc.

Il offre aux intégrateurs la possibilité de créer CICD des pipelines pour Now Platform les applications pilotées par des workflows de demande d’extraction/fusion typiques du développement orienté source. Il tire parti du contrôle de source, du référentiel d’applications et Framework de tests automatisés des fonctionnalités.

L’API CI/CD fournit les domaines de produits et de fonctionnalités suivants :

• Contrôle de source

  Appliquez des modifications à distance pour une application liée à un référentiel Git distant via la fonctionnalité de contrôle de source de Studio, sur une instance spécifique.

  Importe une application à l’aide de l’URL du référentiel et du nom de branche spécifiés.

• Référentiel d’applications : disponible pour les applications incluses dans le périmètre, l’application globale, les personnalisations d’application pour les applications incluses dans le périmètre et via des modules d’extension ServiceNow Store.
  • Publiez une application à partir d’une instance dans le référentiel d’applications connecté.
  • Installez une application sur une instance à partir du référentiel d’applications connecté.
  • Restaurez une application qui a été installée dans le contexte de restauration.
• Lot
  • Définissez un fichier manifeste JSON pour l’installation par lots de plusieurs applications ensemble.
  • Restaurez l’installation complète par lots via le contexte de restauration.
  • Renvoie les résultats d’une installation par lots en fonction d’un identificateur de résultat spécifié.
• Modules d'extension
  • Activez un module d’extension.
  • Restaurez un module d’extension via le contexte de restauration.
• Framework de tests automatisés (ATF)
  • Démarrez une suite de tests ATF.
  • Obtenir le résultat réussite/échec d’une suite de tests ATF.
• Analyse d’instance
  • Lancer une analyse d’instance (complète, analyse de point sur la table, analyse de point sur l’enregistrement, application incluse dans le périmètre, ensemble de mises à jour, combinaison de ces éléments).
  • Obtenir le résultat réussite/échec d’une exécution d’analyse d’instance.
• Progression

  Obtenez le pourcentage d’achèvement sur une instance pour les processus initiés par d’autres appels de point de terminaison. Vous pouvez utiliser cette fonctionnalité pour interroger la progression jusqu’à ce qu’elle soit terminée avant de passer à l’étape suivante.

Cette API utilise un modèle de réponse asynchrone. Lorsque vous appelez un point de terminaison, par exemple pour exécuter une suite de tests /sn_cicd/testsuite/run, le point de terminaison déclenche la fonction associée, comme le démarrage de l’exécution de la suite de tests. Le point de terminaison renvoie ensuite un message de réponse contenant l’état d’exécution de la fonction demandée, généralement En attente, ainsi qu’un identificateur unique et un lien. Utilisez ces informations pour obtenir des informations supplémentaires sur la progression, la source, les résultats et/ou les conclusions de la demande. En fonction de la demande de fonction, vous pouvez utiliser l’un des moyens suivants pour obtenir des informations supplémentaires sur une demande :

• Appelez le point de terminaison /sn_cicd/progress/{progress_id} à l’aide du links.progress.id paramètre retourné par le point de terminaison d’origine.
• Appelez le point de terminaison /sn_cicd/testsuite/results/{result_id} à l’aide du links.result.id paramètre renvoyé par le point de terminaison d’origine.
• Appelez le point de terminaison /sn_cicd/instance_scan/result/{progress_id} à l’aide du paramètre renvoyé par le links.progress.id point de terminaison d’origine.
• Appelez le point de terminaison /sn_cicd/sc/apply_stash/{stash_id} à l’aide du paramètre renvoyé par le links.stash.id point de terminaison /sn_cicd/progress/{progress_id} .
• Lier au links.<progress/result/source/findings>.url paramètre renvoyé par le point de terminaison d’origine.

Remarque :

Pour installer une application à partir d’un référentiel, l’application doit d’abord être publiée dans le référentiel à l’aide du point de terminaison /sn_cicd/app_repo/publish . Une fois publiée, n’importe quelle instance connectée à ce référentiel peut installer et restaurer l’application. Si l’application n’est pas publiée en premier, la demande d’installation échoue.

Le rôle sn_cicd.sys_ci_automation ou admin est requis pour utiliser cette API.

À compter de Tokyo, les CICD points de terminaison d’API qui doivent obtenir le verrou/mutex à l’échelle de l’instance pour effectuer l’opération demandée utilisent une file d’attente plutôt que de rejeter des demandes lorsque le verrou/mutex à l’échelle de l’instance est occupé. Plusieurs CICD pipelines effectuent simultanément des demandes sans détecter le rejet et le nouvel essai, et peuvent simplement surveiller la progression, comme ils le feraient pour les demandes réussies auparavant. Ce comportement est activé par défaut.

La file d’attente actuelle peut être inspectée par un utilisateur ayant le rôle administrateur en accédant à Diagnostic du système > File d’attente des opérations de l’application. À partir de là, la file d’attente peut être mise en pause et reprise par l’administrateur pour permettre d’autres opérations manuelles qui peuvent nécessiter le verrouillage/mutex à l’échelle de l’instance.

Remarque :

Lorsqu’elle est mise en pause, toute opération en cours est exécutée jusqu’à son terme, mais aucune nouvelle opération n’est démarrée. L’API continuera d’accepter et de mettre en file d’attente les nouvelles demandes. Une opération en attente peut également être annulée avant de commencer à s’exécuter en mettant à jour le suivi des exécutions répertorié sur un état Annulé. Si, pour une raison quelconque, une opération ne peut pas se poursuivre après le délai d’expiration spécifié dans com.glide.update_operation.job_cancel_timeout_minutes (48 heures par défaut), elle sera annulée.

Lorsqu’une mise à niveau est planifiée, la file d’attente passe à l’état de mise à niveau en pause deux heures avant la mise à niveau, sauf si elle est remplacée par la propriété com.glide.update_operation.queue_upgrade_window. Cela permet de terminer toute opération en cours avant le début de la mise à niveau.

Remarque :

La file d’attente reprend automatiquement lorsque la mise à niveau est terminée.

Pour plus d’informations sur CICD, voir :

• Continuous Integration and Continuous Delivery (CICD) Spoke
• https://plugins.jenkins.io/servicenow-cicd/
• https://marketplace.visualstudio.com/items?itemName=ServiceNow.vss-services-servicenow-cicd
• https://github.com/marketplace?type=actions&query=servicenow
• https://hub.docker.com/r/servicenowdevx/sncicd-gitlab-docker

CI/CD : OBTENIR /sn_cicd/app/batch/results/{result_id}

Renvoie les résultats d’une installation par lots en fonction d’un identificateur de résultat spécifié.

Appelez cette méthode après avoir appelé le point de terminaison /sn_cicd/app/batch/install pour obtenir les résultats de l’installation par lots. Utilisez la valeur retournée dans le paramètre des résultats de retour links.results.id du point de terminaison /sn_cicd/app/batch/install pour result_id ce point de terminaison. Vous pouvez également appeler le point de terminaison /api/sn_cicd/progress/{progress_id} pour obtenir des informations sur l’avancement de l’installation si elle n’est pas encore terminée.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app/batch/results/{result_id}

URL par défaut : /api/sn_cicd/app/batch/results/{result_id}

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
result_id	Sys_id de l’installation par lots pour laquelle renvoyer des informations sur les résultats. Cette valeur est renvoyée dans le links.results.id paramètre du point de terminaison /sn_cicd/app/batch/install . Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : 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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
batch_items	Tableau JSON, où chaque objet fournit des détails sur l’installation d’un package. Type de données : tableau "batch_items" [{ "customization_version": "String", "id": "String", "install_date": "String", "name": "String", "notes": "String", "state": "String", "status_message": "String", "type": "String", "url": "String", "version": "String" }]
batch_items.customization_version	Applicable uniquement lorsque le batch_items.type paramètre est défini sur application ou module d’extension et que le requested_customization_version paramètre est transmis dans la demande d’installation par lots. Version du package de personnalisation de l’application de stockage ou du module d’extension inclus ServiceNow dans le périmètre à installer, telle que 1.0.2 ou 2.3. Type de données : chaîne
batch_items.id	Sys_id de l’application ou l’identificateur du module d’extension à installer. Identique au packages.id paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Type de données : chaîne
batch_items.date_installation	Date et heure d’installation du package. Vide si la demande est toujours en cours. Type de données : chaîne
batch_items.name	Nom du package. Type de données : chaîne
batch_items.notes	Notes spécifiées par l’utilisateur sur le package. Identique au packages.notes paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Type de données : chaîne
batch_items.État	État actuel de l’installation du package associé. Valeurs possibles : Échoué En cours Installé Non valide Prêt Restauré Type de données : chaîne
batch_items.status_message	Décrit toutes les erreurs qui se sont produites lors de l’installation du package et/ou des personnalisations. Type de données : chaîne
batch_items.type	Type d’application. Identique au packages.type paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Valeurs valides : l'application module d'extension Type de données : chaîne
batch_items.url	URL de l’enregistrement d’installation de package associé sur votre ServiceNow instance. Type de données : chaîne
batch_items.version	Version du package à installer, telle que 1.0.2 ou 2.3. Identique au packages.requested_version paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Type de données : chaîne
batch_plan	Décrit le plan de traitement par lots de l’installation. Type de données : objet "batch_plan": { "id": "String", "name": "String", "notes": "String", "state": "String", "url": "String" }
batch_plan.id	Sys_id des informations sur les résultats renvoyés. Même valeur que celle transmise dans le paramètre de result_id demande. Type de données : chaîne
batch_plan.name	Nom descriptif spécifié par l’utilisateur pour cette demande par lots. Identique au name paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Type de données : chaîne
batch_plan.Remarques	Notes transmises lors de l’appel de l’installation par lots. Identique au notes paramètre de l’appel de point de terminaison d’initiation /sn_cicd/app/batch/install . Type de données : chaîne
batch_plan.État	État actuel de l’installation par lots globale. Valeurs possibles : Échoué En cours Installé Non valide Installation partielle Prêt Restauré Type de données : chaîne
batch_plan.url	URL de l’enregistrement du plan d’installation par lots sur votre ServiceNow instance. Type de données : chaîne

Demande cURL

Cet exemple vérifie l’état d’un plan d’installation par lots appelé Opérations IT de la version 2.0.

curl 'instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561 \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password' 

{
"result": {
  "batch_plan": {
    "name":“Release 2.0 IT Operations”,
    "id": "df24b1e9db2d0110b5e3f6c5ae97c561",
    "url": "https://instance.service-now.com/sys_batch_install_plan.do?sys_id=df24b1e9db2d0110b5e3f6c5ae97c561",
    "state": "Installed",
    "notes": "User specified notes for batch install plan",
  }
  "batch_items": [
    {
      "name": "com.sn_cicd_spoke",
      "type": "Application",
      "version": "7.0.0",
      "state": "Installed",
      "install_date": "2020-08-31 15:30:01",
      "id": "c159b1e9db1c0010b5e3f6c5ae961903",
      "url":"https://instance.service-now.com/sys_batch_install_item.do?sys_id=c159b1e9db1c0010b5e3f6c5ae961903",
      "notes" : ""
    },
    {
      "name": "Customization for CSM App1",
      "type": "Application",
      "version": "1.0.0",
      "state": "Installed",
      "install_date": "2020-08-31 15:32:01",
      "id": "e824b1e9db2d1001b5e3f6c5ae97d628",
      "url": "https://instance.service-now.com/sys_batch_install_item.do?sys_id=e824b1e9db2d1001b5e3f6c5ae97d628",
      "notes": "Customized headers.",
      "customization_version": "2.1.1”,
      "status_message": ""

    }]
  }
}

CI/CD : GET /sn_cicd/instance_scan/result/{progress_id}

Renvoie la progression et l’état actuels de la fonction d’analyse d’instance CI/CD associée à un ID en cours transmis. Appelez cette méthode après avoir appelé l’un des autres points de terminaison CI/CD d’analyse d’instance tels que /sn_cicd/instance_scan/full_scan ou /sn_cicd/instance_scan/point_scan.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/result/{progress_id}

URL par défaut : /api/sn_cicd/instance_scan/result/{progress_id}

Paramètres de demande pris en charge

Tableau 7. Paramètres

Paramètre	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
progress_id	Identificateur unique de la fonction pour laquelle renvoyer des informations de progression. Cette valeur est renvoyée dans le links.progress.id paramètre du point de terminaison à l’origine de l’action, par exemple /sn_cicd/instance_scan/full_scan ou /sn_cicd/instance_scan/point_scan. 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 8. En-têtes de demandes

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

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

En-tête	Description
Aucun

Codes d'état

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

Corps de la demande

L’API accepte ces éléments JSON ou XML dans le corps de la demande.

Tableau 11. Éléments acceptés dans le corps de la demande

Élément	Description
Aucun

Corps de réponse

L’API renvoie ces éléments JSON ou XML dans le corps de la réponse.

Tableau 12. Éléments renvoyés dans le corps de réponse

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.résultats	Objet contenant des informations sur les conclusions de l’analyse d’instance.
liens.résultats.étiquette	Informations supplémentaires sur les conclusions de l’analyse d’instance.
liens.résultats.url	URL à utiliser pour récupérer une liste des enregistrements ayant violé les contrôles.
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
liens.résultats	Informations sur les résultats. Type de données : objet "results": { "id": "String", "url": "String" }
links.results.id	Sys_id de l’enregistrement des résultats de l’analyse d’instance.
liens.résultats.url	URL à utiliser pour obtenir les résultats de l’analyse d’instance.
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Exemple de demande cURL

curl 'instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

{
    "result": {
        "links": {
            "findings": {
                "url": "https://instance.service-now.com/api/now/table/scan_finding?sysparm_query%3Dresult%3D6f4cf8651b7800103d374087bc4bcb41%5EORDERBYsys_id",
                "label": "First 10,000 findings"
            },
            "progress": {
                "id": "a74c70a11b7800103d374087bc4bcb28",
                "url": "https://instance.service-now.com/api/sn_cicd/progress/a74c70a11b7800103d374087bc4bcb28"
            },
            "results": {
                "id": "a74c70a11b7800103d374087bc4bcb28",
                "url": "https://instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28"
            }
        },
        "status": "2",
        "status_label": "Successful",
        "status_message": "",
        "status_detail": "",
        "error": ""
    }
}

CI/CD : GET /sn_cicd/progress/{progress_id}

Renvoie la progression et l’état actuels de la Intégration et offre en continu (CICD) fonction associée à un ID de progression spécifié.

Appelez cette méthode après avoir appelé l’un des points de terminaison CICD asynchrones tels que /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/run ou /sn_cicd/sc/apply_stash.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/progress/{progress_id}

URL par défaut : /api/sn_cicd/progress/{progress_id}

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
progress_id	Identificateur unique de la fonction pour laquelle renvoyer des informations de progression. Cette valeur est renvoyée dans le links.progress.id paramètre du point de terminaison à l’origine de l’action, par exemple /sn_cicd/app_repo/publish, /sn_cicd/app_repo/install, /sn_cicd/testsuite/run ou /sn_cicd/sc/apply_stash. Type de données : chaîne

Tableau 14. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 16. En-têtes de demandes

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

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

En-tête	Description
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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
liens.résultats	Informations sur les résultats. Type de données : objet "results": { "id": "String", "url": "String" }
links.results.id	Identificateur unique des informations de résultats. Utilisez cette valeur pour l’appel du point de terminaison des résultats associé. Type de données : chaîne
liens.résultats.url	URL à utiliser pour obtenir les résultats de l’exécution du point de terminaison, tels que les résultats. Type de données : chaîne
liens.source	Informations sur la source. Type de données : objet "source": { "id": "String", "url": "String" }
links.source.id	Identificateur unique de l’enregistrement source dans la table Suivi des exécutions [sys_execution_tracker]. Type de données : chaîne
liens.source.url	URL à utiliser pour obtenir les informations sur la source dans la table Suivi des exécutions [sys_execution_tracker]. Type de données : chaîne
liens.dissimulation	Si un a été créé lors d’une opération de apply_changes , cet objet contient des informations sur la dissimulation. Cet objet n’est pas renvoyé si aucune dissimulation n’a été créée. Type de données : objet "stash": { "id": "String", "url": "String" }
links.stash.id	Identificateur unique de la dissimulation créée. Utilisez cette valeur lors de l’appel du CI/CD - POST /sn_cicd/sc/apply_stash/{stash_id} point de terminaison pour appliquer la dissimulation. Type de données : chaîne
liens.stash.url	URL de la dissimulation associée. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Obtenir la progression d’une exécution de suite de tests

curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

Progression de l’appel d’application des changements.

{
    "result": {
        "links": {
            "progress": {
                "id": "a4fae8911bdc00103d374087bc4bcbbd",
                "url": "https://instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
            },
            "source": {
                "id": "59c4c4d11b5c00103d374087bc4bcb26",
                "url": "https://instance.servicenow.com/api/now/table/sys_app/59c4c4d11b5c00103d374087bc4bcb26"
            }
        },
        "status": "2",
        "status_label": "Successful",
        "status_message": "This operation succeeded",
        "status_detail": "Successfully applied commit 1f14e11a7dedcbfa194beb5875fcdaa15ed8accb from source control",
        "error": "",
        "percent_complete": 100
    }
}

Obtenez la progression d’un appel d’application des changements. Dans ce cas, des changements non enregistrés/non validés ont été apportés à l’instance dans Studio, une dissimulation a donc été créée pour contenir les changements non enregistrés

curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

Progression fournissant des informations sur la dissimulation créée.

{
"result": {
   "links": {
      "progress": {
         "id": "5b12eca4e0429110f8771827f8fd36a4",
         "url": "https://instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4"
       },
       "stash": {
         "id": "fc2224e4e0429110f8771827f8fd3634",
         "url": "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"
}
    },
    "status": "2",
    "status_label": "Successful",
    "status_message": "This operation succeeded",
    "status_detail": "Successfully applied commit fa5626f6f1f7fef677c16b4a0dd8b22ba8a6e311 from source control",
    "error": "",
    "percent_complete": 100
  }
}

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

Progression de l’exécution d’une suite de tests (/sn_cicd/testsuite/run).

{
"result": {
   "links": {
      "progress": {
         "id": "e891389d1b1040103d374087bc4bcb75",
         "url": "https://instance.servicenow.com/api/sn_cicd/progress/e891389d1b1040103d374087bc4bcb75"
       },
       "results": {
         "id": "2891389d1b1040103d374087bc4bcb09",
         "url": "https://instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09"
       }
    },
    "status": "2",
    "status_label": "Successful",
    "status_message": "Suite passed",
    "status_detail": "Suite passed",
    "error": "",
    "percent_complete": 100
  }
}

CI/CD : GET /sn_cicd/testsuite/results/{result_id}

Renvoie les résultats d’une suite de tests exécutée en fonction d’un identificateur de résultats spécifié.

Appelez ce point de terminaison après avoir appelé /sn_cicd/progress/{progress_id} pour obtenir le résultat de la suite de tests exécutée.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/testsuite/results/{result_id}

URL par défaut : /api/sn_cicd/testsuite/results/{result_id}

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
result_id	Identificateur unique des résultats de la suite de tests à récupérer. L’appel de point de terminaison /sn_cicd/progress/{progress_id} correspondant renvoie ces informations. Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 22. En-têtes de demandes

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

Tableau 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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
child_suite_results	Résultats des suites de tests imbriquées. Le format de ce contenu est le même que celui du test parent.
erreur	Message d'erreur. Type de données : chaîne
Liens	Objet contenant tous les liens et sys_ids associés à la réponse. Type de données : objet
liens.résultats	Objet contenant les informations de résultats. Type de données : objet
links.results.id	Identificateur unique des informations de résultats. Utilisez cette valeur lorsque vous appelez le point de terminaison /sn_cicd/testsuite/results/{result_id}. Type de données : chaîne
liens.résultats.url	URL à utiliser pour obtenir les résultats de l’exécution du point de terminaison, tels que les résultats. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée.
rolledup_test_error_count	Nombre de tests avec des erreurs. Type de données : nombre
rolledup_test_failure_count	Nombre de tests ayant échoué. Type de données : nombre
rolledup_test_skip_count	Nombre de tests ignorés. Type de données : nombre
rolledup_test_success_count	Nombre de tests qui se sont déroulés correctement. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label, tel que 0 : en attente. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status, tel que 0 : en attente. Valeurs : En attente En cours d'exécution Réussi Échoué Annulé Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne
test_suite_duration	Temps nécessaire à l’exécution de la suite de tests. Unité : Secondes Type de données : chaîne
test_suite_name	Nom de la suite de tests. Type de données : chaîne
test_suite_status	État de la suite de tests. Type de données : chaîne

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09' \
--request GET \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "results": {
           "id": "2891389d1b1040103d374087bc4bcb09",
           "url": "https://instance.servicenow.com/sys_atf_test_suite_result.do?sys_id=2891389d1b1040103d374087bc4bcb09"
       }
   },
   "status": "2",
   "status_label": "Successful",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "test_suite_status": "success",
   "test_suite_duration": "1 Second",
   "rolledup_test_success_count": 1,
   "rolledup_test_failure_count": 0,
   "rolledup_test_error_count": 0,
   "rolledup_test_skip_count": 0,
   "test_suite_name": "Quick Test",
   "child_suite_results": []
 }
}

CI/CD : POST/sn_cicd/app/batch/install

Installe deux packages ou plus dans un seul lot spécifié.

Un lot peut contenir n’importe quelle combinaison des types suivants :

• Application :
  • Applications incluses dans le périmètre dans qui ServiceNow Store n’appartiennent pas à votre société
  • Applications incluses dans le périmètre ou globales dans le référentiel d’applications qui appartiennent à votre société
  • Vos personnalisations d’application pour les applications du Store dans le référentiel d’applications
• ServiceNow Module d’extension :

  Personnalisations d’application pour les applications incluses dans le périmètre qui ont été regroupées dans un module d’extension et publiées dans le référentiel d’applications.

Remarque :

Ce point de terminaison utilise un modèle de réponse asynchrone. Lorsque vous appelez un point de terminaison, il déclenche la fonction associée, comme le démarrage de l’exécution du plan d’installation par lots. Le point de terminaison renvoie ensuite un message de réponse contenant l’état d’exécution de la fonction demandée, généralement En attente, ainsi qu’un identificateur unique et un lien. Utilisez ces informations pour obtenir des informations supplémentaires sur la progression ou les résultats de la demande.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app/batch/install

URL par défaut : /api/sn_cicd/app/batch/install

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 de corps de demande (XML ou JSON)

Nom	Description
nom	Requis. Nom descriptif spécifié par l’utilisateur pour cette demande par lots. Type de données : chaîne
notes	L’utilisateur a spécifié des remarques supplémentaires sur le plan d’installation par lots. Type de données : chaîne Par défaut : null
Paquets	Requis. Tableau JSON, où chaque objet spécifie les détails d’un package à installer. Type de données : tableau "packages": [{ "id": "String", "load_demo_data": Boolean, "notes": "String", "requested_customization_version": "String", "requested_version": "String", "type": "String" }]
packages.id	Requis. Sys_id de l’application ou l’identificateur du module d’extension à installer. Type de données : chaîne
packages.load_demo_data	Marqueur indiquant si les données de démonstration sont chargées lors de l’installation du package. Valeurs valides : vrai : les données de démonstration doivent être chargées. faux : les données de démonstration ne doivent pas être chargées. Type de données : booléennes Valeur par défaut : false
paquets.notes	Notes spécifiées par l’utilisateur sur le package. Type de données : chaîne Par défaut : null
packages.requested_customization_version	Version de la personnalisation de l’application pour l’application du magasin ou pour le module d’extension inclus ServiceNow dans le périmètre à installer, tel que 1.0.2 ou 2.3. Type de données : chaîne Par défaut : aucune. Si ce paramètre n’est pas défini, le système ne recherche pas de personnalisations pour l’application.
packages.requested_version	Requis si packages.type défini sur l’application ; ignoré si défini sur le module d’extension. Version du package à installer, telle que 1.0.2 ou 2.3. Type de données : chaîne
packages.type	Requis. Type de forfait. Valeurs valides : l'application module d'extension 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. Types pris en charge : application/json ou application/xml. Valeur par défaut : 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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
405	Méthode non valide. La fonctionnalité est désactivée.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object}, "results": {Object}, "rollback": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
liens.résultats	Décrit les informations sur le lien des résultats. Type de données : objet "results": { "id": "String", "url": "String" }
links.results.id	Sys_id des résultats de l’appel de point de terminaison par lots. Utilisez cette valeur lors de l’appel du point de terminaison spécifié dans links.results.url pour interroger les résultats de l’installation par lots. Type de données : chaîne
liens.résultats.url	URL à utiliser pour récupérer les résultats de l’installation par lots. Type de données : chaîne
liens.restauration	Décrit les informations de restauration de l’installation par lots. Type de données : objet "rollback": { "id": "String" }
links.rollback.id	Sys_id des détails de restauration pour les packages installés. Utilisez ce paramètre pour restaurer l’installation des packages spécifiés à leurs versions précédentes à l’aide du point de terminaison /sn_cicd/app/batch/rollback/{rollback_id} . Remarque : L’option de restauration n’est disponible qu’une fois l’installation terminée. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

Cet exemple lance une installation par lots appelée Déploiement de la version 2.2 qui contient trois packages (un de chaque type) à installer.

curl 'instance.servicenow.com/api/sn_cicd/app/batch/install \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password' \
--data { "name": "Release 2.2 Deployment",
 "packages": [
   {
     "id": "syd_id_abcefghi",
     "type": "application",
     "load_demo_data": false,
     "requested_version": "1.0.2",
     "notes": "User specific text to describe this application install"
   },
   { 
     "id": "syd_id_defabcde",
     "type": "application",
     "requested_version": "1.0.0",
     "requested_customization_version": "2.0.7",
     "notes": "Customization for CSM App1"
   },
   {
     "id": "com.glide.some.plugin",
     "type": "plugin",
     "load_demo_data": true,
     "notes": "Plugin related notes"
   }]
 }

{
"result": {
   "links": {
     "progress": {
       "id": "c159b1e9db1c0010b5e3f6c5ae961903",
       "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
     },
     "results": {
       "id": "df24b1e9db2d0110b5e3f6c5ae97c561",
       "url": "https://instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561"
     },
     "rollback":{
       "id": "a329f82e871da64c724ba21c82a764f2"
     },
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

CI/CD : POST /sn_cicd/app/batch/rollback/{rollback_id}

Restaure tous les packages associés à une installation par lots spécifique à leurs versions précédentes.

Ce point de terminaison fonctionne conjointement avec le point de terminaison /sn_cicd/app/batch/install . Le rollback_id est fourni dans les résultats renvoyés de ce point de terminaison. Lorsque ce point de terminaison est appelé, il restaure tous les packages spécifiés dans l’installation associée ; Vous ne pouvez pas restaurer des packages individuels. S’il n’existe aucune version précédente, le point de terminaison désinstalle le package associé.

Remarque :

Ce point de terminaison utilise un modèle de réponse asynchrone. Lorsque vous appelez un point de terminaison, il déclenche la fonction associée, comme le démarrage de l’exécution du plan d’installation par lots. Le point de terminaison renvoie ensuite un message de réponse contenant l’état d’exécution de la fonction demandée, généralement En attente, ainsi qu’un identificateur unique et un lien. Utilisez ces informations pour obtenir des informations supplémentaires sur la progression ou les résultats de la demande.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app/batch/rollback/{rollback_id}

URL par défaut : /api/sn_cicd/app/batch/rollback/{rollback_id}

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
rollback_id	Sys_id du plan d’installation par lots pour lequel restaurer les packages installés à leurs versions précédentes. Cette valeur est renvoyée dans le links.rollback.id paramètre du point de terminaison /sn_cicd/app/batch/install . Type de données : chaîne

Tableau 32. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 34. En-têtes de demandes

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

Tableau 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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

Cet exemple restaure tous les packages du plan de lots d’installation spécifié à leur version précédente.

curl 'instance.servicenow.com/api/sn_cicd/app/batch/rollback/a329f82e871da64c724ba21c82a764f2 \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
     "progress": {
       "id": "c159b1e9db1c0010b5e3f6c5ae961903",
       "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
     },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

CI/CD : PUBLIER /sn_cicd/app_repo/installer

Installe l’application spécifiée à partir du référentiel d’applications sur l’instance effectuant l’appel de point de terminaison.

À l’aide de ce point de terminaison, vous pouvez installer un système de base et ServiceNow Store des applications non modifiés et personnalisésServiceNow, des modules d’extension personnalisés ServiceNow et vos propres ServiceNow applications.

Ce qui suit décrit les paramètres que vous devez transmettre pour implémenter des cas d’utilisation spécifiques. Tous les paramètres qui ne sont pas spécifiés ne sont pas transmis et utilisent les valeurs par défaut associées.

• Pour n’installer que l’application de base et non les personnalisations d’application correspondantes.
  • sys_id : Sys_id de l’application de base qui a été personnalisée.
  • base_app_version : version de l’application de base à installer.
• Pour installer une version spécifiée des personnalisations de l’application et installer automatiquement la version recommandée de l’application de base. La version de l’application de base recommandée est la version de l’application de base qui a été installée sur l’instance lors de la dernière publication des personnalisations. Chaque version des personnalisations d’application a une version d’application de base recommandée correspondante.
  • sys_id : Sys_id de l’application qui a été personnalisée.
  • auto_upgrade_base_app : vrai
  • version : version des personnalisations de l’application à installer.
• Pour installer la dernière version des personnalisations de l’application et sa version d’application de base recommandée correspondante.
  • sys_id : Sys_id de l’application qui a été personnalisée.
  • auto_upgrade_base_app : vrai
• Pour installer la dernière version des personnalisations d’application, mais pas mettre à niveau l’application de base vers la version d’application de base recommandée pour les personnalisations d’application.
  • sys_id : Sys_id de l’application qui a été personnalisée.
  • auto_upgrade_base_app : faux
• Pour installer les personnalisations d’application avec le module d’extension inclus ServiceNow dans le champ d’application de la version actuelle.
  • scope : périmètre du module d’extension qui a été personnalisé OU
  • sys_id : Sys_id de l’application qui a été personnalisée. Il ne s’agit pas de l’ID du module d’extension.
  • version : version des personnalisations de l’application à installer.
• Pour installer les personnalisations d’application pour un module d’extension inclus dans le périmètre déjà installé et activé.
  • sys_id : Sys_id de l’application qui a été personnalisée. Il ne s’agit pas de l’ID du module d’extension.
  • auto_upgrade_base_app : faux
  • version : version des personnalisations de l’application à installer.

Étant donné que les modules d’extension de base ne peuvent avoir qu’une seule version par version de famille, les auto_upgrade_base_app paramètres et base_app_version ne s’appliquent pas aux installations de personnalisation d’application pour les modules d’extension. Pour activer un module d’extension pour la première fois sur une instance, utilisez plutôt le point de terminaison /sn_cicd/plugin/{plugin_id}/activate .

Remarque :

Ce point de terminaison utilise un modèle de réponse asynchrone. Lorsque vous appelez un point de terminaison, il déclenche la fonction associée, comme le démarrage de l’exécution du plan d’installation par lots. Le point de terminaison renvoie ensuite un message de réponse contenant l’état d’exécution de la fonction demandée, généralement En attente, ainsi qu’un identificateur unique et un lien. Utilisez ces informations pour obtenir des informations supplémentaires sur la progression ou les résultats de la demande.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app_repo/install

URL par défaut : /api/sn_cicd/app_repo/install

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
auto_upgrade_base_app	Applicable uniquement si vous avez l’intention d’installer des personnalisations d’application et que l’application de base a été créée sur une version ultérieure à la version actuellement installée. Marqueur indiquant si l’application de base associée doit être automatiquement mise à niveau vers une version ultérieure. Valeurs valides : vrai : mettre à niveau automatiquement l’application de base associée. false : laissez l’application de base comme la version actuellement installée sur l’instance. Type de données : booléennes Valeur par défaut : false
base_app_version	Version de l’application de base à installer. Une application de base est une application tierce disponible dans leServiceNow Store. Si l’application n’a pas de personnalisations d’application, ou si l’application a des personnalisations d’application et que vous ne faites que mettre à jour l’application de base, entrez la version mise à jour de l’application dans ce paramètre. Si vous mettez à jour les personnalisations d’application, ne transmettez pas ce paramètre, mais transmettez le version paramètre. Type de données : chaîne Par défaut : null
périmètre	Requis si sys_id n’est pas spécifié. Nom du périmètre de l’application, par exemple x_aah_custom_app. Vous pouvez localiser cette valeur dans le champ de la scope table Application personnalisée [sys_app] ou de la table Application de stockage [sys_store_app]. Type de données : chaîne
sys_id	Requis si scope n’est pas spécifié. Sys_id de l’application à installer. Vous pouvez localiser cette valeur dans le champ de la Sys ID table Application personnalisée [sys_app] ou de la table Application de stockage [sys_store_app]. Type de données : chaîne
version	Version de l’application à installer. Type de données : chaîne Par défaut : si le base_app_version paramètre est vide et qu’il auto_upgrade_base_app est défini sur vrai, installe les dernières personnalisations de l’application et sa version d’application de base recommandée (à condition de ne pas passer à une version antérieure de l’application de base). Si le auto_upgrade_base_app paramètre est défini sur false, installe les personnalisations de l’application, mais l’application de base n’est pas mise à niveau. Si le base_app_version paramètre est défini, seule l’application de base est installée.

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

Nom	Description
Aucun

En-têtes

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

Tableau 40. En-têtes de demandes

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

Tableau 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.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
rollback_version	Si disponible, la version précédemment installée. Si non disponible, null. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/app_repo/install?sys_id=2d146921dbd80010caf55268dc9619d8' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
     "progress": {
        "id": "c159b1e9db1c0010b5e3f6c5ae961903",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903"
      }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0,
   "rollback_version": "1.1.0"
  }
}

CI/CD : PUBLIER /sn_cicd/app_repo/PUBLIER

Publie l’application spécifiée et tous ses artefacts dans le référentiel d’applications.

Remarque :

S’il existe des modifications non validées des fichiers suivis lorsque vous appelez ce point de terminaison, cela renvoie un code d’état 400 Bad Request. Vous pouvez valider les changements manuellement ou Studio appeler le CI/CD - POST /sn_cicd/sc/apply_changes point de terminaison pour dissimuler les changements. Les changements qui ne sont pas suivis dans la table Mises à jour du client [sys_update_xml] sont validés automatiquement après leur publication dans le référentiel d’applications. Pour plus d’informations sur la mise en page des changements dans la table Mises à jour du client et pour obtenir une description des changements qui ne sont pas représentés dans cette table, reportez-vous à la section Customer Updates table.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app_repo/publish

URL par défaut : /api/sn_cicd/app_repo/publish

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
dev_notes	Notes du développeur à stocker avec l’application. Type de données : chaîne
périmètre	Obligatoire si sys_id aucune option n’est spécifiée. Le périmètre de l’application. Vous pouvez localiser cette valeur dans le scope champ de la table Application personnalisée [sys_app]. Type de données : chaîne
sys_id	Obligatoire si scope aucune option n’est spécifiée. La sys_id de l’application à stocker dans le référentiel. Vous pouvez localiser cette valeur dans le Sys ID champ de la table Application personnalisée [sys_app]. Type de données : chaîne
version	Version sous laquelle stocker l’application. Si le numéro de version est transmis, le processus de publication utilise cette version et met à jour la version de l’application locale si elle est différente. Si le numéro de version n’est pas transmis, le processus de publication utilise la version actuelle de l’application locale et échoue si cette version existe dans le référentiel d’applications. Type de données : chaîne

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

Nom	Description
Aucun

En-têtes

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

Tableau 46. En-têtes de demandes

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

Tableau 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	La demande a échoué. Problèmes possibles : La version de l’application n’est pas correcte ou est passée à une version antérieure. L’application est connectée au contrôle de source et contient des changements non validés qui doivent être résolus. Consultez le message d’erreur retourné pour plus d’informations.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

L’exemple suivant montre comment publier l’application avec le sys_id spécifié et tous ses artefacts dans le référentiel d’applications.

curl 'instance.servicenow.com/api/sn_cicd/app_repo/publish?sys_id=4dd9686d1b9800103d374087bc4bcb3d' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "progress": {
           "id": "d174f8e11bd800103d374087bc4bcbd9",
           "url": "https://instance.service-now.com/api/sn_cicd/progress/d174f8e11bd800103d374087bc4bcbd9"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CI/CD : POST/sn_cicd/app_repo/Restaurer

Lance une restauration d’une application spécifiée vers une version spécifiée.

Remarque :

La fonctionnalité de restauration n’est disponible qu’une fois l’installation terminée.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/app_repo/rollback

URL par défaut : /api/sn_cicd/app_repo/rollback

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 de requête

Nom	Description
périmètre	Requis si sys_id n’est pas spécifié. Nom du périmètre de l’application à restaurer. Type de données : chaîne
sys_id	Requis si scope n’est pas spécifié. Le sys_id de l’application à restaurer. Type de données : chaîne
version	Requis. Version de l’application prévue après l’opération de restauration. Si la demande vise à restaurer une installation de personnalisation d’application, définissez ce champ sur la version de l’application de base que le système est censé avoir après l’opération de restauration. Type de données : chaîne

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

Nom	Description
Aucun

En-têtes

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

Tableau 52. En-têtes de demandes

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

Tableau 53. 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 54. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
405	Méthode non valide. La fonctionnalité est inactive.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/app_repo/rollback?sys_id=2d146921dbd80010caf55268dc9619d8&version=1.1.0' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
      "progress": {
          "id": "f7ddb1eddb1c0010b5e3f6c5ae9619c1",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/f7ddb1eddb1c0010b5e3f6c5ae9619c1"
       }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

CI/CD : POST /sn_cicd/instance_scan/full_scan

Exécute toutes les vérifications actives présentes dans votre instance.

Vous pouvez exécuter les vérifications fournies avec Instance Scan ou créer vos propres vérifications. Pour plus d’informations, consultez Analyse d’instance.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/full_scan

URL par défaut : /api/sn_cicd/instance_scan/full_scan

Paramètres de demande pris en charge

Tableau 55. Paramètres

Paramètre	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

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 56. En-têtes de demandes

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

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

En-tête	Description
Aucun

Codes d'état

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

Corps de la demande

L’API accepte ces éléments JSON ou XML dans le corps de la demande.

Tableau 59. Éléments acceptés dans le corps de la demande

Élément	Description
Aucun

Corps de réponse

L’API renvoie ces éléments JSON ou XML dans le corps de la réponse.

Tableau 60. Éléments renvoyés dans le corps de réponse

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/instance_scan/result/{progress_id}.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Exemple de demande cURL

curl 'instance.service-now.com/api/sn_cicd/instance_scan/full_scan' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

CI/CD - POST /sn_cicd/instance_scan/point_scan

Exécute toutes les vérifications applicables par rapport à un enregistrement spécifié.

Par exemple, si vous exécutez une analyse de points sur un élément de catalogue, seules les vérifications applicables à la table d’éléments de catalogue s’exécutent et seul l’enregistrement spécifié est analysé.

Vous pouvez exécuter les vérifications fournies avec Instance Scan ou créer vos propres vérifications. Pour plus d’informations, consultez Analyse d’instance.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/point_scan

URL par défaut : /api/sn_cicd/instance_scan/point_scan

Paramètres de demande pris en charge

Tableau 61. Paramètres

Paramètre	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
target_table	Requis. Nom de la table dans laquelle se trouve l’enregistrement à analyser, par exemple « Incident ». Type de données : chaîne
target_sys_id	Requis. sys_id de l’enregistrement dans la table spécifiée à analyser. 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 62. En-têtes de demandes

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

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

En-tête	Description
Aucun

Codes d'état

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Paramètres de requête non valides ou vides.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

Corps de la demande

L’API accepte ces éléments JSON ou XML dans le corps de la demande.

Tableau 65. Éléments acceptés dans le corps de la demande

Élément	Description
Aucun

Corps de réponse

L’API renvoie ces éléments JSON ou XML dans le corps de la réponse.

Tableau 66. Éléments renvoyés dans le corps de réponse

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/instance_scan/result/{progress_id}.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Exemple de demande cURL

curl 'instance.service-now.com/api/sn_cicd/instance_scan/point_scan?target_table=incident&target_sys_id=2d146921dbd80010caf55268dc9619d8' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

CI/CD - POST /sn_cicd/instance_scan/suite_scan/combo/{combo_sys_id}

Exécute une analyse à l’aide d’une suite et d’une cible (applications incluses dans le périmètre ou ensembles de mises à jour) qui ont déjà été exécutées précédemment.

Avant d’appeler ce point de terminaison, vous devez appeler les points de terminaison /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps ou /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets , ou exécuter une analyse de la suite dans l’interface utilisateur.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/suite_scan/combo/{combo_sys_id}

URL par défaut : /api/sn_cicd/instance_scan/suite_scan/combo/{combo_sys_id}

Paramètres de demande pris en charge

Tableau 67. 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
combo_sys_id	sys_id de l’analyse à exécuter. L’analyse doit être une analyse existante que vous souhaitez réexécuter. Situé dans la table Combo [scan_combo]. Type de données : chaîne

Tableau 68. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 70. En-têtes de demandes

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

Tableau 71. 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 72. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/instance_scan/result/{progress_id}.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/combo/245d29cc1bd32010178aed72604bcb4b" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Corps de réponse : réussite.

{
  "result": {
    "links": {
      "progress": {
        "id": "c08be5c71b1b2010178aed72604bcb6e",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/c08be5c71b1b2010178aed72604bcb6e"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

CI/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps

Exécute toutes les vérifications actives au sein d’une suite par rapport à une liste d’applications du champ d’application.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/scoped_apps

URL par défaut : /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps

Paramètres de demande pris en charge

Tableau 73. 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
suite_sys_id	Le sys_id de la suite à exécuter. Situé dans la table Suite [scan_check_suite]. Type de données : chaîne

Tableau 74. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
app_scope_sys_ids	Requis. Liste des sys_ids des applications du périmètre à analyser. Situé dans la table Application [sys_scope]. Le tableau ne peut pas être vide. Type de données : tableau app_scope_sys_ids: ["String", "String", "String"]

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 76. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 77. 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 78. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/instance_scan/result/{progress_id}.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Demande cURL

Cet exemple exécute toutes les vérifications actives à l’intérieur d’une suite par rapport à une application incluse dans le périmètre.

curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/scoped_apps" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{app_scope_sys_ids: [\"078e8020950f12a215a92e8ad9b346e0\"]}" \
--user 'username':'password'

Corps de réponse : réussite.

{
  "result": {
    "links": {
      "progress": {
        "id": "147fc14b1b572010178aed72604bcbca",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/147fc14b1b572010178aed72604bcbca"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

CI/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets

Exécute toutes les vérifications actives au sein d’une suite par rapport à une liste d’ensembles de mises à jour.

Remarque :

Ce point de terminaison fait partie de l’API CICD Instance Scan Execution Service et est utilisé sous l’espace de noms sn_cicd.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/update_sets

URL par défaut : /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets

Paramètres de demande pris en charge

Tableau 79. 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
suite_sys_id	Le sys_id de la suite à exécuter. Situé dans la table Suite [scan_check_suite]. Type de données : chaîne

Tableau 80. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
update_set_sys_ids	Requis. Liste des sys_ids des ensembles de mises à jour à analyser. Situé dans la table Ensemble de mises à jour [sys_update_set]. Le tableau ne peut pas être vide. Type de données : tableau update_set_sys_ids: ["String", "String", "String"]

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 82. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Tableau 83. 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 84. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Élément	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique du détail de progression. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/instance_scan/result/{progress_id}.
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Demande cURL

Cet exemple exécute toutes les vérifications actives à l’intérieur d’une suite par rapport à un ensemble de mises à jour.

curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/update_sets" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{update_set_sys_ids: [\"7abef63c1b572010178aed72604bcbfd\"]}" \
--user 'username':'password'

Corps de réponse : réussite.

{
  "result": {
    "links": {
      "progress": {
        "id": "d27511031b972010178aed72604bcb72",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/d27511031b972010178aed72604bcb72"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": ""
  }
}

CI/CD - POST /sn_cicd/plugin/{plugin_id}/activate

Active le module d’extension spécifié.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/plugin/{plugin_id}/activate

URL par défaut : /api/sn_cicd/plugin/{plugin_id}/activate

Paramètres de demande pris en charge

Tableau 85. 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
plugin_id	Identificateur unique du module d’extension. Vous pouvez localiser cet identifiant sur la page Plugins à l’intérieur de la carte du plugin souhaité ; identifié par le nom « ID ». Type de données : chaîne

Tableau 86. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 88. En-têtes de demandes

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

Tableau 89. 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 90. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
liens.résultats	Informations sur les résultats. Type de données : objet "results": { "id": "String", "url": "String" }
links.results.id	Identificateur unique des informations de résultats. Utilisez cette valeur pour l’appel du point de terminaison des résultats associé. Type de données : chaîne
liens.résultats.url	URL à utiliser pour obtenir les résultats de l’exécution du point de terminaison, tels que les résultats. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/activate' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
      "progress": {
          "id": "5b3f052ddb580010caf55268dc961963",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/5b3f052ddb580010caf55268dc961963"
       }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

CI/CD - POST /sn_cicd/plugin/{plugin_id}/rollback

Restaure le module d’extension spécifié à la version installée précédente. Si aucune version antérieure n’a été installée, renvoie une erreur.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}plugin/{plugin_id}/rollback

URL par défaut : /api/sn_cicd/plugin/{plugin_id}/rollback

Paramètres de demande pris en charge

Tableau 91. 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
plugin_id	Identificateur unique du module d’extension. Vous pouvez localiser cet identifiant sur la page Plugins à l’intérieur de la carte du plugin souhaité ; identifié par le nom « ID ». Type de données : chaîne

Tableau 92. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 94. En-têtes de demandes

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

Tableau 95. 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 96. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/rollback' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
      "progress": {
         "id": "6185dd61db980010caf55268dc961916",
          "url": "https://instance.service-now.com/api/sn_cicd/progress/6185dd61db980010caf55268dc961916"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CI/CD - POST /sn_cicd/sc/apply_changes

Commence à appliquer les modifications à partir d’un contrôle de source distant à une application locale ou à une application-personnalisation spécifiée.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/sc/apply_changes

URL par défaut : /api/sn_cicd/sc/apply_changes

Paramètres de demande pris en charge

Tableau 97. 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 98. Paramètres de requête

Nom	Description
auto_upgrade_base_app	Applicable uniquement lorsque les changements sont appliqués à la personnalisation de l’application et que la dernière validation sur le référentiel Git est créée sur une version ultérieure à celle de l’application de base actuellement installée sur l’instance locale. Marqueur indiquant si le système doit mettre à niveau automatiquement l’application de base vers une version ultérieure. Type de données : booléennes Valeur par défaut : true
branch_name	Nom de la succursale dans le système de contrôle de source à partir duquel acquérir l’application. Type de données : chaîne Par défaut : Branche par défaut spécifiée sur le système de contrôle de source.
périmètre	Requis si sys_id n’est pas spécifié. Nom du périmètre de l’application pour laquelle appliquer les modifications, par exemple x_aah_custom_app. Vous pouvez localiser cette valeur dans le champ de la scope table Application personnalisée [sys_app] ou de la table Application de stockage [sys_store_app] pour la personnalisation de l’application. Type de données : chaîne
sys_id	Requis si scope n’est pas spécifié. Le sys_id de l’application auquel appliquer les modifications. Vous pouvez localiser cette valeur dans le champ de la Sys ID table Application personnalisée [sys_app] ou de la table Application de stockage [sys_store_app] pour la personnalisation de l’application. Type de données : chaîne

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

Nom	Description
Aucun

En-têtes

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

Tableau 100. En-têtes de demandes

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

Tableau 101. 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 102. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Informations supplémentaires sur les raisons de l’échec de l’opération. Vide si l’opération réussit. Type de données : chaîne

Demande cURL

curl 'https://instance.servicenow.com/api/sn_cicd/sc/apply_changes?app_sys_id=043db024db737300a9a754e4dc961915' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "progress": {
           "id": "a4fae8911bdc00103d374087bc4bcbbd",
           "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd"
        }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CI/CD - POST /sn_cicd/sc/apply_stash/{stash_id}

Commence à appliquer une « dissimulation » des changements précédemment générée à partir d’un contrôle de source distant à une application locale spécifiée ou à une personnalisation d’application.

Ce point de terminaison fonctionne conjointement avec les points de terminaison et les points de terminaison POST/api/sn_cicd/sc/apply_changesCI/CD : GET /sn_cicd/progress/{progress_id}. Lorsque le point de terminaison POST /api/sn_cicd/sc/apply_changes est appelé, toutes les modifications non enregistrées ou non validées dans App Engine Studio l’instance associée sont enregistrées dans la base de données en tant que dissimulation.

Pour déterminer si une dissimulation a été créée lorsque les modifications ont été initialement appliquées, appelez le point de terminaison GET /sn_cicd/progress/{progress_id} . Si une dissimulation a été créée, l’sys_id (stash_id) et l’URL de la dissimulation sont renvoyés. Pour appliquer les changements dissimulés à l’application associée, appelez ce point de terminaison apply_stash à l’aide du stash_id retourné par le point de terminaison de progression .

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/sc/apply_stash/{stash_id}

URL par défaut : /api/sn_cicd/sc/apply_stash/{stash_id}

Paramètres de demande pris en charge

Tableau 103. 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
stash_id	Identificateur unique de la dissimulation à appliquer. Cette valeur est renvoyée dans le links.stash.id paramètre dans l’appel de point de terminaison correspondant CI/CD : GET /sn_cicd/progress/{progress_id} . Type de données : chaîne

Tableau 104. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 106. En-têtes de demandes

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

Tableau 107. 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 108. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment appeler le point de terminaison apply_stash pour stash_id fc2224e4e0429110f8771827f8fd3634.

curl "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"\
--request POST \
--header "Accept:application/json" \
--header "Content_Type:application/json" \
--user 'username':'password'

La dissimulation est en attente, donc pas encore appliquée.

{
  "result": {
    "links": {
      "progress": {
        "id": "6b04ec28e0429110f8771827f8fd36a4",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/6b04ec28e0429110f8771827f8fd36a4"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CI/CD : POST /sn_cicd/sc/import

Importe une application à l’aide de l’URL du référentiel et du nom de branche spécifiés.

Utilisez ce point de terminaison pour importer une application à partir du contrôle de source dans l’instance appelante afin de pouvoir ensuite utiliser Intégration et offre en continu (CICD) des points de terminaison, tels que /sn_cicd/sc/apply_changes, pour déployer l’application dans les environnements supérieurs.

Remarque :

Avant d’utiliser ce point de terminaison, un référentiel Git qui a été configuré par une autre instance à l’aide du lien vers le contrôle de source doit être disponible.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/sc/import

URL par défaut : /api/sn_cicd/sc/import

Paramètres de demande pris en charge

Tableau 109. 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 110. Paramètres de requête

Nom	Description
auto_upgrade_base_app	Cela s’applique uniquement lorsque l’application importée est une personnalisation d’application et que la dernière validation sur le référentiel Git est générée sur une version ultérieure à celle de l’application de base actuellement installée sur l’instance locale. Marqueur indiquant si le système doit mettre à niveau automatiquement l’application de base vers une version ultérieure. Valeurs valides : vrai : mise à niveau automatique de l’application de base. faux : ne pas mettre à niveau automatiquement l’application de base. Type de données : booléennes Valeur par défaut : vrai
branch_name	Requis. Nom de la branche dans le système de contrôle de source à partir de laquelle importer l’application. Type de données : chaîne
credential_sys_id	Sys_id des informations d’identification ayant accès au référentiel Git. Type de données : chaîne Par défaut : Sys_id défini dans les propriétés système glide.source_control.default_basic_auth_credential_sys_id ou glide.source_control.default_ssh_private_key_credential_sys_id, selon que le repo_url paramètre est un référentiel https ou ssh. Par défaut, cette propriété est vide.
mid_server_sys_id	Sys_id du MID Server à utiliser pour les opérations de contrôle de source pour cette application. Type de données : chaîne Par défaut : chaîne vide/NULL
repo_url	Requis. URL du référentiel Git à partir duquel importer l’application. Type de données : chaîne

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

Nom	Description
Aucun

En-têtes

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

Tableau 112. En-têtes de demandes

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

Tableau 113. 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 114. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment importer l’application située à https://code.devsnc.com/some-user/ncRegrApp1.git dans le main_branch.

curl "https://instance.servicenow.com/api/sn_cicd/sc/import?repo_url=https%3A%2F%2Fcode.devsnc.com%2Fsome-user%2FncRegrApp1.git&branch_name=main_branch&credential_sys_id=af9b6d6180feb010f8779c30d4dd6b6b" \
--request POST \
--header "Accept:application/json" \
--user 'admin':'admin'

Renvoie la progression de l’importation.

{
  "result": {
    "links": {
      "progress": {
        "id": "a18c06ea64f23010f87769cd983d4574",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/a18c06ea64f23010f87769cd983d4574"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CI/CD : POST /sn_cicd/suite de tests/exécution

Démarre une suite de tests automatisée spécifiée. La suite de tests s’exécute sur l’instance à partir de laquelle le point de terminaison a été appelé.

Remarque :

Si la suite que vous exécutez contient des tests d’interface utilisateur, vous devez avoir un exécuteur de test client planifié ouvert ou être en mesure de configurer l’exécution de l’exécuteur de test sans tête. Pour plus d’informations, consultez Navigateur sans en-tête pour Framework de tests automatisés.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/testsuite/run

URL par défaut : /api/sn_cicd/testsuite/run

Paramètres de demande pris en charge

Tableau 115. 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 116. Paramètres de requête

Nom	Description
browser_name	Nom du navigateur à utiliser pour exécuter le test du client. Cette valeur doit correspondre à ce qui est spécifié dans l’exécuteur de test du client planifié. Pour plus d’informations sur les tests exécutables du client planifié, consultez Tests exécutables du client planifié. Type de données : chaîne Valeurs valides : (doit être en minuscules) N'importe lequel chrome Firefox bordure Ie safari Par défaut : n’importe lequel
browser_version	Valeur de départ de la version du navigateur spécifiée dans à utiliser pour browser_name exécuter le test. Par exemple, si vous saisissez « 9 », toutes les versions 9.x.x.x sont activées. Cette valeur doit correspondre à ce qui est spécifié dans l’exécuteur de test du client planifié. Type de données : chaîne
is_performance_run	Facultatif. Marqueur indiquant s’il faut exécuter la suite de tests en tant que test de performance (exécution de performance). Valeurs valides : true : exécute la suite de tests en tant que test de performance. false : exécute la suite de tests avec le comportement par défaut d’un test fonctionnel standard de l’instance. Valeur par défaut : false
os_name	Nom du système d’exploitation sous lequel exécuter la suite de tests. Cette valeur doit correspondre à ce qui est spécifié dans l’exécuteur de test du client planifié. Type de données : chaîne
os_version	Valeur de départ de la version du système d’exploitation sous laquelle exécuter la suite de tests. Par exemple, si vous saisissez « 8 », toutes les versions 8.x.x.x seront activées. Cette valeur doit correspondre à ce qui est spécifié dans l’exécuteur de test du client planifié. Type de données : chaîne
run_in_cloud	Facultatif. Marqueur indiquant s’il faut exécuter la suite de tests dans l’exécuteur dans le cloud ou manuellement. Valeurs valides : vrai : exécute la suite de tests à l’aide de l’exécuteur dans le cloud. false : exécute la suite de tests à l’aide du test exécutable manuel. Valeur par défaut : false
test_suite_sys_id	Requis si test_suite_name n’est pas spécifié. Le sys_id de la suite de tests à exécuter. Cette valeur figure dans la table Test [sys_atf_test_suite]. Type de données : chaîne
test_suite_name	Requis si test_suite_sys_id n’est pas spécifié. Nom de la suite de tests à exécuter. Cette valeur figure dans la table Test [sys_atf_test_suite]. Type de données : chaîne

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

Nom	Description
Aucun

En-têtes

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

Tableau 118. En-têtes de demandes

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

Tableau 119. 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 120. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou ne dispose pas du rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
405	Méthode non valide. La fonctionnalité est inactive.
409	Conflit. L’élément demandé n’est pas unique.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande.

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

Nom	Description
erreur	Message d'erreur. Type de données : chaîne
Liens	Tous les liens et sys_ids associés à la réponse. Type de données : objet "links": { "progress": {Object} }
liens.progrès	Décrit les informations sur le lien de progression. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Identificateur unique à utiliser pour obtenir les détails de la progression de l’opération. Utilisez cette valeur pour appeler le point de terminaison /sn_cicd/progress/{progress_id}. Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression. Type de données : chaîne
liens.résultats	Informations sur les résultats. Type de données : objet "results": { "id": "String", "url": "String" }
links.results.id	Identificateur unique des informations de résultats. Utilisez cette valeur pour l’appel du point de terminaison des résultats associé. Type de données : chaîne
liens.résultats.url	URL à utiliser pour obtenir les résultats de l’exécution du point de terminaison, tels que les résultats. Type de données : chaîne
percent_complete	Pourcentage de la demande qui est terminée. Type de données : nombre
statut	État d’exécution numérique. Utilisé avec status_label. Valeurs : 0 (en attente) 1 (en cours d’exécution) 2 (réussi) 3 (échec) 4 (Annulé) Type de données : chaîne
status_detail	Informations supplémentaires sur l’état actuel. Type de données : chaîne
status_label	Description de l’état d’exécution. Utilisé avec status. Valeurs : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description de l’état actuel. Type de données : chaîne

Demande cURL

curl 'https://instance.servicenow.com/api/sn_cicd/testsuite/run?test_suite_sys_id=632e43900b20220050192f15d6673a7e' \
--request POST \
--header 'Accept: application/json' \
--user 'username':'password'

{
"result": {
   "links": {
       "progress": {
           "id": "0578a8d91bdc00103d374087bc4bcbcc",
           "url": "https://instance.service-now.com/api/sn_cicd/progress/0578a8d91bdc00103d374087bc4bcbcc"
        }
   },
   "status": "0",
   "status_label": "Pending",
   "status_message": "",
   "status_detail": "",
   "error": "",
   "percent_complete": 0
  }
}

Réponse d’échec :

{
"result": {
    "status": "3",
    "status_label": "Failed",
    "status_message": "",
    "status_detail": "",
    "error": "Scheduled test/suite execution is disabled. Change the value of property 'sn_atf.schedule.enabled' to true to enable it"
  }
}