CdmApplicationsApi

CdmApplicationsApi - DELETE /sn_cdm/applications/deployables

Supprime un élément déployable de gestion des données de configuration (CDM) spécifié.

L’appelant de ce point de terminaison doit avoir le rôle administrateur CDM.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables

URL par défaut : /api/sn_cdm/applications/deployables

Paramètres de demande pris en charge

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

Tableau 2. Paramètres de requête
Nom	Description
appName	Requis. Nom de l’application CDM à laquelle l’élément déployable est associé. Situé dans la table Déployable CDM [sn_cdm_deployable]. Type de données : chaîne
nom	Nom de l’élément déployable à supprimer. Situé dans la table Déployable CDM [sn_cdm_deployable]. Type de données : chaîne

Tableau 3. Paramètres de corps de 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 une 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 une 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 élément déployable.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password1'

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

None - results defined by the HTTP status code

CdmApplicationsApi - SUPPRIMER /sn_cdm/applications/shared_components

Supprime la référence d’utilisation du composant partagé d’une application spécifiée Configuration Data Management (CDM).

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/shared_components

URL par défaut : /api/sn_cdm/applications/shared_components

Paramètres de demande pris en charge

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

Tableau 8. Paramètres de requête
Nom	Description
appName	Requis. Nom de l’application à partir de laquelle supprimer l’association de composants partagés spécifiée. Situé dans la table Application CDM [sn_cdm_application]. Le champ de type de l’application spécifiée doit être défini sur « shared_library ». Type de données : chaîne
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé, tel que « Chset-10 ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne
sharedComponentName	Requis. Nom unique du composant partagé à supprimer de l’application spécifiée. Situé dans la table Composant partagé CDM [sn_cdm_shared_component]. Type de données : chaîne

Tableau 9. Paramètres de corps de 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 une 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. Types pris en charge : application/json ou application/xml. Valeur par défaut : 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 une 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
résultat	Vide. Le code d’état HTTP indique le résultat de l’appel.
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment supprimer le composant partagé « paymentService-V1.1 » de l’application « App1 ».

curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?appName=App1&sharedComponentName=paymentService-V1.1&changesetNumber=Chset-25" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Réponse :

""

CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/content

Renvoie le contenu associé à une demande d’exportation de données de configuration spécifiée.

Appelez ce point de terminaison uniquement une fois que vous avez reçu une réponse complète du CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status point de terminaison. Si vous appelez ce point de terminaison avant la fin de l’exportation, une erreur d’état 400 est renvoyée.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/content

URL par défaut : /api/sn_cdm/applications/deployables/exports/{export_id}/content

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
export_id	Identificateur unique de la demande d’exportation dont les données de configuration doivent être renvoyées. Cette valeur est renvoyée par le point de CdmApplicationsApi - POST /sn_cdm/applications/déployables/exports terminaison.

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. 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 une 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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
erreurs	Description des erreurs rencontrées lors de l’exportation. Type de données : chaîne
export_id	ID de demande d’exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne
exporter_result	Contenu de l’exportation des données de configuration spécifiées. Type de données : Objet JSON : si la demande portait sur l’exportation de données au format JSON. Chaîne : si la demande portait sur l’exportation de données dans un autre format.
request_id	ID de demande d’exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne
État	État actuel de l’exportation spécifiée. Valeur de la colonne d’état dans la table File d’attente de demande [sn_cdm_request_queue]. Valeurs possibles : terminé erreur in_progress nouveau prêt Type de données : chaîne

Demande cURL

L’exemple suivant demande les données de configuration d’une demande d’exportation avec l’ID 3ab14a7d53b1301096edddeeff7b12f.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/content" \ 
--request GET \ 
--header "Accept:application/json" \
--user 'username':'password'

Les résultats de retour possibles sont présentés ci-dessous.

// Successful completion of the export request
{ 
  "result": { 
    "export_id": "3ab14a7d53b1301096edddeeff7b12f" 
    "exporter_result": "DEP1.COMP.cdi_1=cdi-1-value" 
  } 
}

// Response when an incorrect export_id is passed. Note: Status code is 200.
{ 
  "result": { 
    "request_id": "3ab14a7d53b1301096edddeeff7b12e", 
    "state": "error", 
    "errors": "Invalid requestId '3ab14a7d53b1301096edddeeff7b12fe'", 
    "export_id": "3ab14a7d53b1301096edddeeff7b12e" 
  } 
}

CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status

Renvoie l’état actuel de la demande d’exportation des données de configuration spécifiée.

Utilisez le CdmApplicationsApi - POST /sn_cdm/applications/déployables/exports point de terminaison pour effectuer une demande d’exportation.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/status

URL par défaut : /api/sn_cdm/applications/deployables/exports/{export_id}/status

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
export_id	Sys_id de la demande d’exportation dont l’état doit être renvoyé. Cette valeur est renvoyée par le point de CdmApplicationsApi - POST /sn_cdm/applications/déployables/exports terminaison.

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 une 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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
erreurs	Description des erreurs rencontrées lors de l’exportation. Type de données : chaîne
export_id	ID de demande d’exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne
exporter_result	Détails sur l’erreur associée. Type de données : objet
exporter_result.erreurs	Description de la ou des erreurs rencontrées lors de l’exportation. Type de données : tableau
exporter_result.execution_id	Identificateur unique de l’enregistrement d’exécution de l’exportateur. Situé dans la table sn_cdm_exporter_execution. Type de données : chaîne
exporter_result.état	État actuel de l’exportation spécifiée. Situé dans la table sn_cdm_exporter_execution. Valeurs possibles : terminé erreur in_progress nouveau Type de données : chaîne
request_id	ID de demande d’exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne
État	État actuel de l’exportation spécifiée. Valeur de la colonne d’état dans la table File d’attente de demande [sn_cdm_request_queue]. Valeurs possibles : terminé erreur in_progress nouveau prêt Type de données : chaîne

Demande cURL

L’exemple suivant demande l’état d’une exportation avec l’ID 3ab14a7d53b1301096edddeeff7b12f.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \ 
--request GET \ 
--header "Accept:application/json" \
--user 'username':'password'

Voici les résultats de retour possibles.

// Successful completion of the export request
{ 
  "result": { 
    "state": "completed", 
    "export_id": "3ab14a7d53b1301096edddeeff7b12f0" 
  } 
}

// Response when an incorrect export_id is passed. Note: Status code is 200.
{ 
  "result": { 
    "request_id": "3ac8e1b05311301096edddeeff7b123c", 
    "state": "error", 
    "errors": "Invalid requestId '3ac8e1b05311301096edddeeff7b123c'", 
    "export_id": "3ac8e1b05311301096edddeeff7b123c" 
  } 
} 

// Response when the export encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{ 
  "result": { 
    "state": "completed", 
    "export_id": "24536c3353f9301096edddeeff7b12b1", 
    "exporter_result": { 
      "execution_id": "81536c3353f9301096edddeeff7b129e", 
      "state": "failure", 
      "errors": [ 
        "Snapshot 'SNA-001-published-non_compliant' has not passed validation. All snapshots of deployable '/ApplicationA/deployables/DEP3' are required to pass validation" 
      ] 
    } 
  } 
}

CdmApplicationsApi - GET /sn_cdm/applications/shared_components

Renvoie la liste des composants partagés utilisés par une application spécifiée. Vous pouvez également indiquer de ne renvoyer que les composants partagés pour lesquels une nouvelle version est disponible.

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/shared_components

URL par défaut : /api/sn_cdm/applications/shared_components

Paramètres de demande pris en charge

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

