CdmSnapshotApi

CdmSnapshotApi fournit des points de terminaison qui vous permettent de publier, d’annuler la publication et de revalider des instantanés dans Gestion des données de configuration (CDM).

Vous publiez un instantané afin qu’il puisse être exporté, ce qui permet au pipeline d’accéder Intégration et offre en continu (CICD) aux données de configuration associées et de les utiliser. Les exportateurs ne peuvent exécuter que sur des instantanés publiés. Lorsque les instantanés ne sont plus nécessaires, vous pouvez annuler leur publication pour réduire la confusion quant à leur viabilité.

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 instantanés, consultez Afficher les instantanés.

CdmSnapshotAPI : POST /sn_cdm/snapshots/{snapshot_id}/publish

Publie un instantané non publié spécifié.

Avant qu’un instantané puisse être publié, il doit être validé. Vous pouvez utiliser le point de CdmSnapshotAPI : POST /sn_cdm/snapshots/{snapshot_id}/validate terminaison pour valider les instantanés ou les faire valider automatiquement lorsque vous effectuez une validation. Un déployable doit être connecté à un service pour publier ses instantanés. En outre, si l’instantané a déjà été publié, la demande échouera.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/publish

URL par défaut : /api/sn_cdm/snapshots/{snapshot_id}/publish

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
snapshot_id	Sys_id de l’enregistrement d’instantané à traiter. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]

Tableau 2. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. 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 la réponse (JSON ou XML)

Nom	Description
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
état	Statut de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant montre comment publier l’instantané avec la sys_id 3a168d9dc342301054c1582e1340dd68.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/publish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Ce qui suit montre à la fois une réponse réussie et une réponse à l’échec de la demande de publication.

// Example of a successful response
{ 
  "" 
}

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

CdmSnapshotAPI : PUBLIER /sn_cdm/snapshots/{snapshot_id}/annuler la publication

Annule la publication d’un instantané précédemment publié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/annuler la publication

URL par défaut : /api/sn_cdm/snapshots/{snapshot_id}/annuler la publication

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
snapshot_id	Sys_id de l’enregistrement d’instantané à traiter. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]

Tableau 8. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 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.
Content-Type	Format de données du corps de la demande. 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 la réponse (JSON ou XML)

Nom	Description
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
état	Statut de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant montre comment annuler la publication de l’instantané avec le sys_id 3a168d9dc342301054c1582e1340dd68.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/unpublish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Ce qui suit montre une réponse réussie et une réponse à l’échec de la demande d’annulation de publication.

// Example of a successful response
{ 
  "" 
}

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

CdmSnapshotAPI : POST /sn_cdm/snapshots/{snapshot_id}/validate

Valide un instantané non publié spécifié.

La validation est effectuée sous la forme d’un processus asynchrone. L’appel de ce point de terminaison ne fait que lancer le processus de validation. Les résultats de retour de cet appel indiquent uniquement si le processus de validation a commencé, et non les résultats de la validation elle-même. Pour savoir si l’instantané a été validé, utilisez l’API de table pour localiser l’instantané et vérifier son état de validation.

Remarque :

Vous ne pouvez pas valider un instantané publié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/validate

URL par défaut : /api/sn_cdm/snapshots/{snapshot_id}/validate

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
snapshot_id	Sys_id de l’enregistrement d’instantané à traiter. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]

Tableau 14. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 16. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. 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. L’instantané spécifié est déjà publié ou ne peut pas être localisé.
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	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
état	Statut de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant montre comment valider l’instantané avec le sys_id de 3a168d9dc342301054c1582e1340dd68.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/validate"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

L’élément suivant présente une réponse de réussite et d’échec à la demande de validation.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Invalid Snapshot id:test",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotApi : PUT /sn_cdm/snapshots/publish

Publie un instantané non publié spécifié.

Avant qu’un instantané puisse être publié, il doit être validé. Vous pouvez utiliser le point de CdmSnapshotApi : PUT /sn_cdm/snapshots/validate terminaison pour valider les instantanés ou les faire valider automatiquement lorsque vous effectuez une validation. Un déployable doit être connecté à un service pour publier ses instantanés. En outre, si l’instantané a déjà été publié, la demande échouera.

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/publish

URL par défaut : /api/sn_cdm/snapshots/publish

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

Tableau 20. Paramètres de requête

