CdmChangesetsApi

CdmChangessetsApi fournit des points de terminaison qui vous permettent de gérer les ensembles de changements.

À l’aide de ces points de terminaison, vous pouvez :

• Créer de nouveaux ensembles de changements.
• Déployer des ensembles de changements.
• Récupérer des listes d’ensembles de changements individuels.
• Récupère les changements de nœud dans un ensemble de changements.
• Récupère une liste des applications ou des déployables qui sont impactés par un ensemble de changements.
• Supprimer les ensembles de changements.
• Renvoie une liste de composants partagés associés à un ensemble de changements spécifié.

Les points de terminaison Créer des ensembles de changements utilisent une implémentation de mise en file d’attente asynchrone. Avec ce type d’implémentation, vous appelez d’abord le point de terminaison de demande de création d’un ensemble de changements. Ce point de terminaison met votre demande en file d’attente et renvoie un identificateur de validation. Vous utilisez ensuite cet identificateur de validation pour appeler le point de terminaison d’état approprié afin d’obtenir l’état de la demande de création.

Vous devez disposer de l’un des rôles suivants pour accéder à cette API :

• REST scripté ACL de vue CDM (sn_cdm.cdm.viewer)
• REST scripté ACL de l’éditeur CDM (sn_cdm.cdm_editor)

En outre, le module d’extension Gestion des données de configuration (CDM) doit être activé pour que cette API soit disponible dans une instance.

Pour plus d’informations sur les ensembles de changements, consultez Ensembles de changements et contrôle de version dans CDM.

CdmChangesetsApi : DELETE /sn_cdm/changesets

Supprime un ensemble de changements spécifié.

L’appelant doit avoir le rôle d’éditeur CDM pour accéder à ce point de terminaison.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets

URL par défaut : /api/sn_cdm/changesets

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
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]

Tableau 3. Paramètres du corps de la demande

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
Néant

Demande cURL

L’exemple de code suivant montre comment supprimer un ensemble de changements.

curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Pour une suppression réussie de l’ensemble de changements, aucune réponse autre que le code d’état HTTP n’est renvoyée.

None - results defined by the HTTP status code

CdmChangessetsApi : GET /sn_cdm/changesets

Récupère tous les ensembles de changements associés à une Gestion des données de configuration application (CDM) ou à un enregistrement d’ensemble de changements spécifié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets

URL par défaut : /api/sn_cdm/changesets

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

Nom	Description
appName	Requis. Nom de l’application CDM dont vous souhaitez renvoyer les ensembles de changements. Il doit s’agir d’une application active. Type de données : chaîne Table : Application CDM [sn_cdm_application]
Numéro	Numéro de l’ensemble de changements. Si vous transmettez cette valeur, seul l’ensemble de changements spécifié est renvoyé. Il doit s’agir d’un ensemble de changements associé à l’application CDM spécifiée dans le appName paramètre. Type de données : chaîne Par défaut : aucun - renvoie tous les ensembles de changements associés à l’application CDM ou ceux spécifiés par le state paramètre. Table : CDMChangeset [sn_cdm_changeset]
État	État des ensembles de changements à renvoyer. Renvoyer uniquement les ensembles de changements associés à l’application CDM spécifiée pour l’état spécifié. Valeurs valides : Bloqué Recherche de conflits Échec de la validation Validation en cours Validé Ouvert Type de données : chaîne Par défaut : renvoyer tous les ensembles de changements pour tous les états

