Intégration et offre en continu (CICD) API d’ensemble de mises à jour

L’API d’ensemble de mises à jour CICD fournit des méthodes pour créer, récupérer, prévisualiser, valider et annuler un ensemble de mises à jour.

Cette API est associée aux actions que vous pouvez effectuer sur les ensembles de mises à jour système et nécessite le rôle sn_cicd.sys_ci_automation et Continuous Integration and Continuous Delivery (CICD) REST API le module d’extension (com.glide.continuousdelivery) pour y accéder.

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/retrieve

Récupère un ensemble de mises à jour avec une sys_id donnée et vous permet de supprimer l’ensemble de mises à jour récupéré existant de l’instance.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/retrieve

URL par défaut : /api/sn_cicd/update_set/retrieve

Remarque :

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

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. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
update_set_id	Requis. Sys_id de l’ensemble de mises à jour sur l’instance source à partir de laquelle l’ensemble de mises à jour a été récupéré. Table : Ensembles de mises à jour [sys_update_set] Type de données : chaîne
update_source_id	Sys_id de l’enregistrement de l’instance distante. Table : Instances distantes [sys_update_set_source] Type de données : chaîne
update_source_instance_id	ID d’instance de l’instance distante. Table : Instances distantes [sys_update_set_source] Type de données : chaîne
auto_preview	Marqueur indiquant s’il faut prévisualiser automatiquement l’ensemble de mises à jour après la récupération. Valeurs valides : true : prévisualiser l’ensemble de mises à jour lors de la récupération. faux : ne prévisualisez pas l’ensemble de mises à jour lors de la récupération. Type de données : booléennes Valeur par défaut : false
cleanup_retrieved	Marqueur indiquant s’il faut supprimer l’ensemble de mises à jour récupéré existant de l’instance. Valeurs valides : vrai : supprimer l’ensemble de mises à jour. false : ne pas supprimer l’ensemble de mises à jour Type de données : booléennes Valeur par défaut : false

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

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à 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

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
Liens	Informations sur les liens et les sys_ids associés à l’ensemble de mises à jour. Type de données : objet "links": { "progress": {Object} }
Liens.Progression	Informations sur la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id contenant les détails de progression de l’opération. Vous pouvez utiliser cette valeur lors de l’appel du point CI/CD : OBTENIR /sn_cicd/progression/{progress_id}de terminaison . Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : chaîne
percent_complete	Pourcentage de la demande terminée. Type de données : nombre
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne

Demande cURL

L’exemple suivant récupère un ensemble de mises à jour particulier avec un sys_id et un ID d’instance donnés.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/retrieve?update_set_id=2ce715950d619e10f87785462179bd67&update_source_id=e66613a49d011210f877036c70ae59f7" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse. Affiche des détails sur l’état actuel de l’ensemble de mises à jour et la progression de l’exécution.

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

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/commitMultiple

Valide plusieurs ensembles de mises à jour dans une seule demande en fonction de l’ordre dans lequel ils sont fournis.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/commitMultiple

URL par défaut : /api/sn_cicd/update_set/commitMultiple

Remarque :

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

Paramètres de demande pris en charge

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

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

Tableau 7. Paramètres de requête

Nom	Description
remote_update_set_ids	Requis. Liste des sys_ids associés à tous les ensembles de mises à jour à valider. Sys_ids sont validés dans l’ordre indiqué dans la demande. Remarque : Vous pouvez utiliser le point de terminaison pour obtenir l’ID d’ensemble de CI/CD : OBTENIR /sn_cicd/progression/{progress_id} mises à jour distant. Type de données : chaîne Table : ensembles de mises à jour récupérés [sys_remote_update_set]

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

Nom

Description

force_commit

Marqueur indiquant s’il faut forcer la validation de l’ensemble de mises à jour. Cette fonctionnalité est utile lorsque certains ensembles de mises à jour distants spécifiés dans l’entrée sont déjà validés dans une opération antérieure. Cette fonctionnalité garantit également que l’ordre de validation est respecté dans l’ordre dans lequel les ensembles de mises à jour sont fournis. Valeurs valides : vrai : force les validations de l’ensemble de mises à jour. false : ne force pas la validation de l’ensemble de mises à jour. Si la validation n’est pas forcée, la validation échoue si l’ordre de validation n’est pas respecté. Type de données : chaîne Valeur par défaut : false

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 9. 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 10. En-têtes de réponses

En-tête	Description
Type de contenu	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

Codes d'état

Tableau 11. Codes d'état

Nom	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou n’a pas le rôle sn_cicd.sys_ci_automation.
404	Introuvable. L’élément demandé est introuvable.
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 la réponse (JSON ou XML)

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
Liens	Informations sur les liens et les sys_ids associés à l’ensemble de mises à jour. Type de données : objet "links": { "progress": {Object} }
Liens.Progression	Informations sur la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id contenant les détails de progression de l’opération. Vous pouvez utiliser cette valeur lors de l’appel du point CI/CD : OBTENIR /sn_cicd/progression/{progress_id}de terminaison . Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : chaîne
percent_complete	Pourcentage de la demande terminée. Type de données : nombre
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment valider une mise à jour avec une sys_id donnée.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commitMultiple?remote_update_set_ids=0a9f45ab9d415e10f877036c70ae5968%2Cc2e89999c9e19e10f877184664aecd40" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"force_commit\":\"true\"}" \
--user 'username':'password'