Tableau 26. Paramètres de requête
Nom	Description
appName	Requis. Nom de l’application pour laquelle vous souhaitez récupérer la liste des composants partagés. Situé dans la table Application CDM [sn_cdm_application]. Le champ Type de l’application doit être défini sur shared_library. Type de données : chaîne
withUpdatesOnly	Marqueur indiquant s’il faut renvoyer uniquement les composants partagés pour lesquels une nouvelle version mise à jour est disponible. Valeurs valides : true : renvoie uniquement les composants partagés pour lesquels une nouvelle version mise à jour est disponible. false : renvoie tous les composants partagés utilisés par l’application spécifiée. Valeur par défaut : false

Tableau 27. 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

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

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

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une 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
currentVersion	Version actuelle de l’application CDM. Type de données : nombre entier
currentVersionName	Nom de la version du composant partagé actuellement utilisée. Type de données : chaîne
description	Description du composant partagé. Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
nom	Nom unique du composant partagé. Type de données : chaîne
sharedLibraryName	Nom de la bibliothèque partagée à laquelle le composant partagé appartient. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
updateVersionName	Nom de la version du composant partagé disponible pour la mise à jour. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison pour récupérer les composants partagés dont la nouvelle version est utilisée par « App1 ».

curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?updatesOnly=true&appName=App1" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Réponse :

{ 
  "result": [
    {
      "name": "Component_Name",
      "description": "”,
      "sharedLibraryName": "Shared Library",
      "currentVersion": "2",
      "currentVersionName": "Component_A-v2.shc",
      "updateVersionName": "Component_A-v3.shc"
    } 
  ]
}

CdmApplicationsApi - GET /sn_cdm/applications/shared_libraries/components/applications

Renvoie une carte des composants partagés et des applications qui les utilisent et qui se trouvent dans une bibliothèque spécifiée.

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/shared_libraries/components/applications

URL par défaut : /api/sn_cdm/applications/shared_libraries/components/applications

Paramètres de demande pris en charge

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

Tableau 32. Paramètres de requête
Nom	Description
sharedComponentName	Requis. Nom du composant partagé à inclure dans la carte. Situé dans la table Composant partagé CDM [sn_cdm_shared_component]. Type de données : chaîne
sharedLibraryName	Requis. Nom de la bibliothèque partagée à inclure dans la carte. Situé dans la table Application CDM [sn_cdm_application]. Le champ de type de l’application spécifiée doit être défini sur « shared_library ». Type de données : chaîne

Tableau 33. Paramètres de corps de 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

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

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

Codes d'état

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

Tableau 36. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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
description	Description de l’application à l’aide du composant partagé Type de données : chaîne
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
managed_by_group	Liste séparée par des virgules des sys_ids des groupes qui peuvent gérer l’application. Type de données : chaîne
nom	Nom unique de l’application qui utilise le composant. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
sys_id	Sys_id de l’application utilisant le composant partagé. Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment appeler ce point de terminaison pour récupérer la carte qui affiche les applications de la bibliothèque partagée « OracleG-Library-10 » qui utilisent le composant partagé « paymentService-V1.1 ».

curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_libraries/components/applications?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Réponse :

{
  "result": {
    "component_name": [
      { 
        "name": "App Name",
        "description": "desc",
        "managed_by_group": null,
        "sys_id": "4e7808bb1b371110636e0fe0604bcb08"
      }, 
      {
        "name": "Config App",
        "description": "desc",
        "managed_by_group": null,
        "sys_id": "55a75cfb1b771110636e0fe0604bcb5c"
      },
      {
        "name": "Database App",
        "description": "desc",
        "managed_by_group": null,
        "sys_id": "2eb7503f1b771110636e0fe0604bcb06"
      }
    ]
  } 
}

CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}

Renvoie l’état actuel de la demande de téléchargement des données de configuration spécifiée.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/upload-status/{upload_id}