Tableau 9. Paramètres du corps de la demande

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

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
auto_validate	Marqueur indiquant si les ensembles de changements créés lors de la validation sont validés. Valeurs valides : vrai : valider les ensembles de changements. false : ne validez pas les ensembles de changements. Type de données : booléennes
cdm_application	Détails de l’application CDM associée à l’ensemble de changements. Type de données : objet "cdm_application": { "link": "String", "value": "String" }
cdm_application.lien	Requête à utiliser pour appeler le point de terminaison REST de la table afin de récupérer l’application CDM associée. Type de données : chaîne
cdm_application.valeur	Sys_id de l’application CDM associée. Type de données : chaîne Table : Application CDM [sn_cdm_application]
committed_at	Date et heure de la dernière validation de l’ensemble de changements. Type de données : chaîne Format : JJ-MM-AAAA hh :mm :ss
committed_by	Détails sur l’utilisateur qui a validé l’ensemble de changements. Type de données : objet "committed_by": { "link": "String", "value": "String" }
committed_by.lien	Appel pour obtenir l’enregistrement de l’utilisateur qui a validé l’ensemble de changements à l’aide de l’API de table REST. Type de données : chaîne
committed_by.valeur	Sys_id de l’utilisateur qui a validé l’ensemble de changements. Type de données : chaîne
description	Brève description de l’objectif de l’ensemble de changements. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
last_conflict_detection_time	Temps écoulé depuis la dernière détection de conflit. La détection de conflit est effectuée chaque fois qu’un ensemble de changements est validé. Type de données : nombre Unité : millisecondes
last_updated	Date et heure auxquelles un changement a été apporté aux données de configuration associées via cet ensemble de changements. Format : JJ-MM-AAAA hh :mm :ss Type de données : chaîne
Numéro	Numéro unique d’ensemble de changements. Type de données : chaîne
publish_option	Option de publication pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez aucun instantané. publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none
État	État actuel de l’ensemble de changements. Valeurs possibles : Bloqué Recherche de conflits Échec de la validation Validation en cours Validé Ouvert Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui a créé l’ensemble de changements. Par exemple, able.tuter. Type de données : chaîne
sys_created_on	Date et heure auxquelles l’ensemble de changements a été créé. Type de données : chaîne Format : JJ-MM-AAAA hh :mm :ss
sys_id	Sys_id de l’ensemble de changements. Type de données : chaîne Table : CDMChangeset [sn_cdm_changeset]
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour l’ensemble de changements pour la dernière fois. Par exemple, able.tuter. Type de données : chaîne
sys_updated_on	Date et heure de dernière mise à jour de l’ensemble de changements. Type de données : chaîne Format : JJ-MM-AAAA hh :mm :ss
Titre	Titre de l’ensemble de changements. Type de données : chaîne

Demande cURL

Cet exemple de code montre comment récupérer un ensemble de changements spécifique.

curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Renvoyer les résultats :

{ 
  "result": [ 
    { 
      "description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "cdm_application": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_updated_on": "2022-06-29 13:09:47", 
      "title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "number": "Chset-946", 
      "sys_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "sys_updated_by": "admin", 
      "committed_at": "2022-06-29 13:09:46", 
      "sys_created_on": "2022-06-29 13:09:46", 
      "committed_by": { 
        "value": "6816f79cc0a8016401c5a33be04be441", 
        "link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441" 
      }, 
      "state": "committed", 
      "auto_validate": true, 
      "publish_option": "publish_none", 
      "last_conflict_detection_time": "1656508187450", 
      "sys_created_by": "admin", 
      "last_updated": "2022-06-29 13:09:46" 
    } 
  ] 
} 

CdmChangesetsApi : GET /sn_cdm/changesets/activity

Récupère les changements de nœud dans un ensemble de changements spécifié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/activity

URL par défaut : /api/sn_cdm/changesets/activity

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 13. 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 14. Paramètres de requête

Nom	Description
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs tels que déterminés par le point de terminaison

Tableau 15. Paramètres du corps de la demande

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

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
changeset_id	Détails de l’ensemble de changements demandé. Type de données : objet "changeset_id": { "link": "String", "value": "String" }
changeset_id.lien	Requête à utiliser pour appeler le point de terminaison REST de la table afin de récupérer l’ensemble de changements associé. Type de données : chaîne
changeset_id.valeur	Sys_id de l’ensemble de changements associé. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
conflit	Marqueur indiquant s’il existe un conflit dans l’ensemble de changements associé. Valeurs valides : vrai : conflit détecté. faux : aucun conflit trouvé. Type de données : booléennes
créé(s)	Date et heure auxquelles le nœud a été créé. Format : JJ-MM-AAAA hh :mm :ss Type de données : chaîne
created_by	Nom d’utilisateur de l’utilisateur qui crée le nœud. Par exemple, able.tuter. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
name_path	Nom du chemin d’accès du nœud. Type de données : chaîne
new_name	Nom actuel du nœud. Type de données : chaîne
new_value	Valeur actuelle du nœud. Pour les nœuds terminaux et les littéraux de tableau. Type de données : chaîne
old_name	Nom précédent du nœud. Type de données : chaîne
old_value	Valeur précédente du nœud. Pour les nœuds terminaux et les littéraux de tableau. Type de données : chaîne
mises à jour	Date et heure de dernière mise à jour du nœud. Format : JJ-MM-AAAA hh :mm :ss Type de données : chaîne
updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour le nœud pour la dernière fois. Par exemple, able.tuter. Type de données : chaîne
sûr	Marqueur indiquant si le nœud terminal associé a été sécurisé. Valeurs valides : vrai : le nœud a été sécurisé. false : Le nœud n’a pas été sécurisé. Type de données : booléennes
type	Type de nœud. Valeurs possibles : sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_cdi sn_cdm_node_variable Type de données : chaîne