Corps de la réponse.

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

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/preview/{remote_update_set_id}

Affiche un aperçu d’un ensemble de mises à jour pour vérifier les conflits éventuels et récupérer des informations sur la progression de l’opération de l’ensemble de mises à jour.

Remarque :

Si l’ensemble de mises à jour que vous souhaitez prévisualiser n’existe pas sur l’instance, vous devez d’abord utiliser le point de Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/retrieve terminaison pour récupérer l’ensemble de mises à jour ou manuellement dans l’interface utilisateur.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/preview/{remote_update_set_id}

URL par défaut : /api/sn_cicd/update_set/preview/{remote_update_set_id}

Remarque :

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

Paramètres de demande pris en charge

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
remote_update_set_id	Sys_id de l’ensemble de mises à jour à prévisualiser. Table : ensembles de mises à jour récupérés [sys_remote_update_set] Type de données : chaîne

Tableau 13. Paramètres de requête

Nom	Description
Néant

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

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à 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 15. 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 16. En-têtes de réponses

En-tête	Description
Type de contenu	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

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
Liens	Informations sur les liens et les sys_ids associés à l’ensemble de mises à jour. Type de données : objet "links": { "progress": {Object} }
Liens.Progression	Informations sur la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id contenant les détails de progression de l’opération. Vous pouvez utiliser cette valeur lors de l’appel du point CI/CD : OBTENIR /sn_cicd/progression/{progress_id}de terminaison . Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : chaîne
percent_complete	Pourcentage de la demande terminée. Type de données : nombre
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment prévisualiser un ensemble de mises à jour distant à l’aide d’un ID donné.

curl 
curl "https://instance.servicenow.com/api/sn_cicd/update_set/preview/8f4608d39d89da10f877036c70ae5998" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

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

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/back_out

Annule une opération d’installation qui a été effectuée sur un ensemble de mises à jour avec une sys_id donnée.

Pour plus d’informations sur la façon dont l’opération d’annulation affecte un ensemble de mises à jour, reportez-vous à la section Back out an update set.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/back_out

URL par défaut : /api/sn_cicd/update_set/back_out

Remarque :

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

Paramètres de demande pris en charge

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

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

Tableau 19. Paramètres de requête

Nom	Description
rollback_installs	Marqueur indiquant s’il faut restaurer l’installation par lots effectuée pendant la validation de l’ensemble de mises à jour. Valeurs possibles : true : restaurer l’installation. false : ne restaurez pas l’installation. Type de données : booléennes Par défaut : true
update_set_id	Requis. Sys_id de l’ensemble de mises à jour. Table : Ensembles de mises à jour [sys_update_set] Type de données : chaîne

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

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à 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 21. 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 22. En-têtes de réponses

En-tête	Description
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

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur n’est pas un administrateur ou n’a pas le 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 la réponse (JSON ou XML)

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
Liens	Informations sur les liens et les sys_ids associés à l’ensemble de mises à jour. Type de données : objet "links": { "progress": {Object} }
Liens.Progression	Informations sur la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id contenant les détails de progression de l’opération. Vous pouvez utiliser cette valeur lors de l’appel du point CI/CD : OBTENIR /sn_cicd/progression/{progress_id}de terminaison . Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : chaîne
percent_complete	Pourcentage de la demande terminée. Type de données : nombre
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment restaurer une opération d’installation sur une sys_id de mise à jour spécifique.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/back_out?update_set_id=73dd24e39dcd1e10f877036c70ae59ae&rollback_installs=false" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Réponse :

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

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/commit/{remote_update_set_id}

Valide un ensemble de mises à jour avec une sys_id donnée.

Lorsque vous avez prévisualisé un ensemble de mises à jour et que vous avez résolu tous les problèmes, vous pouvez valider l’ensemble de mises à jour à l’aide de ce point de terminaison. La validation d’un ensemble de mises à jour applique tous les changements à l’instance et crée une copie locale de l’ensemble de mises à jour qui contient un enregistrement de mise à jour pour chaque changement. Pour plus d’informations sur la validation d’un ensemble de mises à jour, reportez-vous à la section Commit an update set.

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/commit/{remote_update_set_id}

URL par défaut : /api/sn_cicd/update_set/ valider/{remote_update_set_id}

Remarque :

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

Paramètres de demande pris en charge

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

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
remote_update_set_id	Sys_id de l’ensemble de mises à jour à valider. Remarque : Vous pouvez utiliser le point de terminaison pour obtenir l’ID d’ensemble de CI/CD : OBTENIR /sn_cicd/progression/{progress_id} mises à jour distant. Table : ensembles de mises à jour récupérés [sys_remote_update_set] Type de données : chaîne