Nom	Description
appName	Requis. Nom de l’application Gestion des données de configuration (CDM) pour laquelle créer l’instantané. Type de données : chaîne Table : Application CDM [sn_cdm_application]
deployableName	Requis. Nom de l’élément déployable CDM pour lequel créer l’instantané. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
nom	Requis. Nom de l'instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
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 21. Paramètres du corps de la demande

Nom	Description
Aucun

En-têtes

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

Tableau 22. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. 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
cdm_application_id	Détails sur l’application CDM associée à l’instantané. Type de données : objet "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.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_application_id.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_deployable_id	Détails sur l’élément déployable CDM associé à l’instantané. Type de données : objet "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.lien	Syntaxe d’appel pour interroger cet enregistrement déployable à l’aide de l’API REST de table . Type de données : chaîne
cdm_deployable_id.valeur	Sys_id de l’enregistrement déployable. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
changeset_id	Détails sur l’ensemble de changements associé à l’instantané. Type de données : objet "changeset_id": { "link": "String", "value": "String" }
changeset_id.lien	Syntaxe d’appel pour interroger cet enregistrement d’ensemble de changements à l’aide de l’API REST de table . Type de données : chaîne
changeset_id.valeur	Identificateur unique de l’enregistrement de l’ensemble de changements. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
description	Brève description de l’instantané. 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_published	Date et heure de la dernière publication de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
last_validated	Date et heure de la dernière validation de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
nom	Nom de l'instantané. Type de données : chaîne
Numéro	Numéro unique qui identifie l’instantané. Cette valeur fournit un identificateur lisible par l’homme pour le mappage. Type de données : chaîne
publié	Marqueur indiquant si l’instantané a été publié. Valeurs possibles : vrai : l’instantané a été publié. faux : l’instantané n’a pas été publié. Type de données : booléennes
sys_created_by	Nom de l’utilisateur qui a créé l’instantané. Type de données : chaîne
sys_created_on	Date et heure de création de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
sys_id	Sys_id de l’instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
sys_updated_by	Nom de l’utilisateur qui a mis à jour l’instantané. Type de données : chaîne
sys_updated_on	Date et heure auxquelles l’instantané a été mis à jour pour la dernière fois. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
validation	État de validation actuel de l’instantané. Valeurs possibles : execution_error échec in_progress not_validated Passé passed_with_exception Demandé Type de données : chaîne

Demande cURL