Demande cURL

Cet exemple de code montre comment récupérer les changements de nœud pour un ensemble de changements spécifique.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Renvoyer les résultats :

{ 
  "result": [ 
    { 
      "sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233", 
      "changeset_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "new_value": null, 
      "new_state": "Deleted", 
      "new_name": "Dep-1", 
      "new_type": "Deployable", 
      "new_encrypted": false, 
      "updated_on": "2022-06-29 13:09:46", 
      "updated_by": "admin", 
      "resolution_method": "", 
      "conflict": null, 
      "path": "deployables/Dep-1", 
      "created_by": null, 
      "created_on": null, 
      "old_value": null, 
      "old_state": "Superseded", 
      "old_name": "Dep-1", 
      "old_type": "Deployable", 
      "old_encrypted": false 
    } 
] 
} 

CdmChangesetsApi : GET /sn_cdm/changesets/commit-status/{commit_id}

Renvoie l’état actuel de la demande de validation de l’ensemble de changements spécifié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/commit-status/{commit_id}

URL par défaut : /api/sn_cdm/changesets/commit-status/{commit_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 19. 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
commit_id	Sys_id de la demande de validation dont l’état doit être renvoyé. Cette valeur est renvoyée par le point de CdmChangesetsApi : POST /sn_cdm/changesets/{changeset_id}/commit terminaison. Type de données : chaîne

Tableau 20. Paramètres de requête

Nom	Description
Néant

Tableau 21. 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 22. En-têtes de demandes

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
commit_id	Enregistrement de la demande de validation sys_id. Identique à celle transmise au point de terminaison. Type de données : chaîne
erreurs	Description de la ou des erreurs rencontrées lors du chargement. Type de données : chaîne
sortie	Description des données chargées ou, si une erreur s’est produite pendant le chargement, un message d’erreur décrivant l’erreur rencontrée. Type de données : objet "output": { "auto_validate": "String", "cdm_application": "String", "committed_at": "String", "committed_by": "String", "description": "String", "last_conflict_detection_time": "String", "number": "String", "publish_option": "String", "snapshot_description": "String", "snapshot_name": "String", "state": "String", "sys_created_by": "String", "sys_id": "String", "title": "String" }
output.auto_validate	Indique s’il faut appeler la validation après la validation. Type de données : chaîne
output.cdm_application	Nom de l’application sous laquelle le chargement a été effectué. Type de données : chaîne
output.committed_at	Date et heure de validation du contenu téléchargé. Type de données : chaîne
output.committed_by	Sys_id de l’enregistrement de l’entité qui a effectué la validation. Type de données : chaîne
sortie.description	Non utilisé actuellement. Type de données : chaîne
output.last_conflict_detection_time	Date et heure de l’invocation de détection de conflit. Type de données : chaîne
sortie.numéro	Numéro unique de l’ensemble de changements. Type de données : chaîne
output.publish_option	Option de publication pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez aucun instantané. publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none
output.snapshot_description	Description de l’instantané associé. Type de données : chaîne
output.snapshot_name	Nom de l’instantané associé. Type de données : chaîne
sortie.état	État du contenu téléchargé. Valeurs possibles : engagé terminé erreur in_progress nouveau prêt Type de données : chaîne
output.sys_created_by	Sys_id de l’entité qui a créé l’enregistrement. Type de données : chaîne
output.sys_id	Sys_id de l’enregistrement contenant l’ensemble de changements. Type de données : chaîne
sortie.titre	Titre de l’ensemble de changements créé dans le cadre du chargement. Type de données : chaîne
processing_state	État actuel du traitement de la demande de validation. Valeurs possibles : NOT_PROCREED PROCESSED Type de données : chaîne
request_id	ID de demande. Identique à celle transmise dans le point de terminaison et commit_id. Type de données : chaîne
État	État actuel de la validation spécifiée. Valeurs possibles : terminé erreur in_progress nouveau prêt Type de données : chaîne Table : valeur de la colonne d’état de la table File d’attente des demandes CDM [sn_cdm_request_queue].
type	Type de demande. Valeurs possibles : commit exporter upload_and_commit Type de données : chaîne

Demande cURL

L’exemple suivant montre comment appeler ce point de terminaison pour obtenir l’état de la validation spécifiée.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

Voici des exemples de réponses réussies et erronées.

// Successful response 

{ 
  "result": { 
    "type": "commit", 
    "state": "completed", 
    "output": { 
      "sys_id": "4a4407e953124110da35ddeeff7b1235", 
      "number": "Chset-1207", 
      "title": "admin064407e953124110da35ddeeff7b1235", 
      "description": "A description of my changeset provided during creation", 
      "committed_at": "2022-03-17 22:19:33", 
      "committed_by": "6816f79cc0a8016401c5a33be04be441", 
      "sys_created_by": "admin", 
      "state": "committed", 
      "publish_option": "publish_none", 
      "auto_validate": false, 
      "snapshot_name": null, 
      "snapshot_description": null, 
      "cdm_application": "DemoApp", 
      "last_conflict_detection_time": null 
    }, 
    "processing_state": "PROCESSED", 
    "commit_id": "9cd583e953124110da35ddeeff7b128a" 
  } 
} 

 

// Example of an error response 

{ 
  "result": { 
    "state": "error", 
    "errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'", 
    "commit_id": "9cd583e953124110da35ddeeff7b128" 
  } 
} 

CdmChangessetsAPI : GET /sn_cdm/changesets/impacted-deployables

Renvoie la liste des déployables associés à un ensemble de changements spécifié.

Le rôle de visionneur CDM est requis pour accéder à ce point de terminaison.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changessets/impacted-deployables

URL par défaut : /api/sn_cdm/changesets/impacted-deployables

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 25. 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 26. Paramètres de requête

Nom	Description
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs tels que déterminés par le point de terminaison

Tableau 27. Paramètres du corps de la demande

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

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
cdi_count	Nombre d’éléments de données de configuration (CDI) contenus dans l’application CDM associée. Type de données : nombre (entier)
cdi_usage	Pourcentage des CDI utilisés par le déployable. Type de données : nombre (entier)
cdm_app	Objet d’application CDM associé au déployable. Type de données : objet "cdm_app": { "link": "String", "value": "String" }
cdm_app.lien	Appel à utiliser pour accéder à l’enregistrement de l’application CDM à l’aide de l’API de table REST. Type de données : chaîne
cdm_app.valeur	Sys_id de l’enregistrement de l’application CDM associée. Type de données : chaîne Table : Application CDM [sn_cdm_application]
cdm_ci	Objet de service d’application associé au déployable. Type de données : objet "cdm_ci": { "link": "String", "value": "String" }
cdm_ci.lien	Appel à utiliser pour accéder à l’enregistrement du service d’application à l’aide de l’API de table REST. Type de données : chaîne
cdm_ci.valeur	Sys_id de l’enregistrement du service d’application associé. Type de données : chaîne Table : Élément de configuration [cmdb_ci]
description	Description de l’élément déployable CDM généré. Type de données : chaîne
environment_type	Type d’environnement du déployable. Valeurs possibles : Développement Production Test Type de données : chaîne
erreur	Uniquement renvoyé si une erreur s’est produite pendant le traitement. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
nom	Nom de l’élément déployable CDM. Type de données : chaîne
nœud	Détails sur le nœud déployable. Type de données : objet "node": { "link": "String", "value": "String" }
node.link	Appel à utiliser pour accéder à l’enregistrement du nœud déployable à l’aide de l’API de table REST. Type de données : chaîne
valeur.nœud	Sys_id de l’enregistrement du nœud déployable. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
snapshot_version_counter	Nombre d’instantanés créés pour le déployable. Type de données : nombre (entier)
État	État actuel du déployable. Valeurs possibles : actif supprimé Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui a créé l’élément déployable CDM. Par exemple, able.tuter. Type de données : chaîne
sys_created_on	Date et heure de création de l’élément déployable CDM. Type de données : chaîne Format : JJ-MM-AAAA hh :mm :ss
sys_id	Sys_id du déployable créé. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour pour la dernière fois l’élément déployable CDM. Par exemple, able.tuter. Type de données : chaîne
sys_updated_on	Date et heure auxquelles l’élément déployable CDM a été mis à jour pour la dernière fois. Type de données : chaîne Format : JJ-MM-AAAA hh :mm :ss

Demande cURL

L’exemple de code suivant montre comment récupérer les déployables impactés pour un ensemble de changements spécifié.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Renvoyer les résultats :

{ 
  "result": [ 
    { 
      "cmdb_ci": { 
        "value": "75c5d7a953b70110a1d3ddeeff7b12a2", 
        "link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2" 
      }, 
      "cdi_count": "2", 
      "snapshot_version_counter": "3", 
      "description": null, 
      "sys_updated_on": "2022-06-29 16:19:05", 
      "environment_type": "Development", 
      "node": { 
        "value": "a1c517a953b70110a1d3ddeeff7b129b", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b" 
      }, 
      "sys_id": "6dc517a953b70110a1d3ddeeff7b129b", 
      "sys_updated_by": "admin", 
      "cdm_app": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_created_on": "2022-05-31 13:03:23", 
      "cdi_usage": "0.02", 
      "name": "Development_1", 
      "state": "active", 
      "sys_created_by": "admin" 
    } 
  ] 
}

CdmChangessetsAPI : OBTENIR /sn_cdm/changesets/impacted-shared-components

Renvoie une liste de composants partagés associés à un ensemble de changements spécifié.

Le rôle de visionneur CDM est requis pour accéder à ce point de terminaison.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/impacted-shared-components

URL par défaut : /api/sn_cdm/changesets/impacted-shared-components

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 31. 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 32. Paramètres de requête

Nom	Description
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms de colonnes d’enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs tels que déterminés par le point de terminaison

Tableau 33. Paramètres du corps de la demande

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

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 36. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. L’ensemble de changements transmis n’existe pas.
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 réponse

Nom	Description
cdm_shared__library	Sys_id de la bibliothèque partagée sous laquelle réside le composant. Type de données : chaîne
description	Description du composant partagé CDM. Type de données : chaîne
erreur	Uniquement renvoyé si une erreur s’est produite pendant le traitement. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Détails sur l’erreur qui s’est produite. Type de données : chaîne
message.erreur	Message qui fournit une vue d’ensemble de l’erreur. Type de données : chaîne
nom	Nom du composant partagé CDM. Type de données : chaîne
nœud	Sys_id du nœud du composant partagé. Type de données : chaîne Table : Nœud CDM [sn_cdm_node]
node_main	Sys_id du main_id de l’enregistrement du nœud du composant partagé. Type de données : chaîne Table : Nœud CDM principal [sn_cdm_node_main]
État	État actuel du composant partagé. Valeurs possibles : actif supprimé Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui crée le composant partagé CDM. Par exemple, able.tuter. Type de données : chaîne
sys_created_on	Date et heure de création du composant partagé CDM. Format : JJ-MM-AAAA hh :mm :ss Type de données : chaîne
sys_id	Sys_id du composant partagé. Type de données : chaîne Table : Composant partagé CDM [sn_cdm_shared_component]
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour le composant partagé CDM pour la dernière fois. Par exemple, able.tuter. Type de données : chaîne
sys_updated_on	Date et heure de la dernière mise à jour du composant partagé CDM. Format : JJ-MM-AAAA hh :mm :ss Type de données : chaîne
version_counter	Nombre de versions créées pour le composant partagé. Type de données : nombre entier

Demande cURL

L’exemple de code suivant montre comment récupérer les composants partagés impactés pour changeset = « Chset-20 ».

curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

Réponse :

{
  "result": [
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "3cb945e097b3991052687b890353af0d",
      "sys_id": "34b945e097b3991052687b890353af20",
      "sys_updated_by": "john.jones",
      "node_main": "74b945e097b3991052687b890353af0d",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.1",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "b0b945e097b3991052687b890353af11",
      "sys_id": "30b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "f8b945e097b3991052687b890353af10",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.2",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "6cb905e097b3991052687b890353afd3",
      "sys_id": "b4b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "a4b905e097b3991052687b890353afd3",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.0",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "e0b905e097b3991052687b890353aff1",
      "sys_id": "3cb945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "2cb905e097b3991052687b890353aff0",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.1",
      "state": "active",
      "sys_created_by": "john.jones"
    }
  ]
}