Tableau 25. Paramètres de requête

Nom	Description
Néant

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

Nom

Description

force_commit

Marqueur indiquant s’il faut forcer la validation de l’ensemble de mises à jour. Valeurs valides : vrai : valide l’ensemble de mises à jour même si vous ne l’avez pas encore prévisualisé pour vérifier les conflits. false : ne force pas la validation de l’ensemble de mises à jour. Vous devez prévisualiser l’ensemble de mises à jour avant de procéder à la validation. Type de données : chaîne Valeur par défaut : false

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 27. 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 28. En-têtes de réponses

En-tête	Description
Type de contenu	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

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

Nom	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
401	Les informations d’identification de l’utilisateur sont incorrectes.
403	Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
404	Introuvable. L’élément demandé est introuvable.
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 la réponse (JSON ou XML)

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
Liens	Informations sur les liens et les sys_ids associés à l’ensemble de mises à jour. Type de données : objet "links": { "progress": {Object} }
Liens.Progression	Informations sur la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : objet "progress": { "id": "String", "url": "String" }
links.progress.id	Sys_id contenant les détails de progression de l’opération. Vous pouvez utiliser cette valeur lors de l’appel du point CI/CD : OBTENIR /sn_cicd/progression/{progress_id}de terminaison . Type de données : chaîne
liens.progression.url	URL à utiliser pour récupérer les détails de la progression de l’opération exécutée sur l’ensemble de mises à jour. Type de données : chaîne
percent_complete	Pourcentage de la demande terminée. Type de données : nombre
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne

Demande cURL

L’exemple suivant valide l’ensemble de mises à jour avec le sys_id associé.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commit/4ee89999c9e19e10f877184664aecd42" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

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

Ensemble de mises à jour CICD : POST /api/sn_cicd/update_set/create

Crée un nouvel ensemble de mises à jour et insère le nouvel enregistrement dans la table Ensembles de mises à jour [sys_update_set].

Format d'URL

URL versionnée : /api/sn_cicd/{api_version}/update_set/create

URL par défaut : /api/sn_cicd/update_set/create

Remarque :

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

Paramètres de demande pris en charge

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

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

Tableau 31. Paramètres de requête

Nom	Description
description	Description de l’ensemble de mises à jour. Type de données : chaîne Valeur par défaut : nul
périmètre	Requis si le paramètre n’est sys_id pas transmis. Nom du périmètre de l’application dans laquelle créer le nouvel ensemble de mises à jour. Table : Applications [sys_scope] Type de données : chaîne
sys_id	Requis si le paramètre n’est scope pas transmis. Sys_id de l’application dans laquelle créer le nouvel ensemble de mises à jour. Table : Applications [sys_scope] Type de données : chaîne
update_set_name	Requis. Nom à donner à l’ensemble de mises à jour. Type de données : chaîne

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

Nom	Description
Néant

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à 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 33. 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 34. En-têtes de réponses

En-tête	Description
Type de contenu	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

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.

201	L’ensemble de mises à jour a été créé avec succès.
400	Demande incorrecte. Le nom de l’ensemble de mises à jour est nul ou vide, ou le sys_id d’entrée et le champ d’application sont nuls ou vides.
403	Interdit. L’utilisateur n’est pas un administrateur ou n’a pas le rôle sn_cicd.sys_ci_automation.
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 la réponse (JSON ou XML)

Nom	Description
erreur	Message d’erreur avec détails sur l’erreur. Type de données : chaîne
statut	Numéro représentant l’état d’exécution de l’action exécutée sur l’ensemble de mises à jour. Correspond au status_label descripteur. Valeurs possibles : 0 : en attente 1 : En cours d’exécution 2 : Réussi 3 : Échec 4 : Annulé Type de données : chaîne
status_detail	Message détaillé sur l’état d’exécution, le cas échéant. Correspond au champ detailed_message de la table Suivi de l’exécution [sys_execution_tracker]. Type de données : chaîne
status_label	État d’exécution de l’action de l’ensemble de mises à jour. Correspond au status nombre. Valeurs possibles : Annulé Échoué En attente En cours d'exécution Réussi Type de données : chaîne
status_message	Description supplémentaire de l’état actuel de l’action, si disponible. Type de données : chaîne
update_set_id	Sys_id de l’ensemble de mises à jour créé. Table : Ensembles de mises à jour [sys_update_set] Type de données : chaîne

Demande cURL

L’exemple suivant montre comment créer un ensemble de mises à jour avec le nom Testupdateset et le champ d’application défini sur sn_test.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/create?update_set_name=Testupdateset&scope=sn_test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

{
  "result": {
    "status": "2",
    "status_label": "",
    "status_message": "Successfully created update set: Test update set 1",
    "status_detail": "",
    "error": "",
    "update_set_id": "a9a485d1c9a19e10f877184664aecd11"
  }
}