URL par défaut : /api/sn_cdm/applications/upload-status/{upload_id}

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès
Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Exemple : `v1` ou `v2`. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
upload_id	Sys_id de la demande de chargement dont l’état doit être renvoyé. Cette valeur est renvoyée par les différents points de terminaison de demande de chargement CdmApplications.

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 une 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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
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 : tableau de chaîne `"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 invoquer 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 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	Invocation de détection de conflit de date et d’heure. Type de données : chaîne
sortie.number	Numéro unique de l’ensemble de changements. Type de données : chaîne
output.publish_option	Option Publier pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez pas d’instantanés. 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 Valeur par défaut : publish_none Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vraie.
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 : Bloqué checking_for_conflict commit_failed commit_in_progress Engagés ouvert Type de données : chaîne
output.sys_créée_par	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 de traitement actuel de la demande de chargement. Valeurs possibles : NOT_PROCESSED PROCESSED Type de données : chaîne
État	État actuel de la demande de chargement. Valeurs possibles : terminé erreur in_progress nouveau prêt
type	Type de demande de chargement. Valeurs possibles : commit export upload_and_commit Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’exemple suivant montre une demande de l’état d’un chargement avec l’ID 5560a6895326301096edddeeff7b1230.

curl "http://instance.servicenow.com/api/sn_cdm/applications/upload-status/5560a6895326301096edddeeff7b1230" \ 
--request GET \ 
--header "Accept:application/json" \
--user 'username':'password'

Voici les résultats de retour possibles.

// Successful completion of the upload request
{ 
  "result": { 
    "type": "upload_and_commit", 
    "state": "completed", 
    "output": { 
      "sys_id": "be681dc95362301096edddeeff7b12ba", 
      "number": "Chset-102", 
      "title": "admin2021-09-10 08:09:07", 
      "description": null, 
      "committed_at": "2021-09-10 20:23:37", 
      "committed_by": "6816f79cc0a8016401c5a33be04be441", 
      "sys_created_by": "admin", 
      "state": "committed", 
      "publish_option": "publish_none", 
      "auto_validate": false, 
      "snapshot_name": null, 
      "snapshot_description": null, 
      "cdm_application": "Demo_App1631126164773", 
      "last_conflict_detection_time": "1631305417894" 
    }, 
    "processing_state": "PROCESSED", 
    "upload_id": "5560a6895326301096edddeeff7b1230"
  } 
}

// Response when an incorrect upload_id is passed. Note: Status code is 200.
{ 
  "result": { 
    "state": "error", 
    "errors": "Invalid requestId '5560a6895326301096edddeeff7b1240'", 
    "upload_id": "5560a6895326301096edddeeff7b1240" 
  } 
} 

// Response when the upload encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{ 
  "result": { 
    "type": "upload_and_commit", 
    "state": "error", 
    "output": "Error encountered during execution of request.\nError: Node 'dbSettings' of type 'sg_cdm_node_component' cannot create child 'dbSettings' of type 'sg_cdm_node_folder'", 
    "processing_state": "PROCESSED", 
    "upload_id": "272f8a415326301096edddeeff7b1232" 
  } 
}

CdmApplicationsApi - POST /sn_cdm/applications/déployables

Crée un nouvel élément déployable et le connecte automatiquement à une application spécifiée Configuration Data Management (CDM).

Vous pouvez créer un élément déployable pour l’un des trois types d’environnement suivants : Développement, Test ou Production.

Pour accéder à ce point de terminaison, l’appelant doit avoir le rôle administrateur CDM.

Si vous devez créer plusieurs déployables, utilisez le CdmApplicationsApi - POST /sn_cdm/applications/deployables/create point de terminaison.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables

URL par défaut : /api/sn_cdm/applications/deployables

Paramètres de demande pris en charge

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

Tableau 44. Paramètres de requête
Nom	Description
appName	Requis. Nom d’une application CDM existante et active à associer à l’élément déployable. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
envType	Requis. Type d’environnement pour l’élément déployable. Valeurs valides (sensibles à la casse) : Développement Production Test Remarque : Le type d’environnement déployable ne peut pas être modifié après la création. Type de données : chaîne
nom	Requis. Nom de l’élément déployable CDM. Ne doit pas être supérieur à 255 caractères. Les caractères autorisés par défaut sont 0-9, A-Z, a-z, _,-,., %, $, whitespace, :, #. Type de données : chaîne Longueur maximale : 255 caractères Caractères autorisés : 0-9, A-Z, a-z, _, -, ., %, $, espace blanc, :, et #
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des 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 45. Paramètres de corps de 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 une 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 une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 48. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
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 de CDI utilisés par l’élément déployable. Type de données : nombre entier
cdm_app	Objet d’application CDM associé à l’élément déployable. Type de données : objet `"cdm_app": { "link": "String", "value": "String" }`
cdm_app.link	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.value	Sys_id de l’enregistrement de l’application CDM associée. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
cdm_ci	Objet de service d’application associé à l’élément déployable. Type de données : objet `"cdm_ci": { "link": "String", "value": "String" }`
cdm_ci.link	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.value	Sys_id de l’enregistrement du service d’application associé. Situé dans la table Élément de configuration [cmdb_ci]. Type de données : chaîne
description	Description de l’élément déployable CDM généré. Type de données : chaîne
environment_type	Type d’environnement de l’élément déployable. Valeurs possibles : Développement Production Test Type de données : chaîne
erreur	Renvoyé uniquement 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 d’erreur	Message d’erreur généré lors de l’essai 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 de 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. Situé dans la table Déployable CDM [sn_cdm_deployable]. Type de données : chaîne
snapshot_version_counter	Nombre d’instantanés créés pour l’élément déployable. Type de données : nombre entier
État	État actuel de l’élément déployable. Valeurs possibles : Actif supprimé Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui a créé le 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. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne
sys_id	Sys_id de l’élément déployable créé. Situé dans la table Déployable CDM [sn_cdm_deployable]. Type de données : chaîne
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour l’élément déployable CDM 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’élément déployable CDM. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne

Demande cURL

L’exemple de code suivant montre comment créer et associer un élément déployable à une application CDM.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?name=Dep-1&returnFields=name%2Csys_id%2Cstate&appName=testApp&envType=Test" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password1'

Résultats renvoyés :

{ 
  "result": [ 
    { 
      "cmdb_ci": { 
        "value": "f5b9e00b53901110a1d3ddeeff7b12b8", 
        "link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8" 
      }, 
      "cdi_count": "0", 
      "snapshot_version_counter": "0", 
      "description": null, 
      "sys_updated_on": "2022-06-29 12:53:57", 
      "environment_type": "Test", 
      "node": { 
        "value": "7db9e00b53901110a1d3ddeeff7b12b6", 
        "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/7db9e00b53901110a1d3ddeeff7b12b6" 
      }, 
      "sys_id": "39b9e00b53901110a1d3ddeeff7b12b7", 
      "sys_updated_by": "admin", 
      "cdm_app": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_created_on": "2022-06-29 12:53:57", 
      "cdi_usage": "0", 
      "name": "Dep-2", 
      "state": "active", 
      "sys_created_by": "admin" 
    } 
  ] 
}

CdmApplicationsApi - POST /sn_cdm/applications/deployables/create

Crée un ou plusieurs nouveaux éléments déployables.

Vous pouvez créer l’un des deux types d’éléments déployables suivants :

Éléments déployables qui doivent être connectés manuellement à un modèle d’application (service CI).
Déployables qui sont automatiquement connectés à de nouveaux modèles d’application (services CI) créés dynamiquement.

Vous pouvez créer un élément déployable pour l’un des trois types d’environnement suivants : Développement, Test ou Production. Lors de la création de plusieurs éléments déployables, les noms générés automatiquement des éléments déployables suivent le modèle suivant : DeployableType_Number, où Nombre est un numéro de séquence en cours basé sur la création d’un nouvel élément déployable. Par exemple, si vous créez trois déployables de type Test dans un appel de point de terminaison, ils sont nommés Test_1, Test_2 et Test_3. Si vous appelez ensuite à nouveau le point de terminaison et créez un autre déployable de test, son nom généré automatiquement est Test_4. Ces numéros ne sont jamais réutilisés, même si un élément déployable est supprimé.

Format d'URL

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

URL par défaut : /api/sn_cdm/applications/deployables/create

Paramètres de demande pris en charge

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

Tableau 50. Paramètres de requête
Nom	Description
appSysId	Requis. Sys_id d’une application CDM active à associer aux éléments déployables. Type de données : chaîne
Autoconnect	Requis. Marqueur qui détermine s’il faut connecter automatiquement les éléments déployables nouvellement créés aux modèles d’application générés dynamiquement. Valeurs valides : true : connectez les éléments déployables nouvellement créés aux modèles d’application générés dynamiquement. false : créez simplement les éléments déployables. Ces déployables doivent être mappés manuellement aux modèles d’application à l’aide de l’interface utilisateur. Type de données : booléennes
envType	Requis. Type d’environnement pour l’élément déployable. Valeurs valides (sensibles à la casse) : Développement Production Test Remarque : Le type d’environnement déployable ne peut pas être modifié après la création. Type de données : chaîne
quantité	Requis. Nombre d’éléments déployables à créer. Type de données : nombre

Tableau 51. 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 une 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 une 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.
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
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
résultat	Sys_ids des éléments déployables créés. Type de données : tableau
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant montre comment créer un élément déployable unique et l’associer à une application CDM existante.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/create?envType=Production&appSysId=5e118055b712011054c1e5a6ce11a9d4&quantity=5&autoConnect=true" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

Les réponses possibles à cet appel sont présentées ci-dessous, à la fois en tant que réussite et erreur.

// Successful completion of the upload request
{
  "result": [
    "8ba43a3db7d6011054c1e5a6ce11a9a4",
    "93a47a3db7d6011054c1e5a6ce11a90d",
    "dba47a3db7d6011054c1e5a6ce11a91d",
    "6fa47a3db7d6011054c1e5a6ce11a921",
    "efa47a3db7d6011054c1e5a6ce11a925"
  ]
} 

// Error response
{
  "error": {
    "message": "Error: CDM Application with SysID 5e118055b712011054c1e5a6ce11a9d1 was not found. (sys_script_include.8cf0fbf453626010a1d3ddeeff7b12fe.script; line 211)",
    "detail": ""
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/déployables/exports

Soumet une demande d’exportation de l’instantané actuel pour une application spécifiée et un ou plusieurs éléments déployables dans la table Cache de l’exportateur CDM [sn_cdm_exporter_cache].

Ce point de terminaison renvoie un identificateur unique pour la demande, que vous utilisez ensuite pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status point de terminaison afin de récupérer l’état de l’exportation. Une fois l’exportation terminée, vous pouvez utiliser le CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/content point de terminaison pour récupérer les données de configuration de l’application associée.

Un instantané est le modèle de données complet d’un élément déployable au moment de la validation d’un changement de configuration. Cela inclut tous les composants, collections et variables inclus, ainsi que les variables et remplacements spécifiques au déployable. Pour plus d’informations sur les déployables, consultez Créer et mettre à jour un déployable.

Remarque :

Les snapshots ne peuvent pas dépasser 10 000 CDI (Configuration Data Item) par déployable ou 100 000 CDI par application.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports

URL par défaut : /api/sn_cdm/applications/deployables/exports

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. 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
additionalDéployables	Déployables non primaires à exporter. Type de données : tableau d’objets `"additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ]` Par exemple : `[{'app_name' :'TestApp', « deployable_name :'DEP-1'}]` Par défaut : Tableau vide - []
nom_additionalDeployables.app	Requis si additionalDeployables le tableau est spécifié. Nom de l’application associée au déployable dont vous souhaitez exporter les données de configuration. Type de données : chaîne
additionalDeployables.deployable_name	Requis si additionalDeployables le tableau est spécifié. Nom du déployable non primaire dont vous souhaitez exporter les données de configuration. Type de données : chaîne
appName	Requis. Nom de l’application dont vous souhaitez exporter les données de configuration. Type de données : chaîne
args	Objet JSON contenant des paires clé-valeur pour les arguments personnalisés. Type de données : objet
Format de données	Format de sortie des données exportées. Valeurs valides (sensibles à la casse) : Ini JSON Propriétés de raw (les données sont renvoyées au format chaîne) xml Yaml Type de données : chaîne Valeur par défaut : json
deployableName	Requis. Nom du déployable dont vous souhaitez exporter les données de configuration. Type de données : chaîne
exporterName	Requis. Nom de l’exportateur à utiliser pour exporter les données d’instantané. Les exportateurs sont personnalisés pour l’implémenteur. Pour en savoir plus sur la création d’un exportateur personnalisé, reportez-vous à la rubrique Créer un exportateur personnalisé. Type de données : chaîne
restrictExport	Marqueur indiquant si le point de terminaison valide les instantanés lors de l’exportation des données. Valeurs valides : true : valider les instantanés. false : ne pas valider les instantanés. Type de données : booléennes Valeur par défaut : false
snapshotName	Nom de l’instantané à exporter. Il ne peut s’agir que de l’un des noms d’instantanés associés au déployable, comme spécifié dans deployableName ou additionalDeployables.deployable_name. Par défaut : le point de terminaison exporte le dernier instantané publié. S’il n’y a pas d’instantané publié, le système génère l’erreur « Impossible de trouver le dernier instantané publié pour le déployable « {0}' » »