CdmChangesetsApi : GET /sn_cdm/changesets/{changeset_id}/impacted-deployables

Renvoie la liste des déployables associés à un ensemble de changements spécifié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables

URL par défaut : /api/sn_cdm/changesets/{changeset_id}/impacted-deployables

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 37. 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
changeset_id	Sys_id de l’enregistrement de l’ensemble de changements à traiter. Type de données : chaîne Table :Ensemble de changements CDM [sn_cdm_changeset]

Tableau 38. Paramètres de requête

Nom	Description
Néant

Tableau 39. 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 40. En-têtes de demandes

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 42. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 réponse

Nom	Description
changeset_id	Sys_id du dernier ensemble de changements associé au nœud déployable. Type de données : chaîne
conflit	Marqueur indiquant si l’élément déployable associé est en conflit. Valeurs possibles : 0 : Pas en conflit. 1 : En conflit : consultez le résultat du retour pour plus d’informations conflict_type . Type de données : nombre
conflict_type	Type de conflit déployable. Valeurs possibles : corrupted_node deleted_node duplicated_node incomplete_deleted_parent incomplete_deleted_ref incomplete_renamed_ref invalid_include orphaned_descendant related_conflict unlinked_include unrenamed_include updated_node Type de données : chaîne
description	Description du nœud déployable. Type de données : chaîne
effective_from	Horodatage lorsque le nœud est valide. Cette valeur est nulle jusqu’à ce que vous validiez un ensemble de changements dans lequel le nœud a été créé. Type de données : nombre
effective_to	Horodatage lorsque le nœud n’est plus valide. Si cette valeur est nulle, le nœud reste en vigueur jusqu’à ce qu’il soit remplacé par une nouvelle version. Type de données : nombre
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
niveau	Profondeur du nœud à partir du niveau de l’application, qui est de 0. Type de données : nombre
linked_to	ID du nœud de référence dans une collection et un composant. Par exemple, l’extrait de nœud suivant affiche un lien entre la collA de collection et le composant compA. Pour cet exemple, la linkedTo valeur est 1 : { components : {compA:{} //MainId: 1}, Collections : { collA : { compA :{} //Include, linkedTo: 1 } } } Type de données : chaîne
main_id	Identificateur unique du nœud déployable. Cette valeur est générée lorsque le nœud est créé et utilisé pour identifier le nœud déployable. Type de données : nombre
main_id_encoded	Valeur codée des résultats de retour, à l’aide de la mainId représentation de chaîne Radix 57. Type de données : chaîne
nom	Nom de l’élément déployable. Type de données : chaîne
node_classifier	Classification des nœuds, telle que Développement, Production ou Test. Au format : /application/deployables/env :Développement /application/deployables/env :Production /application/deployables/env :Test Type de données : chaîne
position	Position du nœud déployable. Applicable uniquement aux baies. Par exemple, pour le tableau : node1:{ arrayNode: [{}, "literal1", "literal2", []] } {} est la position 1000, « literal1 » est la position 2000, « littéral2 » est la position 3000, [] est la position 4000 Type de données : nombre
previous_version	Sys_id de la version précédente du nœud déployable associé. Type de données : chaîne
restricted_to	Liste des sys_ids des utilisateurs autorisés à accéder au nœud déployable associé. Cette valeur est nulle si tous les groupes peuvent accéder au déployable. Type de données : chaîne Table : Groupes restreints CDM [sn_cdm_restricted_groups]
secure_value	Valeur sécurisée du CDI ou de la variable. Uniquement renvoyé pour les nœuds terminaux et les littéraux de tableau. Il s’agit de la même chose que le résultat de retour value , mais il est chiffré. Type de données : chaîne
statut	État du nœud déployable ou état d’une demande ayant échoué. Valeurs possibles : supprimé Échec (réussi en cas d’échec de l’appel du point de terminaison.) nouveau Remplacée mises à jour valide Type de données : chaîne
system_folder	Marqueur indiquant si le dossier associé est un dossier système. Valeurs possibles : 0 : pas un dossier système. 1 : Dossier système. Type de données : nombre
sys_id	Sys_id de l’élément déployable impacté. Type de données : chaîne
type	Type de nœud, par exemple sn_cdm_node_deployable. Cette valeur vous permet de déterminer si le nœud est un composant, un élément de données de configuration (CDI) ou déployable. Cette valeur est générée lors de la création du nœud. Type de données : chaîne
valide	Valeur du CDI ou de la variable. Uniquement renvoyé pour les nœuds terminaux et les littéraux de tableau. Si ces informations sont chiffrées, elles sont renvoyées dans le résultat de retour secure_value . Par exemple, si ce nœud est le CDI nodeA :{cdi1 : 1}, le résultat de retour value est 1. S’il s’agit d’un nœud de tableau tel que node1 : {arrayNode : [{}, « literal1 », « literal2 », []]}, le résultat de retour value est liteal1. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment demander les déployables associés à l’ensemble de changements dont le sys_id est bf506e69537c3010a1d3ddeeff7b12c0.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

L’exemple suivant montre une réponse réussie et une réponse d’erreur pour ce point de terminaison.

// Successful response
{
  "result": [
    {
      "sys_id": "833527a953924110da35ddeeff7b12c1",
      "type": "sn_cdm_node_deployable",
      "main_id": "150",
      "main_id_encoded": "&M",
      "node_path": "!&@!&D!&M",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Development",
      "position": null,
      "restricted_to": null,
      "changeset_id": "cb3527a953924110da35ddeeff7b12c0",
      "previous_version": "e8946f6953924110da35ddeeff7b1264",
      "effective_from": "1647563806950",
      "effective_to": null,
      "name": "Development_1",
      "description": "dev deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    },
    {
      "sys_id": "a245e7a953924110da35ddeeff7b1223",
      "type": "sn_cdm_node_deployable",
      "main_id": "153",
      "main_id_encoded": "&P",
      "node_path": "!&@!&D!&P",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Test",
      "position": null,
      "restricted_to": null,
      "changeset_id": "ea45e7a953924110da35ddeeff7b1222",
      "previous_version": "9505ef6953924110da35ddeeff7b121a",
      "effective_from": "1647563821422",
      "effective_to": null,
      "name": "Test_1",
      "description": "test deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    }
  ]
} 

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

CdmChangesetsApi : POST /sn_cdm/changesets/{changeset_id}/commit

Valide l’ensemble de changements spécifié. Une fois validé, l’ensemble de changements est conservé dans les tables CDM de l’instance associée.

Le système met à jour l’application pour conserver les changements apportés aux données de configuration au sein de l’ensemble de changements. L’état de l’ensemble de changements devient Validé. Le système génère ensuite un instantané de chaque déployable affecté par l’ensemble de changements.

Ce point de terminaison renvoie l’ID de la demande de validation. Utilisez cet ID pour appeler le CdmChangesetsApi : GET /sn_cdm/changesets/commit-status/{commit_id} point de terminaison afin d’obtenir l’état actuel de la validation de l’ensemble de changements.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

URL par défaut : /api/sn_cdm/changesets/{changeset_id}/commit

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 43. 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
changeset_id	Sys_id de l’enregistrement de l’ensemble de changements à traiter. Type de données : chaîne Table :Ensemble de changements CDM [sn_cdm_changeset]

Tableau 44. Paramètres de requête

Nom	Description
Validation automatique	Marqueur indiquant si les instantanés créés lors de la validation sont validés, ce qui signifie que toutes les politiques associées sont exécutées par rapport à l’instantané. Valeurs valides : vrai : valider les instantanés. faux : ne validez pas les instantanés. Valeur par défaut : false
publishOption	Option Publier pour les instantanés de configuration associés. Valeurs valides : publish_none : ne publiez aucun instantané. publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vrai. Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none

Tableau 45. Paramètres du corps de la demande

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

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

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

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 48. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Erreur : <message d’erreur> Vérifiez que le changeset_id paramètre que vous avez transmis était correct. Assurez-vous de disposer des rôles requis pour accéder à ce point de terminaison.
500	Erreur interne du serveur Erreur : valeur booléenne non valide. Si vous avez transmis le paramètre, vérifiez qu’il s’agit d’une autoValidate valeur booléenne.

Paramètres du corps de réponse

Nom	Description
commit_id	Sys_id de la demande de validation. Utilisez cet ID lors de l’appel du CdmChangesetsApi : GET /sn_cdm/changesets/commit-status/{commit_id} point de terminaison pour vérifier l’état de la demande de validation. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
statut	État de la validation. Uniquement renvoyé lorsqu’une erreur se produit. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant montre comment appeler ce point de terminaison pour valider un enregistrement d’ensemble de changements.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Ce qui suit montre la réponse pour une demande de validation d’ensemble de changements réussie.

// Successful response
{ 
  "result": { 
    "commit_id": "64b5f79f5379301096edddeeff7b12eb" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue",
    "detail": ""
  },
  "status": "failure"
}

CdmChangessetsApi : POST /sn_cdm/changesets/create

Crée un nouvel ensemble de changements à l’état ouvert pour une application CDM spécifiée ou une bibliothèque partagée.

Le rôle d’éditeur CDM est requis pour accéder à ce point de terminaison.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/create/

URL par défaut : /api/sn_cdm/changesets/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 49. 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 50. Paramètres de requête

Nom	Description
appName	Requis. Nom de l’application CDM ou de la bibliothèque partagée à associer à cet ensemble de changements. Il doit s’agir d’une application active ou d’une bibliothèque partagée. Type de données : chaîne
description	Description de l’ensemble de changements. Entrez quelque chose qui permettra à d’autres personnes de comprendre le but de l’ensemble de changements. Type de données : chaîne Par défaut : aucun
returnFields	Liste de champs séparés par des virgules dans la table Ensemble de changements CDM [sn_cdm_changeset] à renvoyer dans le cadre de la réponse. Type de données : chaîne

Tableau 51. Paramètres du corps de la demande

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

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

Tableau 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.
400	Demande incorrecte. Erreur : <message d’erreur> Assurez-vous que l’application CDM spécifiée ou la bibliothèque partagée existe et est à l’état actif.
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 réponse

Nom	Description
auto_validate	Marqueur indiquant si la validation automatique a été effectuée. Valeurs possibles : vrai : la validation automatique a été effectuée. faux : la validation automatique n’a pas été effectuée. Type de données : booléennes
cdm_application	Détails sur l’application CDM associée à l’ensemble de changements. Type de données : objet "cdm_application": { "link": "String", "value": "String" } Par exemple : {"value » : « <sysId> », « link » : « http://localhost:8081/api/now/table/*'} »
cdm_application.lien	URL de l’application CDM associée. Type de données : chaîne
cdm_application.valeur	Sys_id de l’application CDM associée. Type de données : chaîne
committed_at	Date et heure de validation de l’ensemble de changements dans le référentiel associé. Type de données : chaîne
committed_by	Sys_id de l’entité qui a créé l’ensemble de changements. Type de données : chaîne
description	Description de l’ensemble de changements tel qu’il a été transmis lorsque le point de terminaison a été appelé. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
last_conflict_detection_time	Dernière exécution de la détection de conflit. Type de données : nombre Unité : millisecondes
Numéro	Identificateur unique pour le nouvel ensemble de changements. Type de données : chaîne
publish_option	Option de publication pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez aucun instantané. publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none
snapshot_description	Description de l’instantané associé à l’ensemble de changements. Type de données : chaîne
État	État de la création de l’ensemble de changements. Valeurs possibles : Bloqué Recherche de conflits Échec de la validation Validation en cours Validé Ouvert Type de données : chaîne
statut	État de la création de l’ensemble de changements. Uniquement renvoyé lorsqu’une erreur se produit. Valeurs possibles : échec Type de données : chaîne
sys_created_by	Sys_id de l’entité qui a créé l’enregistrement de l’ensemble de changements. Type de données : chaîne
sys_id	Sys_id du nouvel ensemble de changements. Type de données : chaîne
Titre	Titre de l’ensemble de changements associé à l’application. Généralement généré automatiquement par le système. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment créer un ensemble de changements associé à l’application App Service1 CDM.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Voici la réponse pour une création réussie de l’ensemble de changements.

// Example of a successful response
{   
"result": { 
    "sys_id": "42748779c370301054c1582e1340ddcd",
    "number": "Chset-8",
    "title": "admin2021-06-18 10:06:46",
    "description": null,
    "committed_at": "",
    "committed_by": null,
    "sys_created_by": "admin",
    "state": "open",
    "publish_option": "publish_none",
    "auto_validate": false,
    "snapshot_name": null,
    "snapshot_description": null,
    "cdm_application": "App%20Service1" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

Demande cURL

L’exemple suivant montre comment créer un ensemble de changements pour la bibliothèque partagée « javalib ».

curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'  

Réponse :

CdmChangesetsApi : PUT /sn_cdm/changesets/commit

Met à jour et valide un ensemble de changements spécifié.

Le système met à jour l’application pour conserver les changements apportés aux données de configuration au sein de l’ensemble de changements. L’état de l’ensemble de changements devient Validé. Le système génère ensuite un instantané de chaque déployable affecté par l’ensemble de changements.

Ce point de terminaison renvoie l’ID de la demande de validation. Utilisez cet ID pour appeler le CdmChangesetsApi : GET /sn_cdm/changesets/commit-status/{commit_id} point de terminaison afin d’obtenir l’état actuel de la validation de l’ensemble de changements.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

URL par défaut : /api/sn_cdm/changesets/{changeset_id}/commit

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 55. 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 56. Paramètres de requête

Nom	Description
Validation automatique	Marqueur indiquant si les instantanés créés pendant la validation sont validés, ce qui signifie que toutes les politiques associées sont exécutées par rapport à l’instantané. Valeurs valides : vrai : valider les instantanés. faux : ne validez pas les instantanés. Type de données : booléennes Valeur par défaut : false
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
publishOption	Option de publication pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez aucun instantané. publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none

Tableau 57. Paramètres du corps de la demande

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

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

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

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Erreur : <message d’erreur> Vérifiez que le changeset_id paramètre que vous avez transmis était correct. Assurez-vous de disposer des rôles requis pour accéder à ce point de terminaison.
500	Erreur interne du serveur : valeur booléenne non valide. Si vous avez transmis le paramètre, vérifiez qu’il s’agit d’une autoValidate valeur booléenne.

Paramètres du corps de réponse

Nom	Description
commit_id	Sys_id de la demande de validation. Utilisez cet ID lors de l’appel du CdmChangesetsApi : GET /sn_cdm/changesets/commit-status/{commit_id} point de terminaison pour vérifier l’état de la demande de validation. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet "error": { "detail": "String", "message": "String" }
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message.erreur	Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne
statut	État de la validation. Uniquement renvoyé lorsqu’une erreur se produit. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment utiliser ce point de terminaison pour mettre à jour un ensemble de changements.

curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Renvoyer les résultats :

{ 
  "result": { 
    "commit_id": "cca8190f53141110a1d3ddeeff7b129e" 
  } 
}