---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- fr-FR
ft:publication_title :
- Référence de l’API Xanadu
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# CdmApplicationsApi
# CdmApplicationsApi {#ariaid-title1}
* Rversion finale: Xanadu
*
* Mis à jour 1 août 2024
*
*  74 minutes de lecture
CdmApplicationsApi fournit des points de terminaison qui vous permettent de uploadzoominsoftware.io/utah-devops/ des données de configuration aux dossiers de composant, de collection, de déployable et de variable de composant trouvés 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 des composants et des 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. Cet identificateur de demande vous permet ensuite d'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 qui effectuent une récupération simple des enregistrements d'application. Pour récupérer ces enregistrements, utilisez l'API [de table](https://servicenow-prod.fluidtopics.net/zBy0jrbF7tnEmKA3AcV0_g#c_TableAPI "L'API de table fournit des points de terminaison qui vous permettent d'effectuer des opérations de création, de lecture, de mise à jour et de suppression (CRUD) dans les tables existantes.") .
Vous devez avoir l'un des rôles suivants pour accéder à cette API :
* Vue REST scriptée CDM ACL (sn_cdm.cdm.viewer)
* ACL de l'éditeur CDM REST scripté (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 en savoir plus 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](https://www.servicenow.com/docs/access?context=cdm-upload-process&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
Pour plus d'informations sur les composants partagés et les bibliothèques partagées, reportez-vous à [la section Partage de composants entre applications --- Bibliothèques de composants](https://www.servicenow.com/docs/access?context=cdm-component-libraries&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
## CdmApplicationsApi : SUPPRIMER /sn_cdm/applications/déployables {#ariaid-title2}
Supprime un élément déployable CDM (Configuration Data Management) spécifié.
L'appelant de ce point de terminaison doit avoir le rôle administrateur CDM.
### Format d'URL {#apps-DELETE-applications-deploys__section_tqf_h2n_qtb}
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
### Paramètres de demande pris en charge
{#apps-DELETE-applications-deploys__entry__2}{#apps-DELETE-applications-deploys__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 1. Paramètres de chemin d'accès]
{#apps-DELETE-applications-deploys__entry__6}
| Nom | Description |
|-|-|
| appName | Requis. Nom de l'application CDM à laquelle le déployable est associé. Situé dans la table Déployable CDM \[sn_cdm_deployable\]. Type de données : chaîne |
| nom | Nom du déployable à supprimer. Situé dans la table Déployable CDM \[sn_cdm_deployable\]. Type de données : chaîne |
[Tableau 2. Paramètres de requête]
{#apps-DELETE-applications-deploys__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 3. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-DELETE-applications-deploys__entry__16}{#apps-DELETE-applications-deploys__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
[Tableau 4. En-têtes de demandes]
{#apps-DELETE-applications-deploys__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 5. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-DELETE-applications-deploys__entry__24}{#apps-DELETE-applications-deploys__entry-200-status-code}{#apps-DELETE-applications-deploys__entry-400-status-code}{#apps-DELETE-applications-deploys__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 6. Codes d'état]
### Paramètres du corps de réponse
{#apps-DELETE-applications-deploys__entry__32}
| Nom | Description |
|-|-|
| Aucun | |
[ ]
### 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 autre que le code d'état HTTP n'est renvoyée.
None - results defined by the HTTP status code
## CdmApplicationsApi : SUPPRIMER /sn_cdm/applications/shared_components {#ariaid-title3}
Supprime la référence d'utilisation du composant partagé d'une application spécifiée Gestion des données de configuration (CDM).
Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.
### Format d'URL {#apps-DELETE-shared_components__section_lbh_bp1_fwb}
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
{#apps-DELETE-shared_components__entry__2}{#apps-DELETE-shared_components__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 7. Paramètres de chemin d'accès]
{#apps-DELETE-shared_components__entry__6}{#apps-DELETE-shared_components__changesetNumber-changeset-entry}
| Nom | Description |
|-|-|
| appName | Requis. Nom de l'application à partir de laquelle supprimer l'association de composants partagés spécifiée. Situé dans la table \[sn_cdm_application\] de l'application CDM. L'application spécifiée doit avoir le champ type défini sur \<\< shared_library \>\>. Type de données : chaîne |
| changesetNumber | Requis. Identificateur unique de l'ensemble de changements associé, tel que \<\< Chset-10 \>\>. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne |
| sharedComponentName | Requis. Nom unique du composant partagé à supprimer de l'application spécifiée. Situé dans la table Composant partagé CDM \[sn_cdm_shared_component\]. Type de données : chaîne |
[Tableau 8. Paramètres de requête]
{#apps-DELETE-shared_components__entry__14}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 9. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-DELETE-shared_components__entry__18}{#apps-DELETE-shared_components__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 10. En-têtes de demandes]
{#apps-DELETE-shared_components__entry__22}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 11. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-DELETE-shared_components__entry__26}{#apps-DELETE-shared_components__entry-200-status-code}{#apps-DELETE-shared_components__entry-400-status-code}{#apps-DELETE-shared_components__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 12. Codes d'état]
### Paramètres du corps de réponse
{#apps-DELETE-shared_components__entry__34}
| 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 "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
[ ]
### Demande cURL
L'exemple de code suivant montre comment supprimer le composant partagé \<\< paymentService-V1.1 \>\> de l'application \<\< App1 \>\>.
curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?appName=App1&sharedComponentName=paymentService-V1.1&changesetNumber=Chset-25" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Réponse :
""
## CdmApplicationsApi : GET /sn_cdm/applications/deployables/exports/{export_id}/content {#ariaid-title4}
Renvoie le contenu associé à une demande d'exportation de données de configuration spécifiée.
Appelez uniquement ce point de terminaison une fois que vous avez reçu une réponse complète du point de [CdmApplicationsApi : GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-deploy-exports-status "Renvoie l’état actuel de la demande d’exportation des données de configuration spécifiée.") terminaison. Si vous appelez ce point de terminaison avant la fin de l'exportation, une erreur d'état 400 est renvoyée.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/content
URL par défaut : /api/sn_cdm/applications/deployables/exports/{export_id}/content
### Paramètres de demande pris en charge
{#apps-GET-deploy-exports-content__entry__2}{#apps-GET-deploy-exports-content__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| export_id | Identificateur unique de la demande d'exportation dont les données de configuration doivent être renvoyées. Cette valeur est renvoyée par le point de [CdmApplicationsApi : POST /sn_cdm/applications/déployables/exportations](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-POST-deploy-exports "Soumet une demande d’exportation de l’instantané actuel d’une application spécifiée et d’un ou plusieurs éléments déployables dans la table Cache de l’exportateur CDM [sn_cdm_exporter_cache].") terminaison. |
[Tableau 13. Paramètres de chemin d'accès]
{#apps-GET-deploy-exports-content__entry__8}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 14. Paramètres de requête]
{#apps-GET-deploy-exports-content__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 15. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-deploy-exports-content__entry__16}{#apps-GET-deploy-exports-content__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
[Tableau 16. En-têtes de demandes]
{#apps-GET-deploy-exports-content__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 17. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-deploy-exports-content__entry__24}{#apps-GET-deploy-exports-content__entry-200-status-code}{#apps-GET-deploy-exports-content__entry-400-status-code}{#apps-GET-deploy-exports-content__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 18. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
{#apps-GET-deploy-exports-content__entry__32}
| Nom | Description |
|-|-|
| erreurs | Description des erreurs rencontrées lors de l'exportation. Type de données : chaîne |
| export_id | ID de demande d'exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne |
| exporter_result | Contenu de l'exportation des données de configuration spécifiée. Type de données : * Objet JSON : si la demande visait à exporter des données au format JSON. * Chaîne : si la demande devait exporter des données dans un autre format. {#apps-GET-deploy-exports-content__ul_xk1_2j1_psb} |
| request_id | ID de demande d'exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne |
| État | État actuel de l'exportation spécifiée. Valeur à partir de la colonne d'état dans la table File d'attente de demande CDM \[sn_cdm_request_queue\]. Valeurs possibles : * terminé * erreur * in_progress * nouveau * prêt Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant demande les données de configuration d'une demande d'exportation avec l'ID de 3ab14a7d53b1301096edddeeff7b12f.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/content" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Vous trouverez ci-dessous 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 {#ariaid-title5}
Renvoie l'état actuel de la demande d'exportation des données de configuration spécifiée.
Utilisez le [CdmApplicationsApi : POST /sn_cdm/applications/déployables/exportations](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-POST-deploy-exports "Soumet une demande d’exportation de l’instantané actuel d’une application spécifiée et d’un ou plusieurs éléments déployables dans la table Cache de l’exportateur CDM [sn_cdm_exporter_cache].") point de terminaison pour effectuer une demande d'exportation.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/status
URL par défaut : /api/sn_cdm/applications/deployables/exports/{export_id}/status
### Paramètres de demande pris en charge
{#apps-GET-deploy-exports-status__entry__2}{#apps-GET-deploy-exports-status__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| export_id | Sys_id de la demande d'exportation dont l'état doit être renvoyé. Cette valeur est renvoyée par le point de [CdmApplicationsApi : POST /sn_cdm/applications/déployables/exportations](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-POST-deploy-exports "Soumet une demande d’exportation de l’instantané actuel d’une application spécifiée et d’un ou plusieurs éléments déployables dans la table Cache de l’exportateur CDM [sn_cdm_exporter_cache].") terminaison. |
[Tableau 19. Paramètres de chemin d'accès]
{#apps-GET-deploy-exports-status__entry__8}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 20. Paramètres de requête]
{#apps-GET-deploy-exports-status__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 21. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-deploy-exports-status__entry__16}{#apps-GET-deploy-exports-status__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
[Tableau 22. En-têtes de demandes]
{#apps-GET-deploy-exports-status__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 23. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-deploy-exports-status__entry__24}{#apps-GET-deploy-exports-status__entry-200-status-code}{#apps-GET-deploy-exports-status__entry-400-status-code}{#apps-GET-deploy-exports-status__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 24. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
{#apps-GET-deploy-exports-status__entry__32}
| Nom | Description |
|-|-|
| erreurs | Description des erreurs rencontrées lors de l'exportation. Type de données : chaîne |
| export_id | ID de demande d'exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne |
| exporter_result | Détails sur l'erreur associée. Type de données : objet |
| exporter_result.erreurs | Description de la ou des erreurs rencontrées lors de l'exportation. Type de données : tableau |
| exporter_result.execution_id | Identificateur unique pour l'enregistrement d'exécution de l'exportateur. Situé dans la table sn_cdm_exporter_execution. Type de données : chaîne |
| exporter_result.État | État actuel de l'exportation spécifiée. Situé dans la table sn_cdm_exporter_execution. Valeurs possibles : * terminé * erreur * in_progress * nouveau {#apps-GET-deploy-exports-status__ul_k3z_32r_ssb} Type de données : chaîne |
| request_id | ID de demande d'exportation. Identique à celle transmise au point de terminaison. Type de données : chaîne |
| État | État actuel de l'exportation spécifiée. Valeur à partir de la colonne d'état dans la table File d'attente de demande CDM \[sn_cdm_request_queue\]. Valeurs possibles : * terminé * erreur * in_progress * nouveau * prêt Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant demande l'état d'une exportation avec l'ID 3ab14a7d53b1301096edddeeff7b12f.
curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Voici les résultats de retour possibles.
// Successful completion of the export request
{
"result": {
"state": "completed",
"export_id": "3ab14a7d53b1301096edddeeff7b12f0"
}
}
// Response when an incorrect export_id is passed. Note: Status code is 200.
{
"result": {
"request_id": "3ac8e1b05311301096edddeeff7b123c",
"state": "error",
"errors": "Invalid requestId '3ac8e1b05311301096edddeeff7b123c'",
"export_id": "3ac8e1b05311301096edddeeff7b123c"
}
}
// Response when the export encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{
"result": {
"state": "completed",
"export_id": "24536c3353f9301096edddeeff7b12b1",
"exporter_result": {
"execution_id": "81536c3353f9301096edddeeff7b129e",
"state": "failure",
"errors": [
"Snapshot 'SNA-001-published-non_compliant' has not passed validation. All snapshots of deployable '/ApplicationA/deployables/DEP3' are required to pass validation"
]
}
}
}
## CdmApplicationsApi : GET /sn_cdm/applications/shared_components {#ariaid-title6}
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 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
{#apps-GET-shared_components__entry__2}{#apps-GET-shared_components__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 25. Paramètres de chemin d'accès]
{#apps-GET-shared_components__entry__6}
| Nom | Description |
|-|-|
| appName | Requis. Nom de l'application dont vous souhaitez renvoyer la liste des composants partagés. Situé dans la table \[sn_cdm_application\] de l'application CDM. Le champ Type de l'application doit être défini sur shared_library. Type de données : chaîne |
| withUpdatesOnly | Marqueur indiquant s'il faut renvoyer uniquement les composants partagés pour lesquels une nouvelle version mise à jour est disponible. Valeurs valides : * vrai : renvoyer uniquement les composants partagés pour lesquels une nouvelle version mise à jour est disponible. * faux : renvoyer tous les composants partagés utilisés par l'application spécifiée. Valeur par défaut : false |
[Tableau 26. Paramètres de requête]
{#apps-GET-shared_components__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 27. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-shared_components__entry__16}{#apps-GET-shared_components__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 28. En-têtes de demandes]
{#apps-GET-shared_components__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 29. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-shared_components__entry__24}{#apps-GET-shared_components__entry-200-status-code}{#apps-GET-shared_components__entry-400-status-code}{#apps-GET-shared_components__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 30. Codes d'état]
### Paramètres du corps de réponse
{#apps-GET-shared_components__entry__32}
| Nom | Description |
|-|-|
| currentVersion | Version actuelle de l'application CDM. Type de données : 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 "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été 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 | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| updateVersionName | Nom de la version du composant partagé disponible pour la mise à jour. Type de données : chaîne |
[ ]
### Demande cURL
L'exemple de code suivant montre comment appeler ce point de terminaison pour récupérer les composants partagés 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 {#ariaid-title7}
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 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
{#apps-GET-shared_libs-comp-apps__entry__2}{#apps-GET-shared_libs-comp-apps__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 31. Paramètres de chemin d'accès]
{#apps-GET-shared_libs-comp-apps__entry__6}
| Nom | Description |
|-|-|
| sharedComponentName | Requis. Nom du composant partagé à inclure dans la carte. Situé dans la table Composant partagé CDM \[sn_cdm_shared_component\]. Type de données : chaîne |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée à inclure dans la carte. Situé dans la table \[sn_cdm_application\] de l'application CDM. L'application spécifiée doit avoir le champ type défini sur \<\< shared_library \>\>. Type de données : chaîne |
[Tableau 32. Paramètres de requête]
{#apps-GET-shared_libs-comp-apps__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 33. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-shared_libs-comp-apps__entry__16}{#apps-GET-shared_libs-comp-apps__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 34. En-têtes de demandes]
{#apps-GET-shared_libs-comp-apps__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 35. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-shared_libs-comp-apps__entry__24}{#apps-GET-shared_libs-comp-apps__entry-200-status-code}{#apps-GET-shared_libs-comp-apps__entry-400-status-code}{#apps-GET-shared_libs-comp-apps__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 36. Codes d'état]
### Paramètres du corps de réponse
{#apps-GET-shared_libs-comp-apps__entry__32}
| Nom | Description |
|-|-|
| description | Description de l'application à l'aide du composant partagé Type de données : chaîne |
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été 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 utilisant le composant. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| sys_id | Sys_id de l'application utilisant le composant partagé. Type de données : chaîne |
[ ]
### Demande cURL
L'exemple de code suivant montre comment appeler ce point de terminaison pour récupérer la carte qui affiche les applications de la bibliothèque partagée \<\< OracleG-Library-10 \>\> qui utilisent le composant partagé \<\< paymentService-V1.1 \>\>.
curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_libraries/components/applications?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Réponse :
{
"result": {
"component_name": [
{
"name": "App Name",
"description": "desc",
"managed_by_group": null,
"sys_id": "4e7808bb1b371110636e0fe0604bcb08"
},
{
"name": "Config App",
"description": "desc",
"managed_by_group": null,
"sys_id": "55a75cfb1b771110636e0fe0604bcb5c"
},
{
"name": "Database App",
"description": "desc",
"managed_by_group": null,
"sys_id": "2eb7503f1b771110636e0fe0604bcb06"
}
]
}
}
## CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id} {#ariaid-title8}
Renvoie l'état actuel de la demande de chargement des données de configuration spécifiée.
### Format d'URL {#apps-GET-upload-status__section_isc_fy3_psb}
URL versionnée : /api/sn_cdm/{api_version}/applications/upload-status/{upload_id}
URL par défaut : /api/sn_cdm/applications/upload-status/{upload_id}
### Paramètres de demande pris en charge
{#apps-GET-upload-status__entry__2}{#apps-GET-upload-status__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement dont l'état doit être renvoyé. Cette valeur est renvoyée par les différents points de terminaison de demande de chargement CdmApplications. |
[Tableau 37. Paramètres de chemin d'accès]
{#apps-GET-upload-status__entry__8}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 38. Paramètres de requête]
{#apps-GET-upload-status__entry__12}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 39. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-upload-status__entry__16}{#apps-GET-upload-status__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
[Tableau 40. En-têtes de demandes]
{#apps-GET-upload-status__entry__20}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 41. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-GET-upload-status__entry__24}{#apps-GET-upload-status__entry-200-status-code}{#apps-GET-upload-status__entry-400-status-code}{#apps-GET-upload-status__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 42. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
{#apps-GET-upload-status__entry__32}
| 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, message d'erreur décrivant l'erreur rencontrée. Type de données : tableau de chaînes "output": { "auto_validate": "String", "cdm_application": "String", "committed_at": "String", "committed_by": "String", "description": "String", "last_conflict_detection_time": "String", "number": "String", "publish_option": "String", "snapshot_description": "String", "snapshot_name": "String", "state": "String", "sys_created_by": "String", "sys_id": "String", "title": "String" } |
| output.auto_validate | Indique s'il faut invoquer la validation après la validation. Type de données : chaîne |
| output.cdm_application | Nom de l'application sous laquelle le chargement a été effectué. Type de données : chaîne |
| output.committed_at | Date et heure de validation du contenu chargé. Type de données : chaîne |
| output.committed_by | Sys_id de l'enregistrement de l'entité qui a effectué la validation. Type de données : chaîne |
| Sortie.description | Non utilisé actuellement. Type de données : chaîne |
| output.last_conflict_detection_time | Invocation de détection de conflit de date et d'heure. Type de données : chaîne |
| output.number | Numéro unique de l'ensemble de changements. Type de données : chaîne |
| output.publish_option | Option Publier pour les instantanés configurés associés. Valeurs valides : * publish_none : ne publiez pas d'instantanés. * publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d'informations sur la publication d'instantanés, consultez [Publier ou annuler la publication d'un instantané](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : chaîne Par défaut : publish_none Remarque : Cette option n'est disponible que si la valeur du autoCommit paramètre est vraie. |
| output.snapshot_description | Description de l'instantané associé. Type de données : chaîne |
| output.snapshot_name | Nom de l'instantané associé. Type de données : chaîne |
| sortie.état | État du contenu téléchargé. Valeurs possibles : * bloqué * checking_for_conflict * commit_failed * commit_in_progress * engagé * ouvert {#apps-GET-upload-status__ul_qhn_w4p_psb} 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 de traitement actuel de la demande de chargement. Valeurs possibles : * NOT_PROCESSED * PROCESSED {#apps-GET-upload-status__ul_gmt_2pp_psb} Type de données : chaîne |
| État | État actuel de la demande de chargement. Valeurs possibles : * terminé * erreur * in_progress * nouveau * prêt {#apps-GET-upload-status__ul_ozn_bv5_xsb} |
| type | Type de demande de chargement. Valeurs possibles : * commit * export * upload_and_commit {#apps-GET-upload-status__ul_l5m_x55_xsb} Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") 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 5560a6895326301096edddeeff7b1230.
curl "http://instance.servicenow.com/api/sn_cdm/applications/upload-status/5560a6895326301096edddeeff7b1230" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Voici les résultats de retour possibles.
// Successful completion of the upload request
{
"result": {
"type": "upload_and_commit",
"state": "completed",
"output": {
"sys_id": "be681dc95362301096edddeeff7b12ba",
"number": "Chset-102",
"title": "admin2021-09-10 08:09:07",
"description": null,
"committed_at": "2021-09-10 20:23:37",
"committed_by": "6816f79cc0a8016401c5a33be04be441",
"sys_created_by": "admin",
"state": "committed",
"publish_option": "publish_none",
"auto_validate": false,
"snapshot_name": null,
"snapshot_description": null,
"cdm_application": "Demo_App1631126164773",
"last_conflict_detection_time": "1631305417894"
},
"processing_state": "PROCESSED",
"upload_id": "5560a6895326301096edddeeff7b1230"
}
}
// Response when an incorrect upload_id is passed. Note: Status code is 200.
{
"result": {
"state": "error",
"errors": "Invalid requestId '5560a6895326301096edddeeff7b1240'",
"upload_id": "5560a6895326301096edddeeff7b1240"
}
}
// Response when the upload encounters an error. The exporter_result array contains the error information. Note: Status code is 200.
{
"result": {
"type": "upload_and_commit",
"state": "error",
"output": "Error encountered during execution of request.\nError: Node 'dbSettings' of type 'sg_cdm_node_component' cannot create child 'dbSettings' of type 'sg_cdm_node_folder'",
"processing_state": "PROCESSED",
"upload_id": "272f8a415326301096edddeeff7b1232"
}
}
## CdmApplicationsApi : POST /sn_cdm/applications/déployables {#ariaid-title9}
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 administrateur CDM.
Si vous devez créer plusieurs déployables, utilisez le point de [CdmApplicationsApi : POST /sn_cdm/applications/déployables/créer](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-POST-deploy-create "Crée un ou plusieurs nouveaux éléments déployables.") terminaison.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
### Paramètres de demande pris en charge
{#apps-POST-applications-deploys__entry__2}{#apps-POST-applications-deploys__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 43. Paramètres de chemin d'accès]
{#apps-POST-applications-deploys__entry__6}{#apps-POST-applications-deploys__cdm_apps-envType-entry}{#apps-POST-applications-deploys__cdm_apps-returnFields-entry}
| Nom | Description |
|-|-|
| appName | Requis. Nom d'une application CDM active existante à associer à l'élément déployable. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| envType | Requis. Type d'environnement pour le déployable. Valeurs valides (sensibles à la casse) : * Développement * Production * Test Remarque : Le type d'environnement déployable ne peut pas être modifié après la création. Type de données : chaîne |
| nom | Requis. Nom de l'élément déployable CDM. Ne doit pas être supérieur à 255 caractères. Les caractères autorisés par défaut sont 0-9, A-Z, a-z, _,-,., %, $, whitespace, :, #. Type de données : chaîne Longueur maximale : 255 caractères Caractères autorisés : 0-9, A-Z, a-z, _, -, ., %, $, espace blanc, : et # |
| returnFields | Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des colonnes d'enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs déterminés par le point de terminaison |
[Tableau 44. Paramètres de requête]
{#apps-POST-applications-deploys__entry__16}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 45. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-applications-deploys__entry__20}{#apps-POST-applications-deploys__accept-JSON-only-entry-RESTAPI}{#apps-POST-applications-deploys__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 46. En-têtes de demandes]
{#apps-POST-applications-deploys__entry__26}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 47. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-applications-deploys__entry__30}{#apps-POST-applications-deploys__entry-200-status-code}{#apps-POST-applications-deploys__entry-400-status-code}{#apps-POST-applications-deploys__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 48. Codes d'état]
### Paramètres du corps de réponse
{#apps-POST-applications-deploys__id_dkr_tdn_qtb__entry__2}{#apps-POST-applications-deploys__cdm_app_link-app-entry}{#apps-POST-applications-deploys__cdm_app_value-app-entry}{#apps-POST-applications-deploys__cdm_apps-error-entry}{#apps-POST-applications-deploys__cdm_dep-sys_created_by-row}{#apps-POST-applications-deploys__cdm_deps-sys_created_on-row}{#apps-POST-applications-deploys__cdm_dep-sys_updated_by-row}{#apps-POST-applications-deploys__cdm_dep-sys_updated_on-row}
| 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 : entier |
| cdi_usage | Pourcentage de CDI utilisés par le déployable. Type de données : entier |
| cdm_app | Objet d'application CDM associé au déployable. Type de données : objet "cdm_app": { "link": "String", "value": "String" } |
| cdm_app.lien | Appel à utiliser pour accéder à l'enregistrement de l'application CDM à l'aide de l'API de table REST. Type de données : chaîne |
| cdm_app.valeur | Sys_id de l'enregistrement d'application CDM associé. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| cdm_ci | Objet de service d'application associé au déployable. Type de données : objet "cdm_ci": { "link": "String", "value": "String" } |
| cdm_ci.lien | Appel à utiliser pour accéder à l'enregistrement de 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é. Situé dans la table Élément de configuration \[cmdb_ci\]. Type de données : chaîne |
| description | Description de l'élément déployable CDM généré. Type de données : chaîne |
| environment_type | Type d'environnement de l'élément déployable. Valeurs possibles : * Développement * Production * Test Type de données : chaîne |
| erreur | Renvoyé uniquement si une erreur s'est produite pendant le traitement. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| nom | Nom de l'élément déployable CDM. Type de données : chaîne |
| nœud | Détails sur le nœud déployable. Type de données : objet "node": { "link": "String", "value": "String" } |
| node.link | Appel à utiliser pour accéder à l'enregistrement du nœud déployable à l'aide de l'API de table REST. Type de données : chaîne |
| nœud.valeur | Sys_id de l'enregistrement du nœud déployable. Situé dans la table Déployable CDM \[sn_cdm_deployable\]. Type de données : chaîne |
| snapshot_version_counter | Nombre d'instantanés créés pour le déployable. Type de données : entier |
| État | État actuel de l'élément déployable. Valeurs possibles : * Actif * supprimé Type de données : chaîne |
| sys_created_by | Nom d'utilisateur de l'utilisateur qui a créé l'élément déployable CDM. Par exemple, able.tuter. Type de données : chaîne |
| sys_created_on | Date et heure de création de l'élément déployable CDM. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
| sys_id | Sys_id de l'élément déployable créé. Situé dans la table Déployable CDM \[sn_cdm_deployable\]. Type de données : chaîne |
| sys_updated_by | Nom d'utilisateur de l'utilisateur qui a mis à jour l'élément déployable CDM en dernier. Par exemple, able.tuter. Type de données : chaîne |
| sys_updated_on | Date et heure de la dernière mise à jour de l'élément déployable CDM. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
[ ]
{#apps-POST-applications-deploys__id_dkr_tdn_qtb}
### 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'
Résultats renvoyés :
{
"result": [
{
"cmdb_ci": {
"value": "f5b9e00b53901110a1d3ddeeff7b12b8",
"link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8"
},
"cdi_count": "0",
"snapshot_version_counter": "0",
"description": null,
"sys_updated_on": "2022-06-29 12:53:57",
"environment_type": "Test",
"node": {
"value": "7db9e00b53901110a1d3ddeeff7b12b6",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/7db9e00b53901110a1d3ddeeff7b12b6"
},
"sys_id": "39b9e00b53901110a1d3ddeeff7b12b7",
"sys_updated_by": "admin",
"cdm_app": {
"value": "62b517a953b70110a1d3ddeeff7b128c",
"link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c"
},
"sys_created_on": "2022-06-29 12:53:57",
"cdi_usage": "0",
"name": "Dep-2",
"state": "active",
"sys_created_by": "admin"
}
]
}
## CdmApplicationsApi : POST /sn_cdm/applications/déployables/créer {#ariaid-title10}
Crée un ou plusieurs nouveaux éléments déployables.
Vous pouvez créer l'un des deux types d'éléments déployables suivants :
* Déployables qui doivent être connectés manuellement à un modèle d'application (service CI).
* Des éléments déployables qui sont automatiquement connectés à de nouveaux modèles d'application (services CI) créés dynamiquement.
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 des éléments déployables générés automatiquement suivent le modèle suivant : `DeployableType_Number`, où `le nombre` est un nombre de séquence en cours basé sur la création d'un nouvel élément déployable. Par exemple, si vous créez trois déployables de type `Test` dans un appel de point de terminaison, ils sont nommés Test_1, Test_2 et Test_3. Si vous appelez ensuite à nouveau le point de terminaison et créez un autre déployable de test, son nom généré automatiquement est Test_4. Ces numéros ne sont jamais réutilisés, même si un élément déployable est supprimé.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/create
URL par défaut : /api/sn_cdm/applications/deployables/create
### Paramètres de demande pris en charge
{#apps-POST-deploy-create__entry__2}{#apps-POST-deploy-create__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 49. Paramètres de chemin d'accès]
{#apps-POST-deploy-create__entry__6}{#apps-POST-deploy-create__cdm_apps-envType-entry}
| Nom | Description |
|-|-|
| appSysId | Requis. Sys_id d'une application CDM active à associer aux éléments déployables. Type de données : chaîne |
| Connexion automatique | Requis. Marqueur qui détermine s'il faut connecter automatiquement les éléments déployables nouvellement créés aux modèles d'application générés dynamiquement. Valeurs valides : * vrai : connectez les éléments déployables nouvellement créés aux modèles d'application générés dynamiquement. * false : il suffit de créer les déployables. Ces déployables doivent être mappés manuellement aux modèles d'application à l'aide de l'interface utilisateur. {#apps-POST-deploy-create__ul_gdp_vwr_xsb} Type de données : booléennes |
| envType | Requis. Type d'environnement pour le déployable. Valeurs valides (sensibles à la casse) : * Développement * Production * Test Remarque : Le type d'environnement déployable ne peut pas être modifié après la création. Type de données : chaîne |
| quantité | Requis. Nombre d'éléments déployables à créer. Type de données : nombre |
[Tableau 50. Paramètres de requête]
{#apps-POST-deploy-create__entry__16}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 51. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-deploy-create__entry__20}{#apps-POST-deploy-create__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-create__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 52. En-têtes de demandes]
{#apps-POST-deploy-create__entry__26}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 53. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-deploy-create__entry__30}{#apps-POST-deploy-create__entry-200-status-code}{#apps-POST-deploy-create__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 54. Codes d'état]
### Paramètres du corps de réponse
{#apps-POST-deploy-create__entry__36}
| Nom | Description |
|-|-|
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| résultat | Sys_ids des éléments déployables créés. Type de données : tableau |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant montre comment créer un seul déployable 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'
Ce qui suit montre les réponses possibles à cet appel, à la fois en tant que succès et en tant qu'erreur.
// Successful completion of the upload request
{
"result": [
"8ba43a3db7d6011054c1e5a6ce11a9a4",
"93a47a3db7d6011054c1e5a6ce11a90d",
"dba47a3db7d6011054c1e5a6ce11a91d",
"6fa47a3db7d6011054c1e5a6ce11a921",
"efa47a3db7d6011054c1e5a6ce11a925"
]
}
// Error response
{
"error": {
"message": "Error: CDM Application with SysID 5e118055b712011054c1e5a6ce11a9d1 was not found. (sys_script_include.8cf0fbf453626010a1d3ddeeff7b12fe.script; line 211)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi : POST /sn_cdm/applications/déployables/exportations {#ariaid-title11}
Soumet une demande d'exportation de l'instantané actuel d'une application spécifiée et d'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](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-deploy-exports-status "Renvoie l’état actuel de la demande d’exportation des données de configuration spécifiée.") point de terminaison afin de récupérer l'état de l'exportation. Une fois l'exportation terminée, vous pouvez utiliser le [CdmApplicationsApi : GET /sn_cdm/applications/deployables/exports/{export_id}/content](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-deploy-exports-content "Renvoie le contenu associé à une demande d’exportation de données de configuration spécifiée.") point de terminaison pour récupérer les données de configuration de l'application associée.
Un instantané est le modèle de données complet d'un 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 au déployable. Pour plus d'informations sur les déployables, consultez [Créer et mettre à jour un déployable](https://www.servicenow.com/docs/access?context=cdm-deployable-define&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US).
Remarque :
Les instantanés ne peuvent pas dépasser 10 000 éléments de données de configuration (CDI) par déployable ou 100 000 CDI par application.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables/exports
URL par défaut : /api/sn_cdm/applications/deployables/exports
### Paramètres de demande pris en charge
{#apps-POST-deploy-exports__entry__2}{#apps-POST-deploy-exports__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 55. Paramètres de chemin d'accès]
{#apps-POST-deploy-exports__entry__6}
| Nom | Description |
|-|-|
| additionalDeployables | Éléments déployables non primaires à exporter. Type de données : tableau d'objets "additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ] Par exemple : `[{'app_name' :'TestApp', "deployable_name :'DEP-1'}]` Par défaut : tableau vide : \[\] |
| nom_additionalDeployables.app | Requis si additionalDeployables le tableau est spécifié. Nom de l'application associée au déployable dont vous souhaitez exporter les données de configuration. Type de données : chaîne |
| additionalDeployables.deployable_name | Requis si additionalDeployables le tableau est spécifié. Nom du déployable non principal dont vous souhaitez exporter les données de configuration. Type de données : chaîne |
| appName | Requis. Nom de l'application dont vous souhaitez exporter les données de configuration. Type de données : chaîne |
| args | Objet JSON contenant des paires clé-valeur pour les arguments personnalisés. Type de données : objet |
| dataFormat (Format de données) | Format de sortie des données exportées. Valeurs valides (sensibles à la casse) : * ini * JSON * Propriétés de * brut (les données sont renvoyées au format chaîne) * xml * yaml Type de données : chaîne Valeur par défaut : json |
| deployableName | Requis. Nom du déployable dont vous souhaitez exporter les données de configuration. Type de données : chaîne |
| nom de l'exportateur | Requis. Nom de l'exportateur à utiliser pour exporter les données de l'instantané. Les exportateurs sont personnalisés pour l'implémenteur. Pour plus d'informations sur la création d'un exportateur personnalisé, consultez [Créer un exportateur personnalisé](https://www.servicenow.com/docs/access?context=cdm-exporter-create-custom&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : chaîne |
| restrictExport (en anglais seulement) | Marqueur indiquant si le point de terminaison valide les instantanés lors de l'exportation des données. Valeurs valides : * true : valider les instantanés. * false : ne validez pas les instantanés. Type de données : booléennes Valeur par défaut : false |
| snapshotName | Nom de l'instantané à exporter. Il ne peut s'agir que de l'un des noms d'instantanés associés au déployable, comme spécifié dans deployableName ou additionalDeployables.deployable_name. Par défaut : le point de terminaison exporte le dernier instantané publié. S'il n'y a pas d'instantané publié, le système lève l'erreur \<\< Impossible de trouver le dernier instantané publié pour le déployable '{0}' \>\> |
[Tableau 56. Paramètres de requête]
{#apps-POST-deploy-exports__entry__28}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 57. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-deploy-exports__entry__32}{#apps-POST-deploy-exports__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-exports__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 58. En-têtes de demandes]
{#apps-POST-deploy-exports__entry__38}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 59. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-deploy-exports__entry__42}{#apps-POST-deploy-exports__entry-200-status-code}{#apps-POST-deploy-exports__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. Messages d'erreur possibles : * Erreur : paramètre \<\< appName \>\> obligatoire manquant * Erreur : l'utilisateur ne dispose pas de l'autorisation nécessaire pour créer une demande d'exportation * Erreur : valeur booléenne non valide (\). |
| 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. |
[Tableau 60. Codes d'état]
### Paramètres du corps de réponse
{#apps-POST-deploy-exports__entry__50}{#apps-POST-deploy-exports__cdm_apps-stat-error}{#apps-POST-deploy-exports__cdm_apps-stat-error_detail-row}{#apps-POST-deploy-exports__cdm_apps-stat-error_messaage-row}
| Nom | Description |
|-|-|
| erreur | Détails sur l'erreur qui s'est produite. "error": { "detail": "String", "message": "String" } Type de données : tableau |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été 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](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-deploy-exports-status "Renvoie l’état actuel de la demande d’exportation des données de configuration spécifiée.") point de terminaison pour vérifier l'état actuel de la demande d'exportation. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant demande l'exportation des données de configuration pour les éléments suivants : nom d'application = TestAppA, nom de 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 {#ariaid-title12}
Associe le composant partagé spécifié à l'application dans un ensemble de changements spécifié.
Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.
Remarque :
Le composant partagé spécifié doit avoir une version publiée associée (instantané).
### 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
{#apps-POST-shared_components__entry__2}{#apps-POST-shared_components__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 61. Paramètres de chemin d'accès]
{#apps-POST-shared_components__entry__6}{#apps-POST-shared_components__cdm_apps-returnFields-entry}
| Nom | Description |
|-|-|
| appName | Requis. Nom de l'application à associer au composant partagé. Type de données : chaîne |
| changesetNumber | Requis. Identificateur unique de l'ensemble de changements associé au composant. Type de données : chaîne |
| returnFields | Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des colonnes d'enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs déterminés par le point de terminaison |
| sharedComponentName | Requis. Nom du composant partagé à associer à l'application spécifiée. Situé dans la table Composant partagé CDM \[sn_cdm_shared_component\]. Type de données : chaîne |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée sous laquelle créer le composant. Situé dans la table \[sn_cdm_application\] de l'application CDM. La bibliothèque partagée doit avoir les champs suivants définis comme suit : * état = actif * disponible = vrai * type = shared_library Type de données : chaîne |
[Tableau 62. Paramètres de requête]
{#apps-POST-shared_components__entry__18}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 63. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-shared_components__entry__22}{#apps-POST-shared_components__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 64. En-têtes de demandes]
{#apps-POST-shared_components__entry__26}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 65. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-shared_components__entry__30}{#apps-POST-shared_components__entry-200-status-code}{#apps-POST-shared_components__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. L'ensemble de changements transmis n'existe pas. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 66. Codes d'état]
### Paramètres du corps de réponse
Les champs de réponse dépendent des champs spécifiés dans le returnFields paramètre de la demande. Ce qui suit décrit certains des domaines les plus importants.
{#apps-POST-shared_components__entry__38}{#apps-POST-shared_components__changeset-node-editor-entry}{#apps-POST-shared_components__changeset_link-node-editor-entry}{#apps-POST-shared_components__changeset_value-node-editor-entry}{#apps-POST-shared_components__cdm_apps-error-entry}{#apps-POST-shared_components__cdm_apps-error_detail-entry}{#apps-POST-shared_components__cdm_apps-error_message-entry}{#apps-POST-shared_components__cdm_dep-sys_created_by-row}{#apps-POST-shared_components__cdm_deps-sys_created_on-row}{#apps-POST-shared_components__sys_id-node-editor-entry}{#apps-POST-shared_components__cdm_dep-sys_updated_by-row}{#apps-POST-shared_components__cdm_dep-sys_updated_on-row}
| Nom | Description |
|-|-|
| changeset_id | Détails de l'enregistrement de l'ensemble de changements associé au nœud. Type de données : objet "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.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. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne |
| description | Description du nœud CDM. Type de données : chaîne |
| erreur | Renvoyé uniquement si une erreur s'est produite pendant le traitement. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Détails sur l'erreur qui s'est produite. Type de données : chaîne |
| message.erreur | Message qui donne une vue d'ensemble de l'erreur. Type de données : chaîne |
| linked_to | ID du nœud principal associé au composant partagé. Type de données : chaîne |
| linked_to_version | Détails de l'enregistrement d'instantané CDM associé au nœud. Type de données : objet "linked_to_version": { "link": "String", "value": "String" } |
| linked_to_version.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 : * true : l'instantané a été publié. * faux : l'instantané n'a pas été publié. |
| main_id | ID unique du nœud principal nouvellement créé. Type de données : chaîne |
| main_id_encoded | ID codé du nœud principal nouvellement créé. Type de données : chaîne |
| nom | Nom du nœud CDM. Type de données : chaîne |
| nœud | Sys_id du nœud du composant partagé. Type de données : chaîne |
| node_path | Chemin d'accès au nouveau nœud lié créé lors de l'ajout du composant partagé. Type de données : chaîne |
| statut | État du nœud. Valeurs possibles : Nouveau Type de données : chaîne |
| sys_created_by | Nom d'utilisateur de l'utilisateur qui crée le nœud CDM. Par exemple, able.tuter. Type de données : chaîne |
| sys_created_on | Date et heure 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. Situé dans la table Nœud CDM \[sn_cdm_node\]. Type de données : chaîne |
| sys_updated_by | Nom d'utilisateur de l'utilisateur qui a mis à jour le nœud CDM en dernier. Par exemple, able.tuter. Type de données : chaîne |
| sys_updated_on | Date et heure auxquelles le nœud CDM a été mis à mis à jour. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
| type | Type de nœud. Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant montre comment appeler ce point de terminaison pour associer l'application \<\< App1 \>\> au composant partagé \<\< paymentService-V1.1 \>\> sous la bibliothèque partagée \<\< OracleG-Library-10 \>\> au sein de l'ensemble de changements \<\< Chset-20 \>\>.
curl "https://instance.servicenow.com/api/sn_cdm/applications/shared_components?appName=App1&changesetNumber=Chset-20&sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
Réponse :
{
"result": {
"changeset_id": {
"value": "74b7ff6fc33711100c257e2cc840dd6b",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/74b7ff6fc33711100c257e2cc840dd6b"
},
"node_path": "!,0!,1!/D",
"description": null,
"sys_updated_on": "2022-12-22 17:07:29",
"type": "sn_cdm_node_linked_shared_component",
"sys_class_name": "sn_cdm_node",
"sys_id": "ff8b37ebc3b711100c257e2cc840ddba",
"sys_updated_by": "admin",
"previous_version": null,
"sys_created_on": "2022-12-22 17:07:29",
"value": null,
"effective_from": null,
"linked_to": "210",
"sys_created_by": "admin",
"restricted_to": null,
"linked_to_version": {
"value": "581fc3e9c3b311100c257e2cc840dd17",
"link": "http://instance.servicenow.com/api/now/table/sn_cdm_snapshot/581fc3e9c3b311100c257e2cc840dd17"
},
"level": "2",
"conflict_type": null,
"main_id": "483",
"effective_to": null,
"secure_value": null,
"node_classifier": "/application/components",
"main_id_encoded": "/D",
"name": "LIB2_C",
"position": null,
"reason_for_conflict": null,
"system_folder": false,
"status": "new",
"conflict": false
}
}
## CdmApplicationsApi : POST /sn_cdm/applications/uploads/components {#ariaid-title13}
Envoit une demande de chargement des données de configuration transmises pour un composant spécifique, dans le dossier des composants système, pour l'application spécifiée.
Ce point de terminaison renvoie l'ID de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement.
Remarque :
La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.
L'image suivante montre un exemple d'endroit où les données de configuration du composant sont téléchargées en référence à l'interface ServiceNow DevOps Config utilisateur. Suppose que le composant est dbComponent et que l'application est paymentSvc.
Remarque :
Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez la méthode alternative pour modifier les nœuds.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/components
URL par défaut : /api/sn_cdm/applications/uploads/components
### Paramètres de demande pris en charge
{#apps-POST-uploads-components__entry__2}{#apps-POST-uploads-components__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 67. Paramètres de chemin d'accès]
{#apps-POST-uploads-components__id_plp_1vh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-appName-row}{#apps-POST-uploads-components__cdm_apps-autoCommit-row}{#apps-POST-uploads-components__cdm_apps-autoDelete-row}{#apps-POST-uploads-components__cdm_apps-autoValidate-row}{#apps-POST-uploads-components__cdm_apps-changesetNumber-row}{#apps-POST-uploads-components__cdm_apps-dataFormat-row}{#apps-POST-uploads-components__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-components__cdm_apps-deleteRedundantOverrides-row}{#apps-POST-uploads-components__cdm_apps-fileName-row}{#apps-POST-uploads-components__cdm_apps-fileNodeName-row}{#apps-POST-uploads-components__cdm_apps-identifierKeys-row}{#apps-POST-uploads-components__cdm_apps-ignoreAttributes-row}{#apps-POST-uploads-components__cdm_apps-namePath-row}{#apps-POST-uploads-components__cdm_apps-sharedLibraryName-row}
| Nom | Description |
|-|-|
| appName | Nom de l'application à associer aux données de configuration. Cette application doit avoir l'état actif. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| Validation automatique | 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 : * vrai : l'ensemble de changements est validé après le chargement. * false : l'ensemble de changements n'est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu téléchargé, sont supprimés une fois le traitement terminé. Valeurs valides : * true : supprime automatiquement les nœuds existants. * false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false |
| Valider automatiquement | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : * true : validez les instantanés. * false : ne validez pas les instantanés. Remarque : Cette option n'est disponible que si le autoCommit paramètre est défini sur vrai. Type de données : booléennes Valeur par défaut : false |
| changesetNumber | Chaîne qui identifie de manière unique [l'ensemble de changements](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associé à l'application, telle que Chset-102. Cet ensemble de changements doit être dans l'état \<\< Ouvert \>\>. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l'ensemble de changements sont renvoyés dans le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") cadre des résultats. |
| dataFormat (Format de données) | Requis. Format des données de configuration. Valeurs valides : * csv * ini * JSON * Propriétés de * brut * xml * yaml Type de données : chaîne |
| dataFormatAttributes | Pris en charge uniquement 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](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : objet "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d'en-tête. Valeurs valides : * true : les données contiennent une ligne d'en-tête. La première ligne des données est considérée comme la ligne d'en-tête. * false : les données ne contiennent pas de ligne d'en-tête. Vous devez transmettre les informations d'en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false |
| dataFormatAttributes.delimeter | Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne 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 de clés des CDI au format JSON. Le nombre d'en-têtes doit correspondre au nombre de champs d'enregistrement. Type de données : tableau Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Champs dans les données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées dans CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l'attribut d'en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l'aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundantOverrides | Marqueur indiquant s'il faut créer un remplacement lorsque des valeurs redondantes sont présentes. Valeurs valides : * true : si des valeurs redondantes sont présentes, un remplacement n'est pas créé. * false : si des valeurs redondantes sont présentes, procède au remplacement. Valeur par défaut : true |
| fileName | Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l'extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne |
| fileNodeName | Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l'exportation. Ce nom ne nécessite pas d'extension de fichier et n'affecte pas le téléchargement. Type de données : chaîne |
| identifierKeys | Liste de noms qui indiquent la clé d'un enfant de tableau à utiliser pour identifier le même nœud. Par exemple, si vous chargez : [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] dans le modèle existant suivant : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] et que vous définissez identifierKeys sur name, cela produit la sortie suivante : [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Sinon, il produit la sortie suivante : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Type de données : tableau de chaînes |
| ignoreAttributes (en anglais seulement) | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : * vrai : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont ignorés pendant le chargement. * false : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont inclus dans le chargement. {#apps-POST-uploads-components__ul_egn_4q4_1yb} Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin d'accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d'accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d'accès au nom dans l'un des formats suivants. Par exemple, pour définir le chemin d'accès du nom du nœud `testApp/deployables/Development1/cdi1` : * Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (\<\< / \>\>), vous ne pouvez pas utiliser ce format. * Chemin d'accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1 * Tableau : \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components__cdm_apps-namePath-ul} Remarque : Si le composant spécifié n'existe pas sur le chemin d'accès spécifié, le système crée automatiquement le composant sur le chemin d'accès spécifié, puis charge les données. Type de données : chaîne |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
[Tableau 68. Paramètres de requête]
{#apps-POST-uploads-components__id_plp_1vh_psb} {#apps-POST-uploads-components__id_lx4_bvh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-var_up_data-entry}
| 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. |
[Tableau 69. Paramètres de corps de demande (XML ou JSON)]
{#apps-POST-uploads-components__id_lx4_bvh_psb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-components__id_trg_k25_2wb__entry__2}{#apps-POST-uploads-components__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain |
[Tableau 70. En-têtes de demandes]
{#apps-POST-uploads-components__id_trg_k25_2wb} {#apps-POST-uploads-components__entry__54}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 71. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-components__id_vvq_4wh_psb__entry__2}{#apps-POST-uploads-components__entry-200-status-code}{#apps-POST-uploads-components__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : * La taille de la charge utile de la configuration est supérieure à la limite autorisée : 2 Mo par défaut. * Les paramètres requis sont manquants dans l'appel. {#apps-POST-uploads-components__ul_kmn_gkh_psb} |
| 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. |
[Tableau 72. Codes d'état]
{#apps-POST-uploads-components__id_vvq_4wh_psb}
### Paramètres du corps de réponse (JSON ou XML)
{#apps-POST-uploads-components__id_b4z_nwh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-stat-error}{#apps-POST-uploads-components__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components__cdm_apps-upload_id-row}
| Nom | Description |
|-|-|
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement. Type de données : chaîne |
[ ]
{#apps-POST-uploads-components__id_b4z_nwh_psb}
### Demande cURL
L'exemple suivant montre une demande de chargement pour le Demo_App1631126164773 d'application.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoValidate=false&autoDelete=true" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\
"}" \
--user 'username':'password'
Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d'erreur pour cette demande.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi : POST /sn_cdm/applications/uploads/components/vars {#ariaid-title14}
Envoit une demande de chargement des données de configuration transmises dans le dossier vars, dans le dossier des composants système, pour l'application spécifiée.
L'image suivante montre un exemple d'endroit où les données de configuration des variables du composant sont téléchargées en référence à l'interface utilisateur de l'espace ServiceNow DevOps Config de travail. Suppose que l'application est paymentSvc.
Remarque :
La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.
### Format d'URL {#apps-POST-uploads-components-var__section_xgv_syh_psb}
URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/components/vars
URL par défaut : /api/sn_cdm/applications/uploads/components/vars
### Paramètres de demande pris en charge
{#apps-POST-uploads-components-var__entry__2}{#apps-POST-uploads-components-var__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 73. Paramètres de chemin d'accès]
{#apps-POST-uploads-components-var__id_ey4_w13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-dataFormat-row}
| Nom | Description |
|-|-|
| appName | Nom de l'application à associer aux données de configuration. Cette application doit avoir l'état actif. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| Validation automatique | 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 : * vrai : l'ensemble de changements est validé après le chargement. * false : l'ensemble de changements n'est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu téléchargé, sont supprimés une fois le traitement terminé. Valeurs valides : * true : supprime automatiquement les nœuds existants. * false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false |
| Valider automatiquement | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : * true : validez les instantanés. * false : ne validez pas les instantanés. Remarque : Cette option n'est disponible que si le autoCommit paramètre est défini sur vrai. Type de données : booléennes Valeur par défaut : false |
| changesetNumber | Chaîne qui identifie de manière unique [l'ensemble de changements](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associé à l'application, telle que Chset-102. Cet ensemble de changements doit être dans l'état \<\< Ouvert \>\>. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l'ensemble de changements sont renvoyés dans le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") cadre des résultats. |
| dataFormat (Format de données) | Requis. Format des données de configuration. Valeurs valides : * ini * JSON * Propriétés de * brut * xml * yaml Type de données : chaîne |
| deleteRedundantOverrides | Marqueur indiquant s'il faut créer un remplacement lorsque des valeurs redondantes sont présentes. Valeurs valides : * true : si des valeurs redondantes sont présentes, un remplacement n'est pas créé. * false : si des valeurs redondantes sont présentes, procède au remplacement. Valeur par défaut : true |
| fileName | Nom du fichier à charger. Ce nom peut différer du nom de fichier réel et contenir l'extension du fichier. Par exemple, .txt/.scv/.jar. La valeur fileName est appliquée lors du téléchargement du fichier. Type de données : chaîne |
| fileNodeName | Nom du nœud de fichier. Ce nom de fichier est utilisé dans les données de configuration lors de l'exportation. Ce nom ne nécessite pas d'extension de fichier et n'affecte pas le téléchargement. Type de données : chaîne |
| identifierKeys | Liste de noms qui indiquent la clé d'un enfant de tableau à utiliser pour identifier le même nœud. Par exemple, si vous chargez : [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] dans le modèle existant suivant : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] et que vous définissez identifierKeys sur name, cela produit la sortie suivante : [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Sinon, il produit la sortie suivante : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Type de données : tableau de chaînes |
| ignoreAttributes (en anglais seulement) | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : * vrai : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont ignorés pendant le chargement. * false : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont inclus dans le chargement. {#apps-POST-uploads-components-var__ul_egn_4q4_1yb} Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin d'accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d'accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d'accès au nom dans l'un des formats suivants. Par exemple, pour définir le chemin d'accès du nom du nœud `testApp/deployables/Development1/cdi1` : * Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (\<\< / \>\>), vous ne pouvez pas utiliser ce format. * Chemin d'accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1 * Tableau : \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components-var__cdm_apps-namePath-ul} Remarque : Si le composant spécifié n'existe pas sur le chemin d'accès spécifié, le système crée automatiquement le composant sur le chemin d'accès spécifié, puis charge les données. Type de données : chaîne |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée où se trouve le composant à supprimer. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
[Tableau 74. Paramètres de requête]
{#apps-POST-uploads-components-var__id_ey4_w13_psb} {#apps-POST-uploads-components-var__id_x4h_y13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-var_up_data-entry}
| 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. |
[Tableau 75. Paramètres de corps de demande (XML ou JSON)]
{#apps-POST-uploads-components-var__id_x4h_y13_psb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-components-var__id_cvs_bmb_fwb__entry__2}{#apps-POST-uploads-components-var__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain |
[Tableau 76. En-têtes de demandes]
{#apps-POST-uploads-components-var__id_cvs_bmb_fwb} {#apps-POST-uploads-components-var__entry__44}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 77. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-components-var__id_dqr_z13_psb__entry__2}{#apps-POST-uploads-components-var__entry-200-status-code}{#apps-POST-uploads-components-var__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : * La taille de la charge utile de la configuration est supérieure à la limite autorisée : 2 Mo par défaut. * Les paramètres requis sont manquants dans l'appel. {#apps-POST-uploads-components-var__ul_kmn_gkh_psb} |
| 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. |
[Tableau 78. Codes d'état]
{#apps-POST-uploads-components-var__id_dqr_z13_psb}
### Paramètres du corps de réponse (JSON ou XML)
{#apps-POST-uploads-components-var__id_pcq_1b3_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-stat-error}{#apps-POST-uploads-components-var__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components-var__cdm_apps-upload_id-row}
| Nom | Description |
|-|-|
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement. Type de données : chaîne |
[ ]
{#apps-POST-uploads-components-var__id_pcq_1b3_psb}
### 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 montrent à la fois une réponse réussie et une réponse d'erreur pour cette demande.
// Successful completion of the upload request
{
"result": {
"upload_id": "d21f71f45322301096eccceaff7b1ce3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi : PUBLIER /sn_cdm/applications/chargements/collections {#ariaid-title15}
Soumet une demande de chargement des données de configuration transmises pour une collection spécifique, dans le dossier des collections système, pour l'application spécifiée.
Ce point de terminaison renvoie l'ID de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement.
Remarque :
La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.
L'image suivante montre un exemple d'endroit où les données de configuration sont téléchargées en référence à l'interface utilisateur de l'espace ServiceNow DevOps Config de travail. Suppose que la collection est db0Release1.0 et que l'application est paymentSvc.
Remarque :
Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez la méthode alternative pour modifier les nœuds.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/collections
URL par défaut : /api/sn_cdm/applications/uploads/collections
### Paramètres de demande pris en charge
{#apps-POST-uploads-collections__entry__2}{#apps-POST-uploads-collections__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 79. Paramètres de chemin d'accès]
{#apps-POST-uploads-collections__id_ycw_c33_psb__entry__2}{#apps-POST-uploads-collections__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_securedHeaders-entry}
| Nom | Description |
|-|-|
| appName | Nom de l'application à associer aux données de configuration. Cette application doit avoir l'état actif. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| Validation automatique | 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 : * vrai : l'ensemble de changements est validé après le chargement. * false : l'ensemble de changements n'est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu téléchargé, sont supprimés une fois le traitement terminé. Valeurs valides : * true : supprime automatiquement les nœuds existants. * false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false |
| Valider automatiquement | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : * true : validez les instantanés. * false : ne validez pas les instantanés. Remarque : Cette option n'est disponible que si le autoCommit paramètre est défini sur vrai. Type de données : booléennes Valeur par défaut : false |
| changesetNumber | Chaîne qui identifie de manière unique [l'ensemble de changements](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associé à l'application, telle que Chset-102. Cet ensemble de changements doit être dans l'état \<\< Ouvert \>\>. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l'ensemble de changements sont renvoyés dans le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") cadre des résultats. |
| collectionName | Requis. Nom de la collection sous laquelle stocker la charge utile chargée. Remarque : Si ce élément n'existe namePath pas dans cette collection, le système crée automatiquement le ou les composants sous cette collection, puis charge le contenu de configuration. Par exemple, si vous souhaitez 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 charge les données sous `compC`. Type de données : chaîne |
| dataFormat (Format de données) | Requis. Format des données de configuration. Valeurs valides : * csv * ini * JSON * Propriétés de * brut * xml * yaml Type de données : chaîne |
| dataFormatAttributes | Pris en charge uniquement 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](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : objet "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d'en-tête. Valeurs valides : * true : les données contiennent une ligne d'en-tête. La première ligne des données est considérée comme la ligne d'en-tête. * false : les données ne contiennent pas de ligne d'en-tête. Vous devez transmettre les informations d'en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false |
| dataFormatAttributes.delimeter | Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne 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 de clés des CDI au format JSON. Le nombre d'en-têtes doit correspondre au nombre de champs d'enregistrement. Type de données : tableau Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Champs dans les données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées dans CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l'attribut d'en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l'aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundantOverrides | Marqueur indiquant s'il faut créer un remplacement lorsque des valeurs redondantes sont présentes. Valeurs valides : * true : si des valeurs redondantes sont présentes, un remplacement n'est pas créé. * false : si des valeurs redondantes sont présentes, procède au remplacement. Valeur par défaut : true |
| ignoreAttributes (en anglais seulement) | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : * vrai : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont ignorés pendant le chargement. * false : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont inclus dans le chargement. {#apps-POST-uploads-collections__ul_egn_4q4_1yb} Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin d'accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d'accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d'accès au nom dans l'un des formats suivants. Par exemple, pour définir le chemin d'accès du nom du nœud `testApp/deployables/Development1/cdi1` : * Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (\<\< / \>\>), vous ne pouvez pas utiliser ce format. * Chemin d'accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1 * Tableau : \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-collections__cdm_apps-namePath-ul} Remarque : Si le composant spécifié n'existe pas sur le chemin d'accès spécifié, le système crée automatiquement le composant sur le chemin d'accès spécifié, puis charge les données. Type de données : chaîne |
[Tableau 80. Paramètres de requête]
{#apps-POST-uploads-collections__id_ycw_c33_psb} {#apps-POST-uploads-collections__id_afd_233_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-var_up_data-entry}
| 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. |
[Tableau 81. Paramètres de corps de demande (XML ou JSON)]
{#apps-POST-uploads-collections__id_afd_233_psb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-collections__id_h4r_fmb_fwb__entry__2}{#apps-POST-uploads-collections__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain |
[Tableau 82. En-têtes de demandes]
{#apps-POST-uploads-collections__id_h4r_fmb_fwb} {#apps-POST-uploads-collections__entry__48}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 83. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-collections__id_szz_f33_psb__entry__2}{#apps-POST-uploads-collections__entry-200-status-code}{#apps-POST-uploads-collections__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : * La taille de la charge utile de la configuration est supérieure à la limite autorisée : 2 Mo par défaut. * Les paramètres requis sont manquants dans l'appel. {#apps-POST-uploads-collections__ul_kmn_gkh_psb} |
| 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. |
[Tableau 84. Codes d'état]
{#apps-POST-uploads-collections__id_szz_f33_psb}
### Paramètres du corps de réponse (JSON ou XML)
{#apps-POST-uploads-collections__id_i55_g33_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-stat-error}{#apps-POST-uploads-collections__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_status-row}{#apps-POST-uploads-collections__cdm_apps-upload_id-row}
| Nom | Description |
|-|-|
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement. Type de données : chaîne |
[ ]
{#apps-POST-uploads-collections__id_i55_g33_psb}
### Demande cURL
Cet exemple montre comment charger la date de configuration au format dbSettings JSON dans le dossier collections de l'Demo_App1631126164773 d'application.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections?dataFormat=json&autoValidate=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&autoDelete=true&namePath=%2FSettings%2FdbSettings&collectionName=release-1.0&autoCommit=false&publishOption=publish_none" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbSettings\": {
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\"
}
}" \
--user 'username':'password'
Ce qui suit montre les réponses possibles à cet appel, à la fois en tant que succès et en tant qu'erreur.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi : POST /sn_cdm/applications/uploads/deployables {#ariaid-title16}
Envoit une demande de chargement du contenu de configuration d'un déployable spécifique dans le dossier système des déployables d'une application spécifiée.
Ce point de terminaison renvoie l'ID de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement.
Remarque :
La taille maximale du contenu téléchargé par défaut est de 2 Mo. Vous pouvez modifier cette valeur par défaut en mettant à jour la propriété sn_cdm.max_allowed_upload_file_size.
L'image suivante montre un exemple 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.
Remarque :
Cette méthode de chargement ne peut pas être utilisée pour modifier des nœuds. Utilisez la méthode alternative pour modifier les nœuds.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/uploads/deployables
URL par défaut : /api/sn_cdm/applications/uploads/deployables
### Paramètres de demande pris en charge
{#apps-POST-uploads-deployables__entry__2}{#apps-POST-uploads-deployables__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 85. Paramètres de chemin d'accès]
{#apps-POST-uploads-deployables__entry__6}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-deployables__publish_option-changeset-entry}
| Nom | Description |
|-|-|
| appName | Nom de l'application à associer aux données de configuration. Cette application doit avoir l'état actif. Situé dans la table \[sn_cdm_application\] de l'application CDM. Type de données : chaîne |
| Validation automatique | 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 : * vrai : l'ensemble de changements est validé après le chargement. * false : l'ensemble de changements n'est pas validé après le chargement. Type de données : booléennes Valeur par défaut : false |
| autoDelete | Marqueur indiquant si les nœuds existants, qui ne font pas partie du contenu téléchargé, sont supprimés une fois le traitement terminé. Valeurs valides : * true : supprime automatiquement les nœuds existants. * false : ne supprime pas automatiquement les nœuds existants. Type de données : booléennes Valeur par défaut : false |
| Valider automatiquement | Marqueur indiquant si les instantanés créés lors de la validation sont validés. Valeurs valides : * true : validez les instantanés. * false : ne validez pas les instantanés. Remarque : Cette option n'est disponible que si le autoCommit paramètre est défini sur vrai. Type de données : booléennes Valeur par défaut : false |
| changesetNumber | Chaîne qui identifie de manière unique [l'ensemble de changements](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) associé à l'application, telle que Chset-102. Cet ensemble de changements doit être dans l'état \<\< Ouvert \>\>. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne Par défaut : crée un ensemble de changements à utiliser. Les détails de l'ensemble de changements sont renvoyés dans le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") cadre des résultats. |
| dataFormat (Format de données) | Requis. Format des données de configuration. Valeurs valides : * csv * ini * JSON * Propriétés de * brut * xml * yaml Type de données : chaîne |
| dataFormatAttributes | Pris en charge uniquement 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](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : objet "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } |
| dataFormatAttributes.containsHeaders | Marqueur indiquant si les données contiennent une ligne d'en-tête. Valeurs valides : * true : les données contiennent une ligne d'en-tête. La première ligne des données est considérée comme la ligne d'en-tête. * false : les données ne contiennent pas de ligne d'en-tête. Vous devez transmettre les informations d'en-tête dans le dataFormatAttributes.headers paramètre. Type de données : booléennes Valeur par défaut : false |
| dataFormatAttributes.delimeter | Caractère à utiliser pour délimiter les champs dans les données. Type de données : chaîne 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 de clés des CDI au format JSON. Le nombre d'en-têtes doit correspondre au nombre de champs d'enregistrement. Type de données : tableau Par défaut : tableau vide |
| dataFormatAttributes.securedHeaders | Champs dans les données qui sont des champs sécurisés et qui doivent être chiffrés dans les données chargées dans CDM. Le nom des en-têtes sécurisés doit correspondre au nom des en-têtes dans l'attribut d'en-têtes ou le fichier de données. Ces champs sont stockés dans une colonne de type Mot de passe (2 Way Encrypted). Remarque : Vous ne pouvez sécuriser que les champs à l'aide de cet attribut. Vous ne pouvez pas déverrouiller les champs sécurisés. Type de données : tableau Par défaut : tableau vide |
| deleteRedundantOverrides | Marqueur indiquant s'il faut créer un remplacement lorsque des valeurs redondantes sont présentes. Valeurs valides : * true : si des valeurs redondantes sont présentes, un remplacement n'est pas créé. * false : si des valeurs redondantes sont présentes, procède au remplacement. Valeur par défaut : true |
| deployableName | Requis. Nom du déployable sous lequel stocker la charge utile chargée. Remarque : Si ce qui est 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. |
| identifierKeys | Liste de noms qui indiquent la clé d'un enfant de tableau à utiliser pour identifier le même nœud. Par exemple, si vous chargez : [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] dans le modèle existant suivant : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] et que vous définissez identifierKeys sur name, cela produit la sortie suivante : [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Sinon, il produit la sortie suivante : [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Type de données : tableau de chaînes |
| ignoreAttributes (en anglais seulement) | Marqueur indiquant si le format de données donné prend en charge les attributs (actuellement uniquement XML). Valeurs valides : * vrai : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont ignorés pendant le chargement. * false : si le format de données donné prend en charge les attributs, tous les attributs des données d'entrée sont inclus dans le chargement. {#apps-POST-uploads-deployables__ul_egn_4q4_1yb} Type de données : booléennes Valeur par défaut : false |
| namePath | Chemin d'accès du nœud ciblé sous lequel les données de configuration doivent être téléchargées. Ce chemin d'accès est relatif aux composants, à la collection ou au dossier déployable (selon le point de terminaison appelé). Vous pouvez transmettre le chemin d'accès au nom dans l'un des formats suivants. Par exemple, pour définir le chemin d'accès du nom du nœud `testApp/deployables/Development1/cdi1` : * Format de barre oblique inverse : testApp/deployables/Development1/cdi1 Remarque : Si le nom de votre nœud contient une barre oblique inverse (\<\< / \>\>), vous ne pouvez pas utiliser ce format. * Chemin d'accès au nom du back-end avec caractères de remplacement : testApp déployables Développement1 cdi1 * Tableau : \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-deployables__cdm_apps-namePath-ul} Remarque : Si le composant spécifié n'existe pas sur le chemin d'accès spécifié, le système crée automatiquement le composant sur le chemin d'accès spécifié, puis charge les données. Type de données : chaîne |
| publishOption (en anglais seulement) | Option Publier pour les instantanés configurés associés. Valeurs valides : * publish_none : ne publiez pas d'instantanés. * publish_valid : publiez uniquement les instantanés qui passent la validation après la validation. Pour plus d'informations sur la publication d'instantanés, consultez [Publier ou annuler la publication d'un instantané](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Type de données : chaîne Par défaut : publish_none Remarque : Cette option n'est disponible que si la valeur du autoCommit paramètre est vraie. |
[Tableau 86. Paramètres de requête]
{#apps-POST-uploads-deployables__id_njw_zv3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-var_up_data-entry}
| 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. |
[Tableau 87. Paramètres de corps de demande (XML ou JSON)]
{#apps-POST-uploads-deployables__id_njw_zv3_psb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-deployables__id_ilq_dmb_fwb__entry__2}{#apps-POST-uploads-deployables__accept-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Type de contenu | Format de données du corps de la demande. Types pris en charge : text/plain et application/x-www-form-urlencoded. Valeur par défaut : text/plain |
[Tableau 88. En-têtes de demandes]
{#apps-POST-uploads-deployables__id_ilq_dmb_fwb} {#apps-POST-uploads-deployables__entry__52}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 89. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-POST-uploads-deployables__id_gty_cw3_psb__entry__2}{#apps-POST-uploads-deployables__entry-200-status-code}{#apps-POST-uploads-deployables__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. La demande de chargement a été rejetée. Problèmes possibles : * La taille de la charge utile de la configuration est supérieure à la limite autorisée : 2 Mo par défaut. * Les paramètres requis sont manquants dans l'appel. {#apps-POST-uploads-deployables__ul_kmn_gkh_psb} |
| 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. |
[Tableau 90. Codes d'état]
{#apps-POST-uploads-deployables__id_gty_cw3_psb}
### Paramètres du corps de réponse (JSON ou XML)
{#apps-POST-uploads-deployables__id_gcv_2w3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-stat-error}{#apps-POST-uploads-deployables__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_status-row}{#apps-POST-uploads-deployables__cdm_apps-upload_id-row}
| Nom | Description |
|-|-|
| erreur | Si une erreur s'est produite pendant le traitement, les détails de l'erreur. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Informations supplémentaires sur l'erreur. Type de données : chaîne |
| message.erreur | Message d'erreur qui a été généré lors de la tentative de traitement de la demande. Type de données : chaîne |
| statut | État de l'erreur de la demande. Valeurs possibles : échec Type de données : chaîne |
| upload_id | Sys_id de la demande de chargement. Utilisez cet ID pour appeler le [CdmApplicationsApi : GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/I6_2HpQZOLi8~GeWykB6CQ#apps-GET-upload-status "Renvoie l’état actuel de la demande de chargement des données de configuration spécifiée.") point de terminaison afin d'obtenir l'état du chargement. Type de données : chaîne |
[ ]
{#apps-POST-uploads-deployables__id_gcv_2w3_psb}
### Demande cURL
L'exemple suivant montre une demande de chargement pour le Demo_App1631126164773 d'application.
curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables?deployableName=TST-1&autoValidate=false&dataFormat=json&autoDelete=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&publishOption=publish_none&autoCommit=true&namePath=%2FSettings%2FdbSettings" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:text/plain" \
--data "{
\"dbIPAddress\": \"10.10.10.110\",
\"dbPort\": \"8080\",
\"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\",
\"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\"
}" \
--user 'username':'password'
Les résultats de retour suivants montrent à la fois une réponse réussie et une réponse d'erreur pour cette demande.
// Successful completion of the upload request
{
"result": {
"upload_id": "ec1f71f45322301096edddeeff7b12b3"
}
}
// Error response. Payload is too large.
{
"error": {
"message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)",
"detail": ""
},
"status": "failure"
}
## CdmApplicationsApi : PUT /sn_cdm/applications/déployables {#ariaid-title17}
Met à jour le composant partagé spécifié dans une application au sein d'un ensemble de changements spécifié.
Permet de mettre à jour les champs suivants :
* Nom
* Description
* Service d'application\\Groupe de CI dynamique
* Identificateur de déployable
{#apps-PUT-application_deployables__ul_dgk_lzh_qxb}
Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/deployables
URL par défaut : /api/sn_cdm/applications/deployables
### Paramètres de demande pris en charge
{#apps-PUT-application_deployables__entry__2}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 91. Paramètres de chemin d'accès]
{#apps-PUT-application_deployables__entry__6}
| Nom | Description |
|-|-|
| appName | Requis. Nom de l'application CDM. Type de données : chaîne |
| nom | Requis. Nom de l'élément déployable CDM. Type de données : chaîne |
| nouvelleDescription | Facultatif. Description de l'élément déployable CDM. Type de données : chaîne |
| nouveauServiceId | Facultatif. ID du service d'application/groupe de CI dynamique souhaité. Dans la demande cURL, `indiquez <<` \>\> pour déconnecter le déployable du service. |
| nouveauIdentificateur | Facultatif. L'identificateur du déployable. Type de données : Choix (Développement/Test/Production |
| nouveauNom | 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. |
[Tableau 92. Paramètres de requête]
{#apps-PUT-application_deployables__entry__22}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 93. Paramètres de corps de demande (XML ou JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-PUT-application_deployables__entry__26}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json |
[Tableau 94. En-têtes de demandes]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-PUT-application_deployables__entry__30}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 95. Codes d'état]
### Paramètres du corps de réponse (JSON ou XML)
{#apps-PUT-application_deployables__entry__38}
| Nom | Description |
|-|-|
| sys_id | sys_Id déployable CDM. |
| nom | Nom de l'élément déployable CDM. |
| nœud | Objet de nœud déployable. `{ 'valeur' : '', 'lien' : 'http://localhost:8081/api/now/table/*'}` |
| description | Description de l'élément déployable CDM. |
| identificateur | Un identificateur pour le déployable. |
| cmdb_ci | Objet de service d'application qui est connecté à un élément déployable. `{ 'valeur' : '', 'lien' : 'http://localhost:8081/api/now/table/*'}` |
| cmdb_app | L'objet d'application CDM. `{ 'valeur' : '', 'lien' : 'http://localhost:8081/api/now/table/*'}` |
| snapshot_version_counter | Nombre d'instantanés créés pour un élément déployable. |
| cdi_count | Nombre de CDI contenus dans cet élément déployable CDM. |
| cdi_usage | Le pourcentage d'utilisation de CDI. |
| environment_type | Le type d'environnement. Valeurs possibles : * développement * production * test {#apps-PUT-application_deployables__ul_y2w_5c3_qxb} |
| État | L'état actif ou supprimé . Valeurs possibles : * Actif * supprimé {#apps-PUT-application_deployables__ul_cth_wc3_qxb} |
| sys_created_by | Déployable CDM créé par \. |
| sys_created_on | Horodatage de création d'élément déployable CDM au format \. |
| sys_updated_by | Déployable CDM mis à jour par \. |
| sys_updated_on | Déployable CDM mis à jour par horodatage au format \. |
[ ]
### 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 {#ariaid-title18}
Met à jour le composant partagé spécifié dans une application au sein d'un ensemble de changements spécifié.
Le rôle administrateur CDM est requis pour accéder à ce point de terminaison.
### Format d'URL
URL versionnée : /api/sn_cdm/{api_version}/applications/shared_components
URL par défaut : /api/sn_cdm/applications/shared_components
### Paramètres de demande pris en charge
{#apps-PUT-shared_components__entry__2}{#apps-PUT-shared_components__version-RESTAPI}
| Nom | Description |
|-|-|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
[Tableau 96. Paramètres de chemin d'accès]
{#apps-PUT-shared_components__entry__6}{#apps-PUT-shared_components__cdm_apps-returnFields-entry}
| Nom | Description |
|-|-|
| changesetNumber | Requis. Identificateur unique de l'ensemble de changements associé au composant. Type de données : chaîne |
| returnFields | Liste des champs à renvoyer dans le cadre de la réponse. Transmettez les noms des colonnes d'enregistrement tels que sys_id, sys_updated_by ou état. Type de données : tableau Par défaut : tous les champs déterminés par le point de terminaison |
| sharedComponentName | Requis. Nom du composant partagé associé à l'application spécifiée. Situé dans la table Composant partagé CDM \[sn_cdm_shared_component\]. Type de données : chaîne |
| sharedLibraryName | Requis. Nom de la bibliothèque partagée sous laquelle réside le composant. Situé dans la table \[sn_cdm_application\] de l'application CDM. La bibliothèque partagée doit avoir les champs suivants définis comme suit : * état = actif * disponible = vrai * type = shared_library Type de données : chaîne |
| version | Requis. Nom de version associé au composant partagé. Situé dans la table Instantané CDM \[sn_cdm_snapshot\]. Type de données : chaîne |
[Tableau 97. Paramètres de requête]
{#apps-PUT-shared_components__entry__18}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 98. Paramètres du corps de la demande]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-PUT-shared_components__entry__22}{#apps-PUT-shared_components__accept-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
[Tableau 99. En-têtes de demandes]
{#apps-PUT-shared_components__entry__26}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 100. En-têtes de réponses]
### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#apps-PUT-shared_components__entry__30}{#apps-PUT-shared_components__entry-200-status-code}{#apps-PUT-shared_components__entry-500-status-code}
| Code d'état | Description |
|-|-|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. L'ensemble de changements transmis n'existe pas. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
[Tableau 101. Codes d'état]
### Paramètres du corps de réponse
Les champs de réponse dépendent des champs spécifiés dans le returnFields paramètre de la demande. Ce qui suit décrit certains des domaines les plus importants.
{#apps-PUT-shared_components__entry__38}{#apps-PUT-shared_components__changeset-node-editor-entry}{#apps-PUT-shared_components__changeset_link-node-editor-entry}{#apps-PUT-shared_components__changeset_value-node-editor-entry}{#apps-PUT-shared_components__cdm_apps-error-entry}{#apps-PUT-shared_components__cdm_apps-error_detail-entry}{#apps-PUT-shared_components__cdm_apps-error_message-entry}{#apps-PUT-shared_components__cdm_dep-sys_created_by-row}{#apps-PUT-shared_components__cdm_deps-sys_created_on-row}{#apps-PUT-shared_components__sys_id-node-editor-entry}{#apps-PUT-shared_components__cdm_dep-sys_updated_by-row}{#apps-PUT-shared_components__cdm_dep-sys_updated_on-row}
| Nom | Description |
|-|-|
| changeset_id | Détails de l'enregistrement de l'ensemble de changements associé au nœud. Type de données : objet "changeset_id": { "link": "String", "value": "String" } |
| changeset_id.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. Situé dans la table de l'ensemble de changements CDM \[sn_cdm_changeset\]. Type de données : chaîne |
| description | Description du nœud CDM. Type de données : chaîne |
| erreur | Renvoyé uniquement si une erreur s'est produite pendant le traitement. Type de données : objet "error": { "detail": "String", "message": "String" } |
| error.detail | Détails sur l'erreur qui s'est produite. Type de données : chaîne |
| message.erreur | Message qui donne une vue d'ensemble de l'erreur. Type de données : chaîne |
| linked_to | ID du nœud principal associé au composant partagé. Type de données : chaîne |
| linked_to_version | Détails de l'enregistrement d'instantané CDM associé au nœud. Type de données : objet "linked_to_version": { "link": "String", "value": "String" } |
| linked_to_version.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 : * true : l'instantané a été publié. * faux : l'instantané n'a pas été publié. |
| main_id | ID unique du nœud principal nouvellement créé. Type de données : chaîne |
| main_id_encoded | ID codé du nœud principal nouvellement créé. Type de données : chaîne |
| nom | Nom du nœud CDM. Type de données : chaîne |
| nœud | Sys_id du nœud du composant partagé. Type de données : chaîne |
| node_path | Chemin d'accès au nouveau nœud lié créé lors de l'ajout du composant partagé. Type de données : chaîne |
| statut | État du nœud. Valeurs possibles : Nouveau Type de données : chaîne |
| sys_created_by | Nom d'utilisateur de l'utilisateur qui crée le nœud CDM. Par exemple, able.tuter. Type de données : chaîne |
| sys_created_on | Date et heure 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. Situé dans la table Nœud CDM \[sn_cdm_node\]. Type de données : chaîne |
| sys_updated_by | Nom d'utilisateur de l'utilisateur qui a mis à jour le nœud CDM en dernier. Par exemple, able.tuter. Type de données : chaîne |
| sys_updated_on | Date et heure auxquelles le nœud CDM a été mis à mis à jour. Format : AAAA-mm-JJ hh :mm :ss Type de données : chaîne |
| type | Type de nœud. Type de données : chaîne |
[ ]
### Demande cURL
L'exemple suivant montre comment appeler ce point de terminaison pour mettre à jour l'application \<\< App1 \>\> avec le composant partagé \<\< paymentService-V1.1 \>\> sous la bibliothèque partagée \<\< OracleG-Library-10 \>\> 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
}