Tableau 57. 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 une 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 une 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. Un type de demande incorrecte ou mal formé a été détecté. Messages d’erreur possibles : Erreur : paramètre obligatoire « appName » manquant Erreur : l’utilisateur ne possède pas l’autorisation requise pour créer une demande d’exportation Erreur : valeur booléenne non valide (<xyz>).
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
erreur	Détails sur l’erreur qui s’est produite. `"error": { "detail": "String", "message": "String" }` Type de données : tableau
erreur.détail	Informations supplémentaires sur l’erreur. Type de données : chaîne
message d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
export_id	Identificateur unique de la demande d’exportation. Utilisez cet ID lors de l’appel du CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status point de terminaison pour vérifier l’état actuel de la demande d’exportation. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne

Demande cURL

L’exemple suivant demande l’exportation des données de configuration pour les éléments suivants : nom de l’application = TestAppA, nom de l’élément déployable = DEP, à l’aide de l’exportateur = exporter-1-primary_deployable.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports?appName=TestAppA&args=%7B%22arg_A_required%22%20%3A%20%22value%20A%22%7D&exporterName=exporter-1-primary_deployable&deployableName=DEP1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

Renvoie l’identificateur unique de la demande d’exportation.

{ 
  "result": {
    "export_id": "64b5f79f5379301096edddeeff7b12eb" 
  } 
}

CdmApplicationsApi - POST /sn_cdm/applications/shared_components

Associe le composant partagé spécifié à l’application dans un ensemble de changements spécifié.

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

Remarque :

Le composant partagé spécifié doit avoir une version publiée (instantané) associée.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/shared_components

URL par défaut : /api/sn_cdm/applications/shared_components

Paramètres de demande pris en charge

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

Tableau 62. Paramètres de requête
Nom	Description
appName	Requis. Nom de l’application à associer au composant partagé. Type de données : chaîne
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé au composant. Type de données : chaîne
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des 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
sharedComponentName	Requis. Nom du composant partagé à associer à l’application spécifiée. Situé dans la table Composant partagé CDM [sn_cdm_shared_component]. Type de données : chaîne
sharedLibraryName	Requis. Nom de la bibliothèque partagée sous laquelle créer le composant. Situé dans la table Application CDM [sn_cdm_application]. La bibliothèque partagée doit avoir les champs suivants définis comme suit : état = actif disponible = vrai Type = shared_library Type de données : chaîne

Tableau 63. Paramètres de corps de 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

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

Tableau 65. 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 une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

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

Les champs de réponse dépendent des champs spécifiés dans le returnFields paramètre de la demande. Ce qui suit décrit certains des champs les plus importants.