Cet exemple de code montre comment publier un instantané.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/publish?deployableName=Development_1&name=Development_1-v1.dpl&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Renvoyer les résultats :

 
{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": true, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}

CdmSnapshotApi : PUT /sn_cdm/snapshots/annuler la publication

Annule la publication d’un instantané précédemment publié.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/annuler la publication

URL par défaut : /api/sn_cdm/snapshots/annuler la publication

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
appName	Requis. Nom de l’application Gestion des données de configuration (CDM) pour laquelle créer l’instantané. Type de données : chaîne Table : Application CDM [sn_cdm_application]
deployableName	Requis. Nom de l’élément déployable CDM pour lequel créer l’instantané. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
nom	Requis. Nom de l'instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
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
Aucun

En-têtes

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

Tableau 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.
Content-Type	Format de données du corps de la demande. 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
cdm_application_id	Détails sur l’application CDM associée à l’instantané. Type de données : objet "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.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_application_id.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_deployable_id	Détails sur l’élément déployable CDM associé à l’instantané. Type de données : objet "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.lien	Syntaxe d’appel pour interroger cet enregistrement déployable à l’aide de l’API REST de table . Type de données : chaîne
cdm_deployable_id.valeur	Sys_id de l’enregistrement déployable. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
changeset_id	Détails sur l’ensemble de changements associé à l’instantané. Type de données : objet "changeset_id": { "link": "String", "value": "String" }
changeset_id.lien	Syntaxe d’appel pour interroger cet enregistrement d’ensemble de changements à l’aide de l’API REST de table . Type de données : chaîne
changeset_id.valeur	Identificateur unique de l’enregistrement de l’ensemble de changements. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
description	Brève description de l’instantané. 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_published	Date et heure de la dernière publication de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
last_validated	Date et heure de la dernière validation de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
nom	Nom de l'instantané. Type de données : chaîne
Numéro	Numéro unique qui identifie l’instantané. Cette valeur fournit un identificateur lisible par l’homme pour le mappage. Type de données : chaîne
publié	Marqueur indiquant si l’instantané a été publié. Valeurs possibles : vrai : l’instantané a été publié. faux : l’instantané n’a pas été publié. Type de données : booléennes
sys_created_by	Nom de l’utilisateur qui a créé l’instantané. Type de données : chaîne
sys_created_on	Date et heure de création de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
sys_id	Sys_id de l’instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
sys_updated_by	Nom de l’utilisateur qui a mis à jour l’instantané. Type de données : chaîne
sys_updated_on	Date et heure auxquelles l’instantané a été mis à jour pour la dernière fois. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
validation	État de validation actuel de l’instantané. Valeurs possibles : execution_error échec in_progress not_validated Passé passed_with_exception Demandé Type de données : chaîne

Demande cURL

Cet exemple de code montre comment annuler la publication d’un instantané.

Renvoyer les résultats :

CdmSnapshotApi : PUT /sn_cdm/snapshots/validate

Valide un instantané non publié spécifié par rapport à ses stratégies mappées.

La validation est effectuée sous la forme d’un processus asynchrone. L’appel de ce point de terminaison ne fait que lancer le processus de validation. Les résultats de retour de cet appel indiquent uniquement si le processus de validation a commencé, et non les résultats de la validation elle-même. Pour savoir si l’instantané a été validé, utilisez l’API de table pour localiser l’instantané et vérifier son état de validation.

Remarque :

Vous ne pouvez pas valider un instantané publié.

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/snapshots/validate

URL par défaut : /api/sn_cdm/snapshots/validate

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
appName	Requis. Nom de l’application Gestion des données de configuration (CDM) pour laquelle créer l’instantané. Type de données : chaîne Table : Application CDM [sn_cdm_application]
deployableName	Requis. Nom de l’élément déployable CDM pour lequel créer l’instantané. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
nom	Requis. Nom de l'instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
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
Aucun

En-têtes

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

Tableau 34. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Content-Type	Format de données du corps de la demande. 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’instantané spécifié est déjà publié ou ne peut pas être localisé.
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_application_id	Détails sur l’application CDM associée à l’instantané. Type de données : objet "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.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_application_id.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_deployable_id	Détails sur l’élément déployable CDM associé à l’instantané. Type de données : objet "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.lien	Syntaxe d’appel pour interroger cet enregistrement déployable à l’aide de l’API REST de table . Type de données : chaîne
cdm_deployable_id.valeur	Sys_id de l’enregistrement déployable. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable]
changeset_id	Détails sur l’ensemble de changements associé à l’instantané. Type de données : objet "changeset_id": { "link": "String", "value": "String" }
changeset_id.lien	Syntaxe d’appel pour interroger cet enregistrement d’ensemble de changements à l’aide de l’API REST de table . Type de données : chaîne
changeset_id.valeur	Identificateur unique de l’enregistrement de l’ensemble de changements. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset]
description	Brève description de l’instantané. 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_published	Date et heure de la dernière publication de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
last_validated	Date et heure de la dernière validation de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
nom	Nom de l'instantané. Type de données : chaîne
Numéro	Numéro unique qui identifie l’instantané. Cette valeur fournit un identificateur lisible par l’homme pour le mappage. Type de données : chaîne
publié	Marqueur indiquant si l’instantané a été publié. Valeurs possibles : vrai : l’instantané a été publié. faux : l’instantané n’a pas été publié. Type de données : booléennes
sys_created_by	Nom de l’utilisateur qui a créé l’instantané. Type de données : chaîne
sys_created_on	Date et heure de création de l’instantané. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
sys_id	Sys_id de l’instantané. Type de données : chaîne Table : Instantané CDM [sn_cdm_snapshot]
sys_updated_by	Nom de l’utilisateur qui a mis à jour l’instantané. Type de données : chaîne
sys_updated_on	Date et heure auxquelles l’instantané a été mis à jour pour la dernière fois. Type de données : chaîne Format : aaaa-mm-jj hh :mm :ss
validation	État de validation actuel de l’instantané. Valeurs possibles : execution_error échec in_progress not_validated Passé passed_with_exception Demandé Type de données : chaîne

Demande cURL

Cet exemple de code montre comment valider un instantané.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/validate?name=Development_1-v2.dpl&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

Renvoyer les résultats :

{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": false, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}