CdmApplicationsApi
CdmApplicationsApi fournit des points de terminaison qui vous permettent d’uploadzoominsoftware.io/utah-devops/ des données de configuration dans les dossiers de composants, de collections, de déployables et de variables de composants qui se trouvent dans l’interface utilisateur de l’espace DevOps Config de travail. Il dispose également de points de terminaison qui vous permettent d’exporter des données de configuration déployables vers votre DevOps pipeline et de gérer les composants et applications partagés.
Les points de terminaison d’exportation et de chargement utilisent une implémentation de mise en file d’attente asynchrone. Avec ce type d’implémentation, vous appelez d’abord le point de terminaison de demande d’exportation ou de chargement souhaité. Ces points de terminaison mettent votre demande en file d’attente et renvoient un identificateur de demande. Vous utilisez ensuite cet identificateur de demande pour appeler le point de terminaison d’état approprié, un pour les chargements et un autre pour les exportations, afin d’obtenir l’état du chargement/exportation. Pour les demandes d’exportation, une fois l’exportation terminée, vous pouvez également demander le contenu de l’exportation.
Cette API ne fournit pas de points de terminaison permettant d’effectuer une récupération simple des enregistrements d’application. Pour récupérer ces enregistrements, utilisez l’API de table .
- REST scripté ACL de la vue CDM (sn_cdm.cdm.viewer)
- REST scripté ACL de l’éditeur CDM (sn_cdm.cdm_editor)
En outre, le module d’extension Gestion des données de configuration (CDM) doit être activé pour que cette API soit disponible dans une instance.
Pour plus d’informations sur Gestion des données de configuration l’interface utilisateur de l’espace DevOps Config de travail, consultez Chargement de vos données de configuration.
Pour plus d’informations sur les composants partagés et les bibliothèques partagées, voir Partage de composants entre applications — Bibliothèques de composants.
CdmApplicationsApi : SUPPRIMER /sn_cdm/applications/déployables
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 d’administrateur CDM.
Format d'URL
URL avec version : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Requis. Nom de l’application CDM à laquelle le déployable est associé. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable] |
| nom | Nom du déployable à supprimer. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable] |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 du déployable, aucune réponse n’est renvoyée autre que le code d’état HTTP.
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 Gestion des données de configuration (CDM).
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Requis. Nom de l’application à partir de laquelle supprimer l’association de composants partagés spécifiée. Le champ type doit être défini sur « shared_library » pour l’application spécifiée. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| changesetNumber | Requis. |
| sharedComponentName | Requis. Nom unique du composant partagé à supprimer de l’application spécifiée. Type de données : chaîne Table : composant partagé CDM [sn_cdm_shared_component] |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’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.
N’appelez ce point de terminaison qu’une CdmApplicationsApi : GET /sn_cdm/applications/deployables/exports/{export_id}/status fois que vous avez reçu une réponse complète du 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 avec version : /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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| export_id | Identificateur unique pour 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. |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| 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 de données de configuration spécifiée. Type de données :
|
| 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. Valeurs possibles :
Type de données : chaîne Table : colonne Dans l’état de la table File d’attente des demandes CDM [sn_cdm_request_queue]. |
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'
L’article suivant montre les résultats de retour possibles.
// 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 de données de configuration spécifiée.
Utilisez le point de terminaison pour effectuer une demande d’exportation CdmApplicationsApi : POST /sn_cdm/applications/déployables/exports .
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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. 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. |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| 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 des erreurs rencontrées lors de l’exportation. Type de données : tableau |
| exporter_result.ID_exécution | Identificateur unique pour l’enregistrement d’exécution de l’exportateur. Type de données : chaîne Table : Exécution de l’exportateur CDM [sn_cdm_exporter_execution] |
| exporter_result.état | État actuel de l’exportation spécifiée. Valeurs possibles :
Type de données : chaîne Table : Exécution de l’exportateur CDM [sn_cdm_exporter_execution] |
| 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. Valeurs possibles :
Type de données : chaîne Table : colonne Dans l’état de la table File d’attente des demandes CDM [sn_cdm_request_queue]. |
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 spécifier de renvoyer uniquement les composants partagés pour lesquels une nouvelle version est disponible.
Le rôle d’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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Requis. Nom de l’application dont vous souhaitez renvoyer la liste des composants partagés. Le champ type de l’application doit être défini sur shared_library. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| withUpdatesOnly | Marqueur indiquant s’il faut renvoyer uniquement les composants partagés pour lesquels une nouvelle version mise à jour est disponible. Valeurs valides :
Valeur par défaut : false |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| nom | Nom 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 | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| updateVersionName | Nom de la version du composant partagé disponible pour 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 qui ont une nouvelle version 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 qui se trouvent dans une bibliothèque spécifiée.
Le rôle d’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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| Nom | Description |
|---|---|
| sharedComponentName | Requis. Nom du composant partagé à inclure dans la carte. Type de données : chaîne Table : composant partagé CDM [sn_cdm_shared_component] |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée à inclure dans la carte. Le champ type doit être défini sur « shared_library » pour l’application spécifiée. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 utilisant un composant partagé Type de données : chaîne |
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| 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 | Statut d’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 chargement des données de configuration spécifiée.
Format d'URL
URL avec version : /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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. 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. |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| 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înes |
| output.auto_validate | Indique s’il faut appeler la validation après la validation. Type de données : chaîne |
| output.cdm_application | Nom de l’application sous laquelle le chargement a été effectué. Type de données : chaîne |
| output.committed_at | Date et heure auxquelles le contenu chargé a été validé. Type de données : chaîne |
| output.committed_by | Sys_id de l’enregistrement de l’entité qui a effectué la validation. Type de données : chaîne |
| sortie.description | Non utilisé actuellement. Type de données : chaîne |
| output.last_conflict_detection_time | Date et heure de l’invocation de détection de conflit. Type de données : chaîne |
| numéro.sortie | 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 :
Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none Remarque : Cette option n’est disponible que si la autoCommit valeur du 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 :
Type de données : chaîne |
| output.sys_created_by | Sys_id de l’entité qui a créé l’enregistrement. Type de données : chaîne |
| output.sys_id | Sys_id de l’enregistrement contenant l’ensemble de changements. Type de données : chaîne |
| sortie.titre | Titre de l’ensemble de changements créé dans le cadre du chargement. Type de données : chaîne |
| processing_state | État actuel du traitement de la demande de téléchargement. Valeurs possibles :
Type de données : chaîne |
| État | État actuel de la demande de chargement. Valeurs possibles :
|
| type | Type de demande de chargement. Valeurs possibles :
Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 la demande de l’état d’un chargement avec l’ID de 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/deployables
Crée un nouvel élément déployable et le connecte automatiquement à une application spécifiée Gestion des données de configuration (CDM).
Vous pouvez créer un 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 d’administrateur CDM.
Si vous devez créer plusieurs déployables, utilisez le point de CdmApplicationsApi : POST /sn_cdm/applications/deployables/create terminaison.
Format d'URL
URL avec version : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Requis. Nom d’une application CDM active existante à associer au déployable. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| envType | Requis. Type d’environnement pour l’élément déployable. Valeurs valides (sensibles à la casse) :
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 du 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, _,-,., %, $, espace blanc, :, #. 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 de colonne 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 le déployable. Type de données : nombre (entier) |
| cdm_app | Objet d’application CDM associé au déployable. Type de données : objet |
| cdm_app.lien | Appel à utiliser pour accéder à l’enregistrement de l’application CDM à l’aide de l’API de table REST. Type de données : chaîne |
| cdm_app.valeur | Sys_id de l’enregistrement de l’application CDM associée. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| cdm_ci | Objet de service d’application associé au déployable. Type de données : objet |
| cdm_ci.lien | Appel à utiliser pour accéder à l’enregistrement du service d’application à l’aide de l’API de table REST. Type de données : chaîne |
| cdm_ci.valeur | Sys_id de l’enregistrement de service d’application associé. Type de données : chaîne Table : Élément de configuration [cmdb_ci] |
| description | Description du 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 :
Type de données : chaîne |
| erreur | Uniquement renvoyé si une erreur s’est produite pendant le traitement. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| nom | Nom du 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 | Appel à utiliser pour accéder à l’enregistrement du nœud déployable à l’aide de l’API de table REST. Type de données : chaîne |
| valeur.nœud | Sys_id de l’enregistrement du nœud déployable. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable] |
| snapshot_version_counter | Nombre d’instantanés créés pour le déployable. Type de données : nombre (entier) |
| État | État actuel du déployable. Valeurs possibles :
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. Type de données : chaîne Format : AAAA-mm-JJ hh :mm :ss |
| sys_id | Sys_id de l’élément déployable créé. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable] |
| sys_updated_by | Nom d’utilisateur de l’utilisateur qui a mis à jour pour la dernière fois le déployable CDM. Par exemple, able.tuter. Type de données : chaîne |
| sys_updated_on | Date et heure auxquelles le déployable CDM a été mis à jour pour la dernière fois. Type de données : chaîne Format : AAAA-mm-JJ hh :mm :ss |
Demande cURL
L’exemple de code suivant montre comment créer et associer un 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'
Renvoyer les résultats :
{
"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 éléments déployables.
- 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 créés dynamiquement (services CI).
Vous pouvez créer un 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 le modèle : DeployableType_Number, où Numéro 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 à 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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appSysId | Requis. Sys_id d’une application CDM active à associer aux 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 à des modèles d’application générés dynamiquement. Valeurs valides :
Type de données : booléennes |
| envType | Requis. Type d’environnement pour l’élément déployable. Valeurs valides (sensibles à la casse) :
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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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 de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| résultat | Sys_ids des déployables créés. Type de données : tableau |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment créer un 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'
Vous trouverez ci-dessous les réponses possibles à cet appel, qu’elles soient réussies ou erronées.
// 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 point de CdmApplicationsApi : GET /sn_cdm/applications/deployables/exports/{export_id}/content 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 déployable au moment où un changement de configuration est validé. Cela inclut tous les composants, collections et variables inclus, ainsi que les variables et remplacements spécifiques à l'élément déployable. Pour plus d’informations sur les déployables, consultez Créer et mettre à jour un déployable.
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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| additionalDeployables | Déployables non primaires à exporter. Type de données : tableau d’objets Par exemple : Par défaut : tableau vide : [] |
| additionalDeployables.app_nom | 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 des arguments personnalisés. Type de données : objet |
| dataFormat | Format de sortie des données exportées. Valeurs valides (sensibles à la casse) :
Type de données : chaîne 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 de l’instantané. Les exportateurs sont personnalisés à l’implémenteur. Pour plus de détails sur la création d’un exportateur personnalisé, voir Créer un exportateur personnalisé. Type de données : chaîne |
| restrictExporter | Marqueur indiquant si le point de terminaison valide les instantanés lors de l’exportation des données. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| snapshotName | Nom de l’instantané à exporter. Il ne peut s’agir que d’un des noms d’instantané associés au déployable, tel que spécifié dans les paramètres OU deployableNameadditionalDeployables.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 lève l’erreur « Impossible de trouver le dernier instantané publié pour le déployable « {0} » » |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Messages d’erreur possibles :
|
| 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. Type de données : tableau
|
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| 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 | Statut d’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 d’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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| 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 de colonne 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. Type de données : chaîne Table : composant partagé CDM [sn_cdm_shared_component] |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée sous laquelle créer le composant. La bibliothèque partagée doit comporter les champs suivants définis comme suit :
Type de données : chaîne Table : application CDM [sn_cdm_application] |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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. La section suivante décrit certains des domaines 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.lien | Syntaxe d’appel pour interroger cet enregistrement d’ensemble de changements à l’aide de l’API REST de table . Type de données : chaîne |
| changeset_id.valeur | Identificateur unique de l’enregistrement de l’ensemble de changements. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset] |
| description | Description du nœud CDM. Type de données : chaîne |
| erreur | Uniquement renvoyé si une erreur s’est produite pendant le traitement. Type de données : objet |
| erreur.détail | Détails sur l’erreur qui s’est produite. Type de données : chaîne |
| message.erreur | Message qui fournit une vue d’ensemble de l’erreur. Type de données : chaîne |
| 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.lien | 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.valeur | 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 :
|
| 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 auxquelles le nœud CDM a été créé. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
| sys_id | Sys_id du nœud. Type de données : chaîne Table : Nœud CDM [sn_cdm_node] |
| 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 de la dernière mise à jour du nœud CDM. 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 » dans 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 pour charger les données de configuration transmises pour un composant spécifique, dans le dossier des composants système, pour l’application spécifiée.
L’image suivante montre un exemple d’endroit où les données de configuration du composant sont chargées en référence à l’interface ServiceNow DevOps Config utilisateur. Supposons que le composant est dbComponent et que l’application est paymentSvc.
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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu chargé, sont supprimés une fois le traitement terminé. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| dataFormat | Requis. Format des données de configuration. Valeurs valides :
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 Parsing of CSV files in CDM. Type de données : objet |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides :
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 Par défaut : virgule « , » |
| dataFormatAttributes.headers | Obligatoire 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 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 Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Les champs des données sont des champs sécurisés et 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 ou le fichier de données des en-têtes. Ces champs sont stockés dans une colonne de type Mot de passe (chiffré dans 2 sens). Remarque : Vous ne pouvez sécuriser les champs qu’à l’aide de cet attribut. Vous ne pouvez pas sécuriser les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundentOverrides | Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides :
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 son 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é dans un tableau enfant utiliser pour identifier le même nœud. Par exemple, si vous chargez : dans le modèle existant suivant : et que vous définissez identifierKeys sur name, cela produit la sortie suivante : Sinon, il produit la sortie suivante : Type de données : tableau de chaînes |
| ignoreAttributes | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télé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. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des 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 |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 indiquent à la fois une réponse positive 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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| 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 son 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 du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télécharge les données. Type de données : chaîne |
| publishOption | Option Publier pour les instantanés configurés associés.
Valeurs valides :
Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none Remarque : Cette option n’est disponible que si la autoCommit valeur du paramètre est vraie. |
| Nom | Description |
|---|---|
| Données de chargement de variable | Données de configuration à charger. Par défaut, les téléchargements de fichiers sont limités à 5 Mo. Pour plus d’informations sur la façon d’ajuster la taille et le type de votre fichier téléchargé, voir ceci Now Support article. Type de données : chaîne/flux |
En-têtes
| 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 à charger. Types pris en charge : application/zip, , text/plainapplication/json. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 indiquent à la fois une réponse positive 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 pour télécharger les 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 montre un exemple d’endroit où les données de configuration des variables du composant sont chargées en référence à l’interface utilisateur de l’espace ServiceNow DevOps Config de travail. Suppose que l’application est paymentSvc.
Format d'URL
URL avec version : /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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu chargé, sont supprimés une fois le traitement terminé. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| dataFormat | Requis. Format des données de configuration. Valeurs valides :
Type de données : chaîne |
| deleteRedundentOverrides | Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides :
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 son 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é dans un tableau enfant utiliser pour identifier le même nœud. Par exemple, si vous chargez : dans le modèle existant suivant : et que vous définissez identifierKeys sur name, cela produit la sortie suivante : Sinon, il produit la sortie suivante : Type de données : tableau de chaînes |
| ignoreAttributes | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télé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. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des 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 |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 le Demo_App1631126164773 d’application.
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 indiquent à la fois une réponse positive 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 pour charger les données de configuration transmises pour une collection spécifique, dans le dossier des collections système, pour l’application spécifiée.
L’image suivante montre un exemple d’endroit où les données de configuration sont chargées en référence à l’interface utilisateur de l’espace ServiceNow DevOps Config de travail. Supposons que la collection est db0Release1.0 et que l’application est paymentSvc.
Format d'URL
URL avec version : /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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu chargé, sont supprimés une fois le traitement terminé. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| collectionName | Requis. Nom de l’ensemble dans lequel stocker la charge utile chargée. Remarque : Si l’élément spécifié namePath n’existe pas dans cette collection, le système crée automatiquement le ou les composants dans cette collection, puis charge le contenu de la configuration. Par exemple, si vous souhaitez télé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 Type de données : chaîne |
| dataFormat | Requis. Format des données de configuration. Valeurs valides :
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 Parsing of CSV files in CDM. Type de données : objet |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides :
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 Par défaut : virgule « , » |
| dataFormatAttributes.headers | Obligatoire 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 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 Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Les champs des données sont des champs sécurisés et 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 ou le fichier de données des en-têtes. Ces champs sont stockés dans une colonne de type Mot de passe (chiffré dans 2 sens). Remarque : Vous ne pouvez sécuriser les champs qu’à l’aide de cet attribut. Vous ne pouvez pas sécuriser les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundentOverrides | Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides :
Par défaut : true |
| ignoreAttributes | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télécharge les données. Type de données : chaîne |
| 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 uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des 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 |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 une date de configuration au format dbSettings JSON dans le dossier collections de l’application Demo_App1631126164773.
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'
Vous trouverez ci-dessous les réponses possibles à cet appel, qu’elles soient réussies ou erronées.
// 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 des 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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est vrai. Type de données : booléennes Valeur par défaut : false |
| collectionName | Requis. Nom de l’ensemble dans lequel stocker la charge utile chargée. Remarque : Si le namePath spécifié n’existe pas dans cette collection, le système crée automatiquement le ou les composants sous cette collection, puis charge le contenu de la configuration. Par exemple, si vous souhaitez télé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 télé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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| 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 son 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 du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télécharge les données. Type de données : chaîne |
| publishOption | Option Publier pour les instantanés configurés associés.
Valeurs valides :
Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none Remarque : Cette option n’est disponible que si la autoCommit valeur du paramètre est vraie. |
| Nom | Description |
|---|---|
| Données de chargement de variable | Données de configuration à charger. Par défaut, les téléchargements de fichiers sont limités à 5 Mo. Pour plus d’informations sur la façon d’ajuster la taille et le type de votre fichier téléchargé, voir ceci Now Support article. Type de données : chaîne/flux |
En-têtes
| 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 à télécharger. Exemples : application/zip, text/brut, application/json. |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 indiquent à 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 pour charger le contenu de configuration d’un déployable spécifique dans le dossier système des déployables d’une application spécifiée.
L’image suivante montre un exemple d’endroit où les données de configuration déployables sont chargées en référence à l’interface ServiceNow DevOps Config utilisateur. Suppose que le déployable est Development_1 et que l’application est paymentSvc.
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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu chargé, sont supprimés une fois le traitement terminé. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| dataFormat | Requis. Format des données de configuration. Valeurs valides :
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 Parsing of CSV files in CDM. Type de données : objet |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d’en-tête. Valeurs valides :
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 Par défaut : virgule « , » |
| dataFormatAttributes.headers | Obligatoire 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 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 Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Les champs des données sont des champs sécurisés et 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 ou le fichier de données des en-têtes. Ces champs sont stockés dans une colonne de type Mot de passe (chiffré dans 2 sens). Remarque : Vous ne pouvez sécuriser les champs qu’à l’aide de cet attribut. Vous ne pouvez pas sécuriser les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundentOverrides | Marqueur indiquant s’il faut créer un remplacement en présence de valeurs redondantes. Valeurs valides :
Par défaut : true |
| deployableName | Requis. Nom du déployable sous lequel stocker la charge utile chargée. Remarque : Si l’élément spécifié namePath 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 la configuration. |
| Clés d’identificateur | Liste de noms qui indiquent quelle clé dans un tableau enfant utiliser pour identifier le même nœud. Par exemple, si vous chargez : dans le modèle existant suivant : et que vous définissez identifierKeys sur name, cela produit la sortie suivante : Sinon, il produit la sortie suivante : Type de données : tableau de chaînes |
| ignoreAttributes | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télécharge les données. Type de données : chaîne |
| publishOption | Option Publier pour les instantanés configurés associés.
Valeurs valides :
Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none Remarque : Cette option n’est disponible que si la autoCommit valeur du paramètre est vraie. |
| 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 uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 des 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 |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 indiquent à la fois une réponse positive 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
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Nom de l’application à associer aux données de configuration. Cette application doit avoir l’état actif. Type de données : chaîne Table : application CDM [sn_cdm_application] |
| 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 :
Type de données : booléennes Valeur par défaut : false |
| autoValidate | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides :
Remarque : Cette option n’est disponible que si le autoCommit paramètre est 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, par exemple Chset-102. Cet ensemble de changements doit avoir l’état « Ouvert ». 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. Table : ensemble de changements CDM [sn_cdm_changeset] |
| deployableName | Requis. Nom du déployable CDM pour lequel mapper la politique. Type de données : chaîne Table : déployable CDM [sn_cdm_deployable] |
| 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 son 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 du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d’accès est relatif au dossier des composants, de la collection ou du déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d’accès du nom dans l’un des formats suivants. Par exemple, pour définir le chemin du nom du nœud 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 télécharge les données. Type de données : chaîne |
| publishOption | Option Publier pour les instantanés configurés associés.
Valeurs valides :
Pour plus d’informations sur la publication d’instantanés, consultez Publier ou annuler la publication d’un instantané. Type de données : chaîne Par défaut : publish_none Remarque : Cette option n’est disponible que si la autoCommit valeur du paramètre est vraie. |
| Nom | Description |
|---|---|
| Données de chargement de variable | Données de configuration à charger. Par défaut, les téléchargements de fichiers sont limités à 5 Mo. Pour plus d’informations sur la façon d’ajuster la taille et le type de votre fichier téléchargé, voir ceci Now Support article. Type de données : chaîne/flux |
En-têtes
| 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 à charger. Types pris en charge : application/zip, , text/plainapplication/json. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles :
|
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| erreur | Si une erreur s’est produite pendant le traitement, les détails de l’erreur. Type de données : objet |
| erreur.détail | Informations supplémentaires sur l’erreur. Type de données : chaîne |
| message.erreur | Message d’erreur généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | Statut d’erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de télé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 en texte brut dans le dossier 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 indiquent à 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/déployables
Met à jour le composant partagé spécifié dans une application au sein d’un ensemble de changements spécifié.
- Nom
- Description
- Service d’application\Groupe de CI dynamique
- Identificateur de déployable
Le rôle d’administrateur CDM est requis pour accéder à ce point de terminaison.
Format d'URL
URL avec version : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison autre que la plus récente. Type de données : chaîne |
| Nom | Description |
|---|---|
| appName | Requis. Nom de l’application CDM. Type de données : chaîne |
| nom | Requis. Nom du déployable CDM. Type de données : chaîne |
| newDescription | Facultatif. Description de l’élément déployable CDM. Type de données : chaîne |
| newServiceId | Facultatif. ID du service d’application/groupe de CI dynamique souhaité. Dans la demande cURL, fournissez '' pour déconnecter le déployable du service. |
| newIdentifier | Facultatif. L’identificateur du déployable. Type de données : Choix (Développement/Test/Production |
| newName | Facultatif. Le nouveau nom du 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. |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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 la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s’est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l’erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| sys_id | sys_Id déployable CDM. |
| nom | Nom du déployable CDM. |
| nœud | Objet de nœud déployable.
|
| description | Description de l’élément déployable CDM. |
| identificateur | Identificateur du déployable. |
| cmdb_ci | Objet de service d’application connecté à un élément déployable.
|
| cmdb_app | L’objet de l’application CDM.
|
| 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 du CDI. |
| environment_type | Le type d’environnement. Valeurs possibles :
|
| État | État actif ou supprimé . Valeurs possibles :
|
| sys_created_by | Déployable CDM créé par <nom d’utilisateur>. |
| sys_created_on | Horodatage de création de l’élément déployable CDM au format <aaaa-MM-jj hh :mm :ss>. |
| sys_updated_by | Déployable CDM mis à jour par <nom d’utilisateur>. |
| 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 d’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
| Nom | Description |
|---|---|
| api_version | Type de données : chaîne |
| 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 de colonne 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. Type de données : chaîne Table : composant partagé CDM [sn_cdm_shared_component] |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée sous laquelle réside le composant. La bibliothèque partagée doit comporter les champs suivants définis comme suit :
Type de données : chaîne Table : application CDM [sn_cdm_application] |
| version | Requis. Nom de version associé au composant partagé. Type de données : chaîne Table : instantané CDM [sn_cdm_snapshot] |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP ou s’appliquent à cette action d’une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Néant |
Codes d'état
Les codes d’état suivants s’appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été traitée avec succès. |
| 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. La section suivante décrit certains des domaines 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.lien | Syntaxe d’appel pour interroger cet enregistrement d’ensemble de changements à l’aide de l’API REST de table . Type de données : chaîne |
| changeset_id.valeur | Identificateur unique de l’enregistrement de l’ensemble de changements. Type de données : chaîne Table : ensemble de changements CDM [sn_cdm_changeset] |
| description | Description du nœud CDM. Type de données : chaîne |
| erreur | Uniquement renvoyé si une erreur s’est produite pendant le traitement. Type de données : objet |
| erreur.détail | Détails sur l’erreur qui s’est produite. Type de données : chaîne |
| message.erreur | Message qui fournit une vue d’ensemble de l’erreur. Type de données : chaîne |
| 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.lien | 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.valeur | 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 :
|
| 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 auxquelles le nœud CDM a été créé. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
| sys_id | Sys_id du nœud. Type de données : chaîne Table : Nœud CDM [sn_cdm_node] |
| 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 de la dernière mise à jour du nœud CDM. 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 » dans 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
}