Nom	Description
changeset_id	Détails de l’enregistrement de l’ensemble de changements associé au nœud. Type de données : objet `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	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.value	Identificateur unique de l’enregistrement de l’ensemble de changements. Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne
description	Description du nœud CDM. Type de données : chaîne
erreur	Renvoyé uniquement 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 d’erreur	Message qui donne une vue d’ensemble de l’erreur. Type de données : chaîne
linked_to	ID du nœud principal associé au composant partagé. Type de données : chaîne
linked_to_version	Détails de l’enregistrement d’instantané CDM associé au nœud. Type de données : objet `"linked_to_version": { "link": "String", "value": "String" }`
linked_to_version.link	Syntaxe d’appel pour interroger cet enregistrement de version à l’aide de l’API REST de table . Type de données : chaîne
linked_to_version.value	Sys_id de l’enregistrement de version. Type de données : chaîne
principal	Marqueur indiquant si l’instantané associé a été publié. Valeurs valides : true : l’instantané a été publié. false : l’instantané n’a pas été publié.
main_id	ID unique du nœud principal nouvellement créé. Type de données : chaîne
main_id_encoded	ID codé du nœud principal nouvellement créé. Type de données : chaîne
nom	Nom du nœud CDM. Type de données : chaîne
nœud	Sys_id du nœud du composant partagé. Type de données : chaîne
node_path	Chemin d’accès au nouveau nœud lié créé lors de l’ajout du composant partagé. Type de données : chaîne
statut	État du nœud. Valeurs possibles : Nouveau Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui crée le nœud CDM. Par exemple, able.tuter. Type de données : chaîne
sys_created_on	Date et heure de création du nœud CDM. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne
sys_id	Sys_id du nœud. Situé dans la table Nœud CDM [sn_cdm_node]. Type de données : chaîne
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour le nœud CDM pour la dernière fois. Par exemple, able.tuter. Type de données : chaîne
sys_updated_on	Date et heure auxquelles le nœud CDM a été mis à mis à jour. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne
type	Type de nœud. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment appeler ce point de terminaison pour associer l’application « App1 » au composant partagé « paymentService-V1.1 » sous la bibliothèque partagée « OracleG-Library-10 » au sein de l’ensemble de changements « Chset-20 ».

curl "https://instance.servicenow.com/api/sn_cdm/applications/shared_components?appName=App1&changesetNumber=Chset-20&sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Réponse :

{ 
  "result": { 
    "changeset_id": { 
      "value": "74b7ff6fc33711100c257e2cc840dd6b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/74b7ff6fc33711100c257e2cc840dd6b" 
    }, 
    "node_path": "!,0!,1!/D", 
    "description": null, 
    "sys_updated_on": "2022-12-22 17:07:29", 
    "type": "sn_cdm_node_linked_shared_component", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "ff8b37ebc3b711100c257e2cc840ddba", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-12-22 17:07:29", 
    "value": null, 
    "effective_from": null, 
    "linked_to": "210", 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "linked_to_version": { 
      "value": "581fc3e9c3b311100c257e2cc840dd17", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_snapshot/581fc3e9c3b311100c257e2cc840dd17" 
    }, 
    "level": "2", 
    "conflict_type": null, 
    "main_id": "483",
    "effective_to": null,
    "secure_value": null, 
    "node_classifier": "/application/components", 
    "main_id_encoded": "/D",
    "name": "LIB2_C",
    "position": null,
    "reason_for_conflict": null,
    "system_folder": false,
    "status": "new",
    "conflict": false
  } 
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/components

Soumet une demande de chargement des données de configuration transmises pour un composant spécifique, dans le dossier des composants système, pour l’application spécifiée.

Ce point de terminaison renvoie l’ID de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement.

Remarque :

La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.

L’image suivante montre un exemple de chargement des données de configuration du composant en référence à l’interface ServiceNow Configuration DevOps utilisateur. Suppose que le composant est dbComponent et que l’application est paymentSvc.

Exemple d’emplacement du contenu de configuration dans l’interface utilisateur

Remarque :

Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez l’autre CdmApplicationsApi : POST sn_cdm/applications/uploads/components/file méthode pour modifier les nœuds.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/components

URL par défaut : /api/sn_cdm/applications/uploads/components

Paramètres de demande pris en charge

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

Tableau 68. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
autoDelete	Marqueur qui indique si les nœuds existants, qui ne font pas partie du contenu de chargement, sont supprimés une fois le traitement terminé. Valeurs valides : true : supprime automatiquement les nœuds existants. false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
Format de données	Requis. Format des données de configuration. Valeurs valides : csv Ini JSON Propriétés de Cru xml Yaml Type de données : chaîne
dataFormatAttributes	Uniquement pris en charge lorsque le dataFormat paramètre est défini sur `csv`. Attributs qui définissent le format de données CSV. Pour en savoir plus, consultez . Type de données : objet `"dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }`
dataFormatAttributes.containsHeaders	Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides : true : les données contiennent une ligne d’en-tête. La première ligne des données est considérée comme la ligne d’en-tête. false : les données ne contiennent pas de ligne d’en-tête. Vous devez transmettre les informations d’en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false
dataFormatAttributes.delimeter	Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne Valeur par défaut : virgule « , »
dataFormatAttributes.headers	Requis si dataFormatAttributes.containsHeaders le paramètre est `faux`. Champs dans les données qui composent l’en-tête. Ces en-têtes sont convertis en noms de clés des CDI au format JSON. Le nombre d’en-têtes doit correspondre au nombre de champs d’enregistrement. Type de données : tableau Valeur par défaut : tableau vide
dataFormatAttributes.securedHeaders	Champs des données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées vers CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l’attribut d’en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l’aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Valeur par défaut : tableau vide
deleteRedundantOverrides	Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides : true : si des valeurs redondantes sont présentes, aucun remplacement n’est créé. false : si des valeurs redondantes sont présentes, procède à un remplacement. Valeur par défaut : true
fileName	Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne
fileNodeName	Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement. Type de données : chaîne
Clés d’identificateur	Liste de noms qui indiquent quelle clé d’un enfant de tableau utiliser pour identifier le même nœud. Par exemple, si vous chargez : `[ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` dans le modèle existant suivant : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ]` et que vous définissez identifierKeys sur `name`, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ]` Sinon, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` Type de données : tableau de chaînes
ignorer les attributs	Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : true : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont ignorés lors du chargement. false : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont inclus dans le chargement. Type de données : booléennes Valeur par défaut : false
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
sharedLibraryName	Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne

Tableau 69. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Il peut s’agir de n’importe quelle donnée au format défini par le dataFormat paramètre des paramètres de requête.

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 70. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Type de contenu	Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain

Tableau 71. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 72. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’exemple suivant montre une demande de chargement pour le Demo_App1631126164773 d’application.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoValidate=false&autoDelete=true" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "{
  \"dbIPAddress\": \"10.10.10.110\",
  \"dbPort\": \"8080\",
  \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
  \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\
"}" \ 
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur pour cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi : POST sn_cdm/applications/uploads/components/file

Télécharge les fichiers dans le cadre du modèle de données de configuration (CDM) dans le dossier des composants.

Utilisez cette méthode pour charger vers un nœud de fichier de composants.

Format d'URL

URL versionnée : POST /api/sn_cdm/{api_version}/applications/uploads/components/file

URL par défaut : POST /api/sn_cdm/applications/uploads/components/file

Paramètres de demande pris en charge

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

Tableau 74. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
fileName	Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne
fileNodeName	Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement. Type de données : chaîne
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
publishOption (publication)Option	Option Publier pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez pas d’instantanés. 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 Valeur par défaut : publish_none Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vraie.

Tableau 75. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Par défaut, les chargements de taille de fichier sont limités à 5 Mo. Pour plus d’informations sur l’ajustement de la taille et du type de vos fichiers de téléchargement, consultez ceci Now Support Article. Type de données : chaîne/flux

En-têtes

Tableau 76. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Type de données du fichier à télécharger. Types pris en charge : application/zip, text/plain, application/json. Valeur par défaut : application/json

Tableau 77. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 78. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment charger un contenu dans un fichier texte.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/file?autoValidate=true&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "This is sample content that will be uploaded to a plain text file."\ 
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur pour cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Could not find active application with name: ‘testApp’ of type application", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/components/vars

Soumet une demande de chargement des données de configuration transmises dans le dossier vars, dans le dossier des composants système, pour l’application spécifiée.

L’image suivante est un exemple de chargement des données de configuration des variables du composant en référence à l’interface utilisateur de Workspace ServiceNow Configuration DevOps . Suppose que l’application est paymentSvc.

Charger le répertoire de variables

Remarque :

La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/components/vars

URL par défaut : /api/sn_cdm/applications/uploads/components/vars

Paramètres de demande pris en charge

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

Tableau 80. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
autoDelete	Marqueur qui indique si les nœuds existants, qui ne font pas partie du contenu de chargement, sont supprimés une fois le traitement terminé. Valeurs valides : true : supprime automatiquement les nœuds existants. false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
Format de données	Requis. Format des données de configuration. Valeurs valides : Ini JSON Propriétés de Cru xml Yaml Type de données : chaîne
deleteRedundantOverrides	Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides : true : si des valeurs redondantes sont présentes, aucun remplacement n’est créé. false : si des valeurs redondantes sont présentes, procède à un remplacement. Valeur par défaut : true
fileName	Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne
fileNodeName	Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement. Type de données : chaîne
Clés d’identificateur	Liste de noms qui indiquent quelle clé d’un enfant de tableau utiliser pour identifier le même nœud. Par exemple, si vous chargez : `[ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` dans le modèle existant suivant : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ]` et que vous définissez identifierKeys sur `name`, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ]` Sinon, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` Type de données : tableau de chaînes
ignorer les attributs	Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : true : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont ignorés lors du chargement. false : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont inclus dans le chargement. Type de données : booléennes Valeur par défaut : false
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
sharedLibraryName	Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne

Tableau 81. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Il peut s’agir de n’importe quelle donnée au format défini par le dataFormat paramètre des paramètres de requête.

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 82. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Type de contenu	Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain

Tableau 83. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 84. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’exemple suivant montre une demande de chargement de variables pour l’application Demo_App1631126164773.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/vars?changesetNumber=Chset-102&autoValidate=false&autoDelete=true&publishOption=publish_none&appName=Demo_App1631126164773&namePath=%2FSettings%2FdbSettings&autoCommit=false&dataFormat=json" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "{ 
  \"dbSettings\": { 
    \"dbIPAddress\": \"10.10.10.110\", 
    \"dbPort\": \"8080\", 
    \"dbConnectionString\": \"username:password server1.xyz.com:8080 dbName_payments\", 
    \"dbConnectionStringBackup\": \"username:password server2.xyz.com dbName_payments_backup\"
  } 
}"
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur pour cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "d21f71f45322301096eccceaff7b1ce3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/collections

Soumet une demande de chargement des données de configuration transmises pour une collection spécifique, dans le dossier des collections système, pour l’application spécifiée.

Ce point de terminaison renvoie l’ID de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement.

Remarque :

La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.

L’image suivante est un exemple de chargement des données de configuration en référence à l’interface utilisateur de Workspace ServiceNow Configuration DevOps . Suppose que la collection est db0Release1.0 et que l’application est paymentSvc.

Dossier de chargement des collections

Remarque :

Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez l’autre CdmApplicationsApi - POST /sn_cdm/applications/uploads/collections/file méthode pour modifier les nœuds.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/collections

URL par défaut : /api/sn_cdm/applications/uploads/collections

Paramètres de demande pris en charge

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

Tableau 86. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
autoDelete	Marqueur qui indique si les nœuds existants, qui ne font pas partie du contenu de chargement, sont supprimés une fois le traitement terminé. Valeurs valides : true : supprime automatiquement les nœuds existants. false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
collectionName	Requis. Nom de la collection sous laquelle stocker la charge utile chargée. Remarque : Si l’élément spécifié namePath n’existe pas sous cette collection, le système crée automatiquement le ou les composants sous cette collection, puis charge le contenu de configuration. Par exemple, si vous souhaitez charger la collection `collA`, avec le chemin `compA/comp/compC`, les données sont téléchargées sous `/collA/collections/compa/compB/compC`. Si `compA` existe, mais pas `compB` et `compC`, le point de terminaison crée ces composants et charge les données sous `compC`. Type de données : chaîne
Format de données	Requis. Format des données de configuration. Valeurs valides : csv Ini JSON Propriétés de Cru xml Yaml Type de données : chaîne
dataFormatAttributes	Uniquement pris en charge lorsque le dataFormat paramètre est défini sur `csv`. Attributs qui définissent le format de données CSV. Pour en savoir plus, consultez . Type de données : objet `"dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }`
dataFormatAttributes.containsHeaders	Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides : true : les données contiennent une ligne d’en-tête. La première ligne des données est considérée comme la ligne d’en-tête. false : les données ne contiennent pas de ligne d’en-tête. Vous devez transmettre les informations d’en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false
dataFormatAttributes.delimeter	Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne Valeur par défaut : virgule « , »
dataFormatAttributes.headers	Requis si dataFormatAttributes.containsHeaders le paramètre est `faux`. Champs dans les données qui composent l’en-tête. Ces en-têtes sont convertis en noms de clés des CDI au format JSON. Le nombre d’en-têtes doit correspondre au nombre de champs d’enregistrement. Type de données : tableau Valeur par défaut : tableau vide
dataFormatAttributes.securedHeaders	Champs des données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées vers CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l’attribut d’en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l’aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Valeur par défaut : tableau vide
deleteRedundantOverrides	Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides : true : si des valeurs redondantes sont présentes, aucun remplacement n’est créé. false : si des valeurs redondantes sont présentes, procède à un remplacement. Valeur par défaut : true
ignorer les attributs	Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : true : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont ignorés lors du chargement. false : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont inclus dans le chargement. Type de données : booléennes Valeur par défaut : false
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne

Tableau 87. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Il peut s’agir de n’importe quelle donnée au format défini par le dataFormat paramètre des paramètres de requête.

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 88. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Type de contenu	Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain

Tableau 89. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 90. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

Cet exemple montre comment charger la date de configuration au format dbSettings JSON dans le dossier des collections pour le Demo_App1631126164773 d’application.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections?dataFormat=json&autoValidate=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&autoDelete=true&namePath=%2FSettings%2FdbSettings&collectionName=release-1.0&autoCommit=false&publishOption=publish_none" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "{ 
  \"dbSettings\": { 
    \"dbIPAddress\": \"10.10.10.110\", 
    \"dbPort\": \"8080\", 
    \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\", 
    \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\" 
  } 
}" \ 
--user 'username':'password'

Les réponses possibles à cet appel sont présentées ci-dessous, à la fois en tant que réussite et erreur.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/collections/file

Télécharge un fichier dans le dossier collections du modèle de données de configuration (CDM).

Format d'URL

URL versionnée : POST /api/sn_cdm/{api_version}/applications/uploads/collections/file

URL par défaut : POST /api/sn_cdm/applications/uploads/collections/file

Paramètres de demande pris en charge

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

Tableau 92. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
collectionName	Requis. Nom de la collection sous laquelle stocker la charge utile chargée. Remarque : Si le `namePath` spécifié n’existe pas sous cette collection, le système crée automatiquement le ou les composants sous cette collection, puis charge le contenu de configuration. Par exemple, si vous souhaitez charger la collection `collA`, avec le chemin `compA/comp/compC`, les données sont téléchargées sous `/collA/collections/compa/compB/compC`. Si `compA` existe, mais pas `compB` et `compC`, le point de terminaison crée ces composants et charge les données sous `compC`. Type de données : chaîne
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
fileName	Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne
fileNodeName	Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement. Type de données : chaîne
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
publishOption (publication)Option	Option Publier pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez pas d’instantanés. 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 Valeur par défaut : publish_none Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vraie.

Tableau 93. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Par défaut, les chargements de taille de fichier sont limités à 5 Mo. Pour plus d’informations sur l’ajustement de la taille et du type de vos fichiers de téléchargement, consultez ceci Now Support Article. Type de données : chaîne/flux

En-têtes

Tableau 94. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Type de contenu du fichier à charger. Exemples : application/zip, text/plain, application/json.

Tableau 95. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 96. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’appel suivant télécharge un fichier texte brut dans le dossier des collections CDM.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections/file?autoValidate=true&collectionName=collA&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "This is sample content that will be uploaded to a plain text file."\ 
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur à cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Could not find active application with name: ‘testApp’ of type application", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/deployables

Soumet une demande de chargement du contenu de configuration pour un déployable spécifique dans le dossier système des déployables d’une application spécifiée.

Ce point de terminaison renvoie l’ID de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement.

Remarque :

La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.

L’image suivante montre un exemple de l’endroit où les données de configuration déployables sont téléchargées en référence à l’interface ServiceNow Configuration DevOps utilisateur. Suppose que l’élément déployable est Development_1 et que l’application est paymentSvc.

Emplacement des données de configuration des déployables dans l’interface utilisateur

Remarque :

Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez l’autre CdmApplicationsApi - POST /sn_cdm/applications/uploads/deployables/file méthode pour modifier les nœuds.

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/deployables

URL par défaut : /api/sn_cdm/applications/uploads/deployables

Paramètres de demande pris en charge

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

Tableau 98. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
autoDelete	Marqueur qui indique si les nœuds existants, qui ne font pas partie du contenu de chargement, sont supprimés une fois le traitement terminé. Valeurs valides : true : supprime automatiquement les nœuds existants. false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
Format de données	Requis. Format des données de configuration. Valeurs valides : csv Ini JSON Propriétés de Cru xml Yaml Type de données : chaîne
dataFormatAttributes	Uniquement pris en charge lorsque le dataFormat paramètre est défini sur `csv`. Attributs qui définissent le format de données CSV. Pour en savoir plus, consultez . Type de données : objet `"dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }`
dataFormatAttributes.containsHeaders	Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides : true : les données contiennent une ligne d’en-tête. La première ligne des données est considérée comme la ligne d’en-tête. false : les données ne contiennent pas de ligne d’en-tête. Vous devez transmettre les informations d’en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false
dataFormatAttributes.delimeter	Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne Valeur par défaut : virgule « , »
dataFormatAttributes.headers	Requis si dataFormatAttributes.containsHeaders le paramètre est `faux`. Champs dans les données qui composent l’en-tête. Ces en-têtes sont convertis en noms de clés des CDI au format JSON. Le nombre d’en-têtes doit correspondre au nombre de champs d’enregistrement. Type de données : tableau Valeur par défaut : tableau vide
dataFormatAttributes.securedHeaders	Champs des données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées vers CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l’attribut d’en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l’aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Valeur par défaut : tableau vide
deleteRedundantOverrides	Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides : true : si des valeurs redondantes sont présentes, aucun remplacement n’est créé. false : si des valeurs redondantes sont présentes, procède à un remplacement. Valeur par défaut : true
deployableName	Requis. Nom de l’élément déployable sous lequel stocker la charge utile chargée. Remarque : Si ce champ namePath spécifié n’existe pas sous cet élément déployable, le système crée automatiquement le ou les composants sous cet élément déployable, puis charge le contenu de configuration.
Clés d’identificateur	Liste de noms qui indiquent quelle clé d’un enfant de tableau utiliser pour identifier le même nœud. Par exemple, si vous chargez : `[ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` dans le modèle existant suivant : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ]` et que vous définissez identifierKeys sur `name`, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ]` Sinon, il produit la sortie suivante : `[ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ]` Type de données : tableau de chaînes
ignorer les attributs	Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : true : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont ignorés lors du chargement. false : si le format de données donné prend en charge les attributs, tous les attributs des données d’entrée sont inclus dans le chargement. Type de données : booléennes Valeur par défaut : false
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
publishOption (publication)Option	Option Publier pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez pas d’instantanés. 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 Valeur par défaut : publish_none Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vraie.

Tableau 99. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Il peut s’agir de n’importe quelle donnée au format défini par le dataFormat paramètre des paramètres de requête.

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 100. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.
Type de contenu	Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain

Tableau 101. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 102. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

L’exemple suivant montre une demande de chargement pour le Demo_App1631126164773 d’application.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables?deployableName=TST-1&autoValidate=false&dataFormat=json&autoDelete=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&publishOption=publish_none&autoCommit=true&namePath=%2FSettings%2FdbSettings" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "{
  \"dbIPAddress\": \"10.10.10.110\",
  \"dbPort\": \"8080\",
  \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
  \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\"
}" \ 
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur pour cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - POST /sn_cdm/applications/uploads/deployables/file

Télécharge les fichiers dans le dossier des déployables dans le modèle de données de configuration (CDM).

Format d'URL

URL versionnée : POST /api/sn_cdm/{api_version}/applications/uploads/deployables/file

URL par défaut : POST /api/sn_cdm/applications/uploads/deployables/file

Paramètres de demande pris en charge

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

Tableau 104. Paramètres de requête
Nom	Description
appName	Nom de l’application à associer aux données de configuration. Cette application doit être dans l’état actif. Situé dans la table Application CDM [sn_cdm_application]. Type de données : chaîne
Autocommit	Marqueur indiquant si l’ensemble de changements identifié dans le changesetNumber paramètre est validé dans le modèle de données après le chargement. Valeurs valides : true : l’ensemble de changements est validé après le chargement. false : l’ensemble de changements n’est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false
Valider automatiquement	Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : true : validez les instantanés. false : ne valide pas les instantanés. Remarque : Cette option n’est disponible que si le autoCommit paramètre est `défini sur vrai`. Type de données : booléennes Valeur par défaut : false
changesetNumber	Chaîne qui identifie de manière unique l’ensemble de changements associé à l’application, tel que Chset-102. Cet ensemble de changements doit être dans l’état « Ouvert ». Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l’ensemble de changements sont renvoyés dans le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} cadre des résultats.
deployableName	Requis. Nom du déployable CDM pour lequel mapper la politique. Situé dans la table Déployable CDM [sn_cdm_deployable]. Type de données : chaîne
fileName	Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l’extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne
fileNodeName	Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l’exportation. Ce nom ne nécessite pas d’extension de fichier et n’affecte pas le téléchargement. Type de données : chaîne
namePath	Chemin d’accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès au nom dans l’un des formats suivants. Par exemple, pour définir le chemin d’accès du nom du nœud `testApp/deployables/Development1/cdi1` : Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (« / »), vous ne pouvez pas utiliser ce format. Chemin d’accès du nom du backend avec caractères de remplacement : testApp déployables Development1 cdi1 Tableau : ['testApp','deployables','Development1','cdi1'] Remarque : Si le composant spécifié n’existe pas sur le chemin d’accès spécifié, le système crée automatiquement le composant sur le chemin d’accès spécifié, puis charge les données. Type de données : chaîne
publishOption (publication)Option	Option Publier pour les instantanés configurés associés. Valeurs valides : publish_none : Ne publiez pas d’instantanés. 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 Valeur par défaut : publish_none Remarque : Cette option n’est disponible que si la valeur du autoCommit paramètre est vraie.

Tableau 105. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Données de chargement de variable	Données de configuration à charger. Par défaut, les chargements de taille de fichier sont limités à 5 Mo. Pour plus d’informations sur l’ajustement de la taille et du type de vos fichiers de téléchargement, consultez ceci Now Support Article. Type de données : chaîne/flux

En-têtes

Tableau 106. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Type de contenu	Type de données du fichier à télécharger. Types pris en charge : application/zip, text/plain, application/json. Valeur par défaut : application/json

Tableau 107. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

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

Tableau 108. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : La taille de la charge utile de configuration est supérieure à la valeur maximale autorisée (2 Mo par défaut). Les paramètres requis sont manquants dans l’appel.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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


Nom	Description
erreur	Si une erreur s’est produite pendant le traitement, les détails sur 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 d’erreur	Message d’erreur généré lors de l’essai de traitement de la demande. Type de données : chaîne
statut	État de l’erreur de la demande. Valeurs possibles : échec Type de données : chaîne
upload_id	Sys_id de la demande de chargement. Utilisez cet ID pour appeler le CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} point de terminaison afin d’obtenir l’état du chargement. Type de données : chaîne

Demande cURL

La demande suivante télécharge un fichier texte brut dans le dossier des déployables de l’application CDM.

curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables/file?autoValidate=true&deployableName=depA&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:text/plain" \ 
--data "This is sample content that will be uploaded to a plain text file."\ 
--user 'username':'password'

Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d’erreur à cette demande.

// Successful completion of the upload request
{ 
  "result": { 
    "upload_id": "ec1f71f45322301096edddeeff7b12b3" 
  } 
} 

// Error response. Payload is too large.
{ 
  "error": { 
    "message": "Could not find active application with name: ‘testApp’ of type application", 
    "detail": "" 
  },
  "status": "failure"
}

CdmApplicationsApi - PUT /sn_cdm/applications/deployables

Met à jour le composant partagé spécifié dans une application au sein d’un ensemble de changements spécifié.

Permet une mise à jour des champs suivants :

Nom
Description
Service d’application\Groupe de CI dynamique
Identificateur de déployable

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/deployables

URL par défaut : /api/sn_cdm/applications/deployables

Paramètres de demande pris en charge

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

Tableau 110. Paramètres de requête
Nom	Description
appName	Requis. Nom de l’application CDM. Type de données : chaîne
nom	Requis. Nom de l’élément déployable CDM. Type de données : chaîne
nouvelleDescription	Facultatif. Description de l’élément déployable CDM. Type de données : chaîne
nouveauID de service	Facultatif. ID du service d’application/groupe de CI dynamique souhaité. Dans la demande cURL, `indiquez « »` pour déconnecter le déployable du service.
nouveauIdentificateur	Facultatif. L’identificateur de l’élément déployable. Type de données : choix (développement/test/production
Newname	Facultatif. Le nouveau nom de l’élément déployable. Type de données : chaîne
returnFields	Facultatif. Liste de champs séparés par des virgules à renvoyer dans le cadre de la réponse.

Tableau 111. 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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 112. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json

Codes d'état

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

Tableau 113. 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 de corps de réponse (JSON ou XML)


Nom	Description
sys_id	sys_Id déployable CDM.
nom	Nom de l’élément déployable CDM.
nœud	Objet de nœud déployable. `{ 'valeur' : '<sysId>', 'lien' : 'http://localhost:8081/api/now/table/*'}`
description	Description de l’élément déployable CDM.
identificateur	Identificateur de l’élément déployable.
cmdb_ci	Objet de service d’application connecté à un élément déployable. `{ 'valeur' : '<sysId>', 'lien' : 'http://localhost:8081/api/now/table/*'}`
cmdb_app	Objet d’application CDM. `{ 'valeur' : '<sysId>', 'lien' : 'http://localhost:8081/api/now/table/*'}`
snapshot_version_counter	Nombre d’instantanés créés pour un élément déployable.
cdi_count	Nombre de CDI contenus dans cet élément déployable CDM.
cdi_usage	Pourcentage d’utilisation de CDI.
environment_type	Le type d’environnement. Valeurs possibles : Développement Production test
État	L’état actif ou supprimé . Valeurs possibles : Actif supprimé
sys_created_by	Déployable CDM créé par <username>.
sys_created_on	Horodatage de création d’élément déployable CDM au format <aaaa-MM-jj hh :mm :ss>.
sys_updated_by	Déployable CDM mis à jour par <username>.
sys_updated_on	Déployable CDM mis à jour par horodatage au format <aaaa-MM-jj hh :mm :ss>.

Demande cURL

curl "http://localhost:8080/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ 
--request PUT\ 
--header "Accept:application/json" \ 
--user 'cdm_admin':'password1!'

Sortie :

{ 
  "result": { 
    "identifier": "identiy1", 
    "cmdb_ci": { 
      "value": "f5b9e00b53901110a1d3ddeeff7b12b8", 
      "link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8" 
    }, 
    "cdi_count": "3", 
    "snapshot_version_counter": "1", 
    "description": "cdcds", 
    "sys_updated_on": "2022-07-27 13:40:13", 
    "environment_type": "Test", 
    "node": { 
      "value": "30c00d4053015110a1d3ddeeff7b12bf", 
      "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/30c00d4053015110a1d3ddeeff7b12bf" 
    }, 
    "sys_id": "39b9e00b53901110a1d3ddeeff7b12b7", 
    "sys_updated_by": "admin", 
    "cdm_app": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "sys_created_on": "2022-06-29 12:53:57", 
    "cdi_usage": "0.03", 
    "name": "Dep-2", 
    "state": "active", 
    "sys_created_by": "admin" 
  } 
}

CdmApplicationsApi - PUT /sn_cdm/applications/shared_components

Met à jour le composant partagé spécifié dans une application au sein d’un ensemble de changements spécifié.

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

Format d'URL

URL versionnée : /api/sn_cdm/{api_version}/applications/shared_components

URL par défaut : /api/sn_cdm/applications/shared_components

Paramètres de demande pris en charge

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

Tableau 115. Paramètres de requête
Nom	Description
changesetNumber	Requis. Identificateur unique de l’ensemble de changements associé au composant. Type de données : chaîne
returnFields	Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des 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
sharedComponentName	Requis. Nom du composant partagé associé à l’application spécifiée. Situé dans la table Composant partagé CDM [sn_cdm_shared_component]. Type de données : chaîne
sharedLibraryName	Requis. Nom de la bibliothèque partagée sous laquelle réside le composant. Situé dans la table Application CDM [sn_cdm_application]. La bibliothèque partagée doit avoir les champs suivants définis comme suit : état = actif disponible = vrai Type = shared_library Type de données : chaîne
version	Requis. Nom de version associé au composant partagé. Situé dans la table Instantané CDM [sn_cdm_snapshot]. Type de données : chaîne

Tableau 116. Paramètres de corps de 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 une 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 117. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 118. 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 une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

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

Les champs de réponse dépendent des champs spécifiés dans le returnFields paramètre de la demande. Ce qui suit décrit certains des champs les plus importants.


Nom	Description
changeset_id	Détails de l’enregistrement de l’ensemble de changements associé au nœud. Type de données : objet `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	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.value	Identificateur unique de l’enregistrement de l’ensemble de changements. Situé dans la table Ensemble de changements CDM [sn_cdm_changeset]. Type de données : chaîne
description	Description du nœud CDM. Type de données : chaîne
erreur	Renvoyé uniquement 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 d’erreur	Message qui donne une vue d’ensemble de l’erreur. Type de données : chaîne
linked_to	ID du nœud principal associé au composant partagé. Type de données : chaîne
linked_to_version	Détails de l’enregistrement d’instantané CDM associé au nœud. Type de données : objet `"linked_to_version": { "link": "String", "value": "String" }`
linked_to_version.link	Syntaxe d’appel pour interroger cet enregistrement de version à l’aide de l’API REST de table . Type de données : chaîne
linked_to_version.value	Sys_id de l’enregistrement de version. Type de données : chaîne
principal	Marqueur indiquant si l’instantané associé a été publié. Valeurs valides : true : l’instantané a été publié. false : l’instantané n’a pas été publié.
main_id	ID unique du nœud principal nouvellement créé. Type de données : chaîne
main_id_encoded	ID codé du nœud principal nouvellement créé. Type de données : chaîne
nom	Nom du nœud CDM. Type de données : chaîne
nœud	Sys_id du nœud du composant partagé. Type de données : chaîne
node_path	Chemin d’accès au nouveau nœud lié créé lors de l’ajout du composant partagé. Type de données : chaîne
statut	État du nœud. Valeurs possibles : Nouveau Type de données : chaîne
sys_created_by	Nom d’utilisateur de l’utilisateur qui crée le nœud CDM. Par exemple, able.tuter. Type de données : chaîne
sys_created_on	Date et heure de création du nœud CDM. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne
sys_id	Sys_id du nœud. Situé dans la table Nœud CDM [sn_cdm_node]. Type de données : chaîne
sys_updated_by	Nom d’utilisateur de l’utilisateur qui a mis à jour le nœud CDM pour la dernière fois. Par exemple, able.tuter. Type de données : chaîne
sys_updated_on	Date et heure auxquelles le nœud CDM a été mis à mis à jour. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne
type	Type de nœud. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment appeler ce point de terminaison pour mettre à jour l’application « App1 » avec le composant partagé « paymentService-V1.1 » sous la bibliothèque partagée « OracleG-Library-10 » au sein de l’ensemble de changements « Chset-20 ».

"https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?sharedComponentName=paymentService-V1.1&sharedLibraryName=OracleG-Library-10&changesetNumber=Chset-20&versionName=sComp3-v2.shc&appName=App1" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Réponse :

"result": {
  "changeset_id": {
    "value": "7343d0f71b771110636e0fe0604bcb0b",
    "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_changeset/7343d0f71b771110636e0fe0604bcb0b"
  },
  "node_path": "!2!3!&`",
  "description": null,
  "sys_updated_on": "2022-12-22 18:52:38",
  "type": "sn_cdm_node_linked_shared_component",
  "sys_class_name": "sn_cdm_node",
  "sys_id": "339314b71b771110636e0fe0604bcba3",
  "sys_updated_by": ”admin",
  "previous_version": {
    "value": "a9ce80bf1b371110636e0fe0604bcb10",
    "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_node/a9ce80bf1b371110636e0fe0604bcb10" 
  },
  "sys_created_on": "2022-12-22 18:52:38",
  "value": null,
  "effective_from": null,
  "linked_to": "146", 
  "sys_created_by": ”admin",
  "restricted_to": null,
  "linked_to_version": {
    "value": "54115c371b771110636e0fe0604bcb77",
    "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_snapshot/54115c371b771110636e0fe0604bcb77"
  },
  "level": "2",
  "conflict_type": null,
  "main_id": "166",
  "effective_to": null,
  "secure_value": null,
  "node_classifier": "/application/components",
  "main_id_encoded": "&`",
  "name": "Component_A",
  "position": null,
  "reason_for_conflict": null,
  "system_folder": false,
  "status": "updated",
  "conflict": false
}