--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # CdmApplicationsApi # CdmApplicationsApi {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 60 Minuten Lesedauer Die CdmApplicationsApi stellt Endpunkte bereit, mit denen Sie Konfigurationsdaten vom Typ „ zoominsoftware.io/utah-devops/" in die Ordner für Komponenten, Sammlung, bereitstellbare Elemente und Komponentenvariablen hochladen können, die sich auf der Anwenderoberfläche des Arbeitsbereichs DevOps Config befinden. Sie verfügt auch über -Endpunkte, mit denen Sie bereitstellbare Konfigurationsdaten in die -Pipeline DevOps exportieren und gemeinsam genutzte Komponenten und Anwendungen verwalten können. Die Export- und Upload-Endpunkte verwenden eine asynchrone Warteschlangenimplementierung. Bei dieser Art der Implementierung rufen Sie zuerst den gewünschten Export- oder Upload-Anforderungsendpunkt auf. Diese Endpunkte stellen Ihre Anforderung in die Warteschlange und geben einen Anforderungsbezeichner zurück. Diesen Anforderungsbezeichner verwenden Sie dann, um den entsprechenden Statusendpunkt aufzurufen (einen für Uploads und einen anderen für Exporte), um den Status des Uploads/Exports zu erhalten. Bei Exportanforderungen können Sie nach Abschluss des Exports auch den Inhalt des Exports anfordern. Diese API stellt keine Endpunkte bereit, die einen einfachen Abruf von Anwendungsdatensätzen durchführen. Verwenden Sie zum Abrufen dieser Datensätze die [Tabellen](https://www.servicenow.com/docs/g0UI3YwkkoWOS1DR2j3qWA#c_TableAPI "Die Tabellen -API bietet Endpunkte, mit denen Sie Erstellungs-, Lese-, Aktualisierungs- und Löschvorgänge (Create, Read, Update, Delete, CRUD) für vorhandene Tabellen ausführen können.") -API. Sie müssen eine der folgenden Rollen aufweisen, um auf diese API zugreifen zu können: * Scripted REST CDM View ACL (sn_cdm.cdm.viewer) * Scripted REST CDM Editor ACL (sn_cdm.cdm_editor) Außerdem muss das Plugin Konfigurationsdaten-Management (CDM) aktiviert sein, damit diese API in einer -Instanz verfügbar ist. Weitere Informationen zu Konfigurationsdaten-Management und der DevOps Config Workspace-UI finden Sie unter [Ihre Konfigurationsdaten hochladen](https://www.servicenow.com/docs/access?context=cdm-upload-process&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Weitere Informationen zu gemeinsam genutzten Komponenten und gemeinsam genutzten Bibliotheken finden Sie [unter Komponenten zwischen Anwendungen freigeben -- Komponentenbibliotheken](https://www.servicenow.com/docs/access?context=cdm-component-libraries&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). ## CdmApplicationsApi: /sn_cdm/applications/deployables löschen {#ariaid-title2} Löscht ein angegebenes bereitstellbares Element für Configuration Data Management (CDM). Der Anrufer dieses Endpunkts muss über die Rolle „CDM-Administrator" verfügen. ### URL-Format {#apps-DELETE-applications-deploys__section_tqf_h2n_qtb} URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables Standard-URL: /api/sn_cdm/applications/deployables ### Unterstützte Anforderungsparameter {#apps-DELETE-applications-deploys__entry__2}{#apps-DELETE-applications-deploys__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 1. Pfadparameter] {#apps-DELETE-applications-deploys__entry__6} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name der CDM-Anwendung, der das bereitstellbare Element zugeordnet ist. Befindet sich in der Tabelle „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge | | name | Name des zu löschenden bereitstellbaren Elements. Befindet sich in der Tabelle „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge | [Tabelle : 2. Abfrageparameter] {#apps-DELETE-applications-deploys__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 3. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-DELETE-applications-deploys__entry__16}{#apps-DELETE-applications-deploys__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 4. Anforderungskopfzeilen] {#apps-DELETE-applications-deploys__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 5. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 6. Statuscodes] ### Parameter des Antwort-Haupttexts {#apps-DELETE-applications-deploys__entry__32} | Name | Beschreibung | |-|-| | Keine | | [ ] ### cURL-Anforderung Das folgende Codebeispiel zeigt, wie ein bereitstellbares Element entfernt wird. curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ --request DELETE \ --header "Accept:application/json" \ --user 'username':'password1' Bei einer erfolgreichen Löschung des bereitstellbaren Elements wird keine andere Antwort als der HTTP-Statuscode zurückgegeben. None - results defined by the HTTP status code ## CdmApplicationsApi: /sn_cdm/applications/shared_components löschen {#ariaid-title3} Entfernt die Referenz zur Verwendung der gemeinsam genutzten Komponente aus der angegebenen CDM-Anwendung Konfigurationsdaten-Management. Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. ### URL-Format {#apps-DELETE-shared_components__section_lbh_bp1_fwb} URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/shared_components Standard-URL: /api/sn_cdm/applications/shared_components ### Unterstützte Anforderungsparameter {#apps-DELETE-shared_components__entry__2}{#apps-DELETE-shared_components__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 7. Pfadparameter] {#apps-DELETE-shared_components__entry__6}{#apps-DELETE-shared_components__changesetNumber-changeset-entry} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name der Anwendung, aus der die Zuordnung der angegebenen gemeinsam genutzten Komponente entfernt werden soll. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Für die angegebene Anwendung muss das Typfeld auf „shared_library" festgelegt sein. Datentyp: Zeichenfolge | | changesetNumber | Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10". Befindet sich in der Tabelle „CDMChangeset" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge | | SharedComponentName | Erforderlich. Eindeutiger Name der gemeinsam genutzten Komponente, die aus der angegebenen Anwendung entfernt werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente" \[sn_cdm_shared_component\]. Datentyp: Zeichenfolge | [Tabelle : 8. Abfrageparameter] {#apps-DELETE-shared_components__entry__14} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 9. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-DELETE-shared_components__entry__18}{#apps-DELETE-shared_components__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 10. Anforderungskopfzeilen] {#apps-DELETE-shared_components__entry__22} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 11. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 12. Statuscodes] ### Parameter des Antwort-Haupttexts {#apps-DELETE-shared_components__entry__34} | Name | Beschreibung | |-|-| | Ergebnis | Leer. Der HTTP-Statuscode gibt das Ergebnis des Anrufs an. | | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Codebeispiel zeigt, wie die gemeinsam genutzte Komponente „paymentService-V1.1" aus der Anwendung „App1" gelöscht wird. 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' Antwort: "" ## CdmApplicationsApi: GET /sn_cdm/applications/deployables/exports/{export_id}/content {#ariaid-title4} Gibt den Inhalt zurück, der einer angegebenen Konfigurationsdaten-Exportanforderung zugeordnet ist. Rufen Sie diesen Endpunkt nur auf, wenn Sie eine vollständige Antwort vom Endpunkt [CdmApplicationsApi: GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-deploy-exports-status "Gibt den aktuellen Status der angegebenen Konfigurationsdaten-Exportanforderung zurück.") erhalten haben. Wenn Sie diesen Endpunkt aufrufen, bevor der Export abgeschlossen ist, wird ein Statusfehler 400 zurückgegeben. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/content Standard-URL: /api/sn_cdm/applications/deployables/exports/{export_id}/content ### Unterstützte Anforderungsparameter {#apps-GET-deploy-exports-content__entry__2}{#apps-GET-deploy-exports-content__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | | export_id | Eindeutiger Bezeichner für die Exportanforderung, deren Konfigurationsdaten zurückgegeben werden sollen. Dieser Wert wird vom Endpunkt [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-POST-deploy-exports "Sendet eine Anforderung zum Exportieren des aktuellen Snapshots für eine angegebene Anwendung und mindestens ein bereitstellbares Element in die Tabelle „CDM-Exporter-Cache“ [sn_cdm_exporter_cache].") zurückgegeben. | [Tabelle : 13. Pfadparameter] {#apps-GET-deploy-exports-content__entry__8} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 14. Abfrageparameter] {#apps-GET-deploy-exports-content__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 15. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-GET-deploy-exports-content__entry__16}{#apps-GET-deploy-exports-content__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 16. Anforderungskopfzeilen] {#apps-GET-deploy-exports-content__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 17. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 18. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#apps-GET-deploy-exports-content__entry__32} | Name | Beschreibung | |-|-| | Fehler | Beschreibung der während des Exports aufgetretenen Fehler. Datentyp: Zeichenfolge | | export_id | Exportanforderungs-ID. Identisch mit dem an den Endpunkt übergebenen. Datentyp: Zeichenfolge | | exporter_result | Inhalt des angegebenen Konfigurationsdatenexports. Datentyp: * JSON-Objekt: Gibt an, ob Daten im JSON-Format exportiert werden sollen. * Zeichenfolge: Gibt an, ob Daten in einem anderen Format exportiert werden sollen. {#apps-GET-deploy-exports-content__ul_xk1_2j1_psb} | | request_id | Exportanforderungs-ID. Identisch mit dem an den Endpunkt übergebenen. Datentyp: Zeichenfolge | | Staat | Aktueller Status des angegebenen Exports. Wert aus der Statusspalte in der Tabelle „CDM-Anforderungswarteschlange" \[sn_cdm_request_queue\]. Mögliche Werte: * abgeschlossen * Fehler * in_progress * neu * Bereit Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Im folgenden Beispiel werden die Konfigurationsdaten einer Exportanforderung mit der ID 3ab14a7d53b1301096edddeeff7b12f angefordert. curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/content" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Im Folgenden sind die möglichen Rückgabeergebnisse aufgeführt. // 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} Gibt den aktuellen Status der angegebenen Konfigurationsdaten-Exportanforderung zurück. Verwenden Sie den Endpunkt [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-POST-deploy-exports "Sendet eine Anforderung zum Exportieren des aktuellen Snapshots für eine angegebene Anwendung und mindestens ein bereitstellbares Element in die Tabelle „CDM-Exporter-Cache“ [sn_cdm_exporter_cache]."), um eine Exportanforderung zu erstellen. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/status Standard-URL: /api/sn_cdm/applications/deployables/exports/{export_id}/status ### Unterstützte Anforderungsparameter {#apps-GET-deploy-exports-status__entry__2}{#apps-GET-deploy-exports-status__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | | export_id | Sys_id der Exportanforderung, deren Status zurückgegeben werden soll. Dieser Wert wird vom Endpunkt [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/exports](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-POST-deploy-exports "Sendet eine Anforderung zum Exportieren des aktuellen Snapshots für eine angegebene Anwendung und mindestens ein bereitstellbares Element in die Tabelle „CDM-Exporter-Cache“ [sn_cdm_exporter_cache].") zurückgegeben. | [Tabelle : 19. Pfadparameter] {#apps-GET-deploy-exports-status__entry__8} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 20. Abfrageparameter] {#apps-GET-deploy-exports-status__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 21. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-GET-deploy-exports-status__entry__16}{#apps-GET-deploy-exports-status__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 22. Anforderungskopfzeilen] {#apps-GET-deploy-exports-status__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 23. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 24. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#apps-GET-deploy-exports-status__entry__32} | Name | Beschreibung | |-|-| | Fehler | Beschreibung der während des Exports aufgetretenen Fehler. Datentyp: Zeichenfolge | | export_id | Exportanforderungs-ID. Identisch mit dem an den Endpunkt übergebenen. Datentyp: Zeichenfolge | | exporter_result | Details zum zugeordneten Fehler. Datentyp: Objekt | | exporter_result.errors | Beschreibung der Fehler, die während des Exports aufgetreten sind. Datentyp: Array | | exporter_result.execution_id | Eindeutiger Bezeichner für den Ausführungsdatensatz des Exporters. Befindet sich in der Tabelle sn_cdm_exporter_execution. Datentyp: Zeichenfolge | | exporter_result.state | Aktueller Status des angegebenen Exports. Befindet sich in der Tabelle sn_cdm_exporter_execution. Mögliche Werte: * Abschließen * Fehler * in_progress * neu {#apps-GET-deploy-exports-status__ul_k3z_32r_ssb} Datentyp: Zeichenfolge | | request_id | Exportanforderungs-ID. Identisch mit dem an den Endpunkt übergebenen. Datentyp: Zeichenfolge | | Staat | Aktueller Status des angegebenen Exports. Wert aus der Statusspalte in der Tabelle „CDM-Anforderungswarteschlange" \[sn_cdm_request_queue\]. Mögliche Werte: * abgeschlossen * Fehler * in_progress * neu * Bereit Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Im folgenden Beispiel wird der Status eines Exports mit der ID 3ab14a7d53b1301096edddeeff7b12f angefordert. curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Im Folgenden finden Sie die möglichen Rückgabeergebnisse. // 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} Gibt die Liste der gemeinsam genutzten Komponenten zurück, die von einer angegebenen Anwendung verwendet werden. Sie können auch festlegen, dass nur die gemeinsam genutzten Komponenten zurückgegeben werden, für die eine neue Version verfügbar ist. Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/shared_components Standard-URL: /api/sn_cdm/applications/shared_components ### Unterstützte Anforderungsparameter {#apps-GET-shared_components__entry__2}{#apps-GET-shared_components__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 25. Pfadparameter] {#apps-GET-shared_components__entry__6} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name der Anwendung, deren Liste der gemeinsam genutzten Komponenten Sie zurückgeben möchten. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Das Feld „Typ" der Anwendung muss auf „shared_library" festgelegt werden. Datentyp: Zeichenfolge | | withUpdatesOnly | Kennzeichnung, die angibt, ob nur gemeinsam genutzte Komponenten zurückgegeben werden sollen, für die eine neue aktualisierte Version verfügbar ist. Gültige Werte: * „wahr": Es werden nur gemeinsam genutzte Komponenten zurückgegeben, für die eine neue aktualisierte Version verfügbar ist. * „falsch": Gibt alle gemeinsam genutzten Komponenten zurück, die von der angegebenen Anwendung verwendet werden. Standardwert: false | [Tabelle : 26. Abfrageparameter] {#apps-GET-shared_components__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 27. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-GET-shared_components__entry__16}{#apps-GET-shared_components__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 28. Anforderungskopfzeilen] {#apps-GET-shared_components__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 29. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 30. Statuscodes] ### Parameter des Antwort-Haupttexts {#apps-GET-shared_components__entry__32} | Name | Beschreibung | |-|-| | currentVersion | Aktuelle Version der CDM-Anwendung. Datentyp: Ganzzahl | | currentVersionName | Name der derzeit verwendeten Version der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | | Beschreibung | Beschreibung der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | name | Eindeutiger Name der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | | sharedLibraryName | Name der gemeinsamen Bibliothek, zu der die gemeinsam genutzte Komponente gehört. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | updateVersionName | Name der für die Aktualisierung verfügbaren Version der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die gemeinsam genutzten Komponenten mit einer neuen Version abzurufen, die von „App1" verwendet wird. 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' Antwort: { "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} Gibt eine Übersicht über gemeinsam genutzte Komponenten und die Anwendungen zurück, die sie verwenden und die sich in einer angegebenen Bibliothek befinden. Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/shared_libraries/components/applications Standard-URL: /api/sn_cdm/applications/shared_libraries/components/applications ### Unterstützte Anforderungsparameter {#apps-GET-shared_libs-comp-apps__entry__2}{#apps-GET-shared_libs-comp-apps__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 31. Pfadparameter] {#apps-GET-shared_libs-comp-apps__entry__6} | Name | Beschreibung | |-|-| | SharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, die in die Zuordnung aufgenommen werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente" \[sn_cdm_shared_component\]. Datentyp: Zeichenfolge | | sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, die in die Zuordnung aufgenommen werden soll. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Für die angegebene Anwendung muss das Typfeld auf „shared_library" festgelegt sein. Datentyp: Zeichenfolge | [Tabelle : 32. Abfrageparameter] {#apps-GET-shared_libs-comp-apps__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 33. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-GET-shared_libs-comp-apps__entry__16}{#apps-GET-shared_libs-comp-apps__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 34. Anforderungskopfzeilen] {#apps-GET-shared_libs-comp-apps__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 35. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 36. Statuscodes] ### Parameter des Antwort-Haupttexts {#apps-GET-shared_libs-comp-apps__entry__32} | Name | Beschreibung | |-|-| | Beschreibung | Beschreibung der Anwendung, die die gemeinsam genutzte Komponente verwendet Datentyp: Zeichenfolge | | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | managed_by_group | Kommagetrennte Liste der sys_ids der Gruppen, die die Anwendung verwalten können. Datentyp: Zeichenfolge | | name | Eindeutiger Name der Anwendung, die die Komponente verwendet. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | sys_id | Sys_id der Anwendung, die die gemeinsam genutzte Komponente nutzt. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die Zuordnung abzurufen, die die Anwendungen in der gemeinsamen Bibliothek „OracleG-Library-10" anzeigt, die die gemeinsam genutzte Komponente „paymentService-V1.1" verwenden. 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' Antwort: { "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} Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück. ### URL-Format {#apps-GET-upload-status__section_isc_fy3_psb} URL mit Versionsangabe: /api/sn_cdm/{api_version}/applications/upload-status/{upload_id} Standard-URL: /api/sn_cdm/applications/upload-status/{upload_id} ### Unterstützte Anforderungsparameter {#apps-GET-upload-status__entry__2}{#apps-GET-upload-status__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung, deren Status zurückgegeben werden soll. Dieser Wert wird von den verschiedenen Endpunkten für Upload-Anforderungen in CdmApplications zurückgegeben. | [Tabelle : 37. Pfadparameter] {#apps-GET-upload-status__entry__8} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 38. Abfrageparameter] {#apps-GET-upload-status__entry__12} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 39. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-GET-upload-status__entry__16}{#apps-GET-upload-status__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 40. Anforderungskopfzeilen] {#apps-GET-upload-status__entry__20} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 41. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 42. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#apps-GET-upload-status__entry__32} | Name | Beschreibung | |-|-| | Fehler | Beschreibung der Fehler, die beim Hochladen aufgetreten sind. Datentyp: Zeichenfolge | | Ausgabe | Beschreibung der hochgeladenen Daten oder, wenn während des Uploads ein Fehler aufgetreten ist, eine Fehlermeldung, die den aufgetretenen Fehler beschreibt. Datentyp: Zeichenfolgen-Array "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" | Gibt an, ob die Validierung nach dem Commit aufgerufen werden soll. Datentyp: Zeichenfolge | | „output.cdm_application" | Name der Anwendung, unter der der Upload durchgeführt wurde. Datentyp: Zeichenfolge | | „output.committed_at" | Zeitpunkt (Datum und Uhrzeit), zu dem der hochgeladene Inhalt bestätigt wurde. Datentyp: Zeichenfolge | | „output.committed_by" | Sys_id des Datensatzes der Entität, die den Commit durchgeführt hat. Datentyp: Zeichenfolge | | Ausgabe.Beschreibung | Derzeit nicht verwendet. Datentyp: Zeichenfolge | | „output.last_conflict_detection_time" | Aufruf der Datum-/Uhrzeit-Konflikterkennung. Datentyp: Zeichenfolge | | Ausgabe.Nummer | Eindeutige Nummer des Changesets. Datentyp: Zeichenfolge | | „output.publish_option" | Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots. Gültige Werte: * veröffentlichen_none: Keine Snapshots veröffentlichen. * veröffentlichen_valid: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none Hinweis: Diese Option ist nur verfügbar, wenn der Wert für den Parameter autoCommit wahr ist. | | „output.snapshot_description" | Beschreibung des zugeordneten Snapshots. Datentyp: Zeichenfolge | | „output.snapshot_name" | Name des zugeordneten Snapshots. Datentyp: Zeichenfolge | | Ausgabe.Status | Status des Upload-Inhalts. Mögliche Werte: * blockiert * checking_for_conflict * commit_failed * commit_in_progress * committet * offen {#apps-GET-upload-status__ul_qhn_w4p_psb} Datentyp: Zeichenfolge | | „output.sys_created_by" | Sys_id der Entität, die den Datensatz erstellt hat. Datentyp: Zeichenfolge | | „output.sys_id" | Sys_id des Datensatzes, der das Changeset enthält. Datentyp: Zeichenfolge | | Ausgabe.Titel | Titel des Changesets, das als Teil des Uploads erstellt wurde. Datentyp: Zeichenfolge | | Verarbeitungsstatus | Aktueller Verarbeitungsstatus der Upload-Anforderung. Mögliche Werte: * NOT_PROCESSED * VERARBEITET {#apps-GET-upload-status__ul_gmt_2pp_psb} Datentyp: Zeichenfolge | | Staat | Aktueller Status der Upload-Anforderung. Mögliche Werte: * abgeschlossen * Fehler * in_progress * neu * Bereit {#apps-GET-upload-status__ul_ozn_bv5_xsb} | | type | Typ der Upload-Anforderung. Mögliche Werte: * Commit * export * „upload_and_commit" {#apps-GET-upload-status__ul_l5m_x55_xsb} Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Beispiel zeigt, wie der Status für einen Upload mit der ID 5560a6895326301096edddeeff7b1230 angefordert wird. curl "http://instance.servicenow.com/api/sn_cdm/applications/upload-status/5560a6895326301096edddeeff7b1230" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' Im Folgenden finden Sie die möglichen Rückgabeergebnisse. // Successful completion of the upload request { "result": { "type": "upload_and_commit", "state": "completed", "output": { "sys_id": "be681dc95362301096edddeeff7b12ba", "number": "Chset-102", "title": "admin2021-09-10 08:09:07", "description": null, "committed_at": "2021-09-10 20:23:37", "committed_by": "6816f79cc0a8016401c5a33be04be441", "sys_created_by": "admin", "state": "committed", "publish_option": "publish_none", "auto_validate": false, "snapshot_name": null, "snapshot_description": null, "cdm_application": "Demo_App1631126164773", "last_conflict_detection_time": "1631305417894" }, "processing_state": "PROCESSED", "upload_id": "5560a6895326301096edddeeff7b1230" } } // Response when an incorrect upload_id is passed. Note: Status code is 200. { "result": { "state": "error", "errors": "Invalid requestId '5560a6895326301096edddeeff7b1240'", "upload_id": "5560a6895326301096edddeeff7b1240" } } // Response when the upload encounters an error. The exporter_result array contains the error information. Note: Status code is 200. { "result": { "type": "upload_and_commit", "state": "error", "output": "Error encountered during execution of request.\nError: Node 'dbSettings' of type 'sg_cdm_node_component' cannot create child 'dbSettings' of type 'sg_cdm_node_folder'", "processing_state": "PROCESSED", "upload_id": "272f8a415326301096edddeeff7b1232" } } ## CdmApplicationsApi -- POST /sn_cdm/applications/deployables {#ariaid-title9} Erstellt ein neues bereitstellbares Element und verbindet es automatisch mit einer angegebenen Konfigurationsdaten-Management -Anwendung (CDM). Sie können ein bereitstellbares Element für einen von drei Umgebungstypen erstellen: Entwicklung, Test oder Produktion. Für den Zugriff auf diesen Endpunkt muss der Anrufer über die Rolle „CDM-Administrator" verfügen. Wenn Sie mehrere bereitstellbare Elemente erstellen müssen, verwenden Sie den Endpunkt [CdmApplicationsApi -- POST /sn_cdm/applications/deployables/create](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-POST-deploy-create "Erstellt ein oder mehrere neue bereitstellbare Elemente."). ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables Standard-URL: /api/sn_cdm/applications/deployables ### Unterstützte Anforderungsparameter {#apps-POST-applications-deploys__entry__2}{#apps-POST-applications-deploys__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 43. Pfadparameter] {#apps-POST-applications-deploys__entry__6}{#apps-POST-applications-deploys__cdm_apps-envType-entry}{#apps-POST-applications-deploys__cdm_apps-returnFields-entry} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name einer vorhandenen, aktiven CDM-Anwendung, die dem bereitstellbaren Element zugeordnet werden soll. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | envType | Erforderlich. Umgebungstyp für das bereitstellbare Element. Gültige Werte (Groß-/Kleinschreibung beachten): * Entwicklung * Produktion * Test Hinweis: Der bereitstellbare Umgebungstyp kann nach der Erstellung nicht mehr geändert werden. Datentyp: Zeichenfolge | | name | Erforderlich. Name des bereitstellbaren CDM-Elements. Darf nicht mehr als 255 Zeichen enthalten. Standardmäßig zulässige Zeichen sind 0-9, AZ, az, _,-,., %, $, Leerzeichen, :, #. Datentyp: Zeichenfolge Maximale Länge: 255 Zeichen Zulässige Zeichen: 0-9, AZ, az, _, -, ., % $, Leerzeichen, : und # | | returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt | [Tabelle : 44. Abfrageparameter] {#apps-POST-applications-deploys__entry__16} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 45. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#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} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 46. Anforderungskopfzeilen] {#apps-POST-applications-deploys__entry__26} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 47. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 48. Statuscodes] ### Parameter des Antwort-Haupttexts {#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} | Name | Beschreibung | |-|-| | cdi_count | Anzahl der Configuration Data Items (CDIs), die in der zugehörigen CDM-Anwendung enthalten sind. Datentyp: Ganzzahl | | cdi_usage | Prozentsatz der vom bereitstellbaren Element verwendeten CDIs. Datentyp: Ganzzahl | | cdm_app | CDM-Anwendungsobjekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt "cdm_app": { "link": "String", "value": "String" } | | cdm_app.link | Rufen Sie auf, um mit der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge | | cdm_app.value | Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | cdm_ci | Anwendungsservice-Objekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt "cdm_ci": { "link": "String", "value": "String" } | | cdm_ci.link | Rufen Sie auf, um mit der REST- Tabellen -API auf den Anwendungsservice-Datensatz zuzugreifen. Datentyp: Zeichenfolge | | cdm_ci.wert | Sys_id des zugeordneten Anwendungsservice-Datensatzes. Befindet sich in der Tabelle „Configuration Item" \[cmdb_ci\]. Datentyp: Zeichenfolge | | Beschreibung | Beschreibung des generierten bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge | | environment_type | Umgebungstyp des bereitstellbaren Elements. Mögliche Werte: * Entwicklung * Produktion * Test Datentyp: Zeichenfolge | | Fehler | Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | name | Name des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge | | Knoten | Details zum bereitstellbaren Knoten. Datentyp: Objekt "node": { "link": "String", "value": "String" } | | node.link | Rufen Sie auf, um mit der REST- Tabellen -API auf den Datensatz des bereitstellbaren Knotens zuzugreifen. Datentyp: Zeichenfolge | | node.value | Sys_id des bereitstellbaren Knotendatensatzes. Befindet sich in der Tabelle „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge | | Snapshot_Version_Zähler | Anzahl der für das bereitstellbare Element erstellten Snapshots. Datentyp: Ganzzahl | | Staat | Aktueller Status des bereitstellbaren Elements. Mögliche Werte: * aktiv * gelöscht Datentyp: Zeichenfolge | | sys_created_by | Anwendername des Anwenders, der das CDM-Bereitstellungselement erstellt hat. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_created_on | Datum und Uhrzeit der Erstellung des bereitstellbaren CDM-Elements. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | | sys_id | Sys_id des erstellten bereitstellbaren Elements. Befindet sich in der Tabelle „CDM -- Bereitstellbar" \[sn_cdm_deployable\]. Datentyp: Zeichenfolge | | sys_updated_by | Anwendername des Anwenders, der das CDM-Bereitstellungselement zuletzt aktualisiert hat. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des bereitstellbaren CDM-Elements. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | [ ] {#apps-POST-applications-deploys__id_dkr_tdn_qtb} ### cURL-Anforderung Das folgende Codebeispiel zeigt, wie Sie ein bereitstellbares Element erstellen und einer CDM-Anwendung zuordnen. 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' Ergebnisse zurückgeben: { "result": [ { "cmdb_ci": { "value": "f5b9e00b53901110a1d3ddeeff7b12b8", "link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8" }, "cdi_count": "0", "snapshot_version_counter": "0", "description": null, "sys_updated_on": "2022-06-29 12:53:57", "environment_type": "Test", "node": { "value": "7db9e00b53901110a1d3ddeeff7b12b6", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/7db9e00b53901110a1d3ddeeff7b12b6" }, "sys_id": "39b9e00b53901110a1d3ddeeff7b12b7", "sys_updated_by": "admin", "cdm_app": { "value": "62b517a953b70110a1d3ddeeff7b128c", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" }, "sys_created_on": "2022-06-29 12:53:57", "cdi_usage": "0", "name": "Dep-2", "state": "active", "sys_created_by": "admin" } ] } ## CdmApplicationsApi -- POST /sn_cdm/applications/deployables/create {#ariaid-title10} Erstellt ein oder mehrere neue bereitstellbare Elemente. Sie können einen von zwei Typen von bereitstellbaren Elementen erstellen: * Bereitstellbare Elemente, die manuell mit einem Anwendungsmodell (CI-Service) verbunden werden müssen. * Bereitstellbare Elemente, die automatisch mit neuen, dynamisch erstellten Anwendungsmodellen (CI-Services) verbunden werden. Sie können ein bereitstellbares Element für einen von drei Umgebungstypen erstellen: Entwicklung, Test oder Produktion. Wenn mehrere bereitstellbare Elemente erstellt werden, folgen die automatisch generierten Namen der bereitstellbaren Elemente dem folgenden Muster: `DeployableType_Number`, wobei „ `Nummer` " die laufende Sequenznummer ist, die auf der Erstellung eines neuen bereitstellbaren Elements basiert. Wenn Sie beispielsweise drei bereitstellbare Elemente vom Typ `Test` in einem Endpunktaufruf erstellen, heißen sie Test_1, Test_2 und Test_3. Wenn Sie dann den Endpunkt erneut aufrufen und ein anderes bereitstellbares Testelement erstellen, lautet der automatisch generierte Name Test_4. Diese Nummern werden nie wiederverwendet, auch wenn ein bereitstellbares Element gelöscht wird. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables/create Standard-URL: /api/sn_cdm/applications/deployables/create ### Unterstützte Anforderungsparameter {#apps-POST-deploy-create__entry__2}{#apps-POST-deploy-create__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 49. Pfadparameter] {#apps-POST-deploy-create__entry__6}{#apps-POST-deploy-create__cdm_apps-envType-entry} | Name | Beschreibung | |-|-| | appSysId | Erforderlich. Sys_id einer aktiven CDM-Anwendung, die den bereitstellbaren Elementen zugeordnet werden soll. Datentyp: Zeichenfolge | | autoConnect | Erforderlich. Kennzeichnung, die bestimmt, ob die neu erstellten bereitstellbaren Elemente automatisch mit dynamisch generierten Anwendungsmodellen verbunden werden sollen. Gültige Werte: * „wahr": Verbinden Sie die neu erstellten bereitstellbaren Elemente mit dynamisch generierten Anwendungsmodellen. * „falsch": Es werden nur die bereitstellbaren Elemente erstellt. Diese bereitstellbaren Elemente müssen manuell über die Anwenderoberfläche Anwendungsmodellen zugeordnet werden. {#apps-POST-deploy-create__ul_gdp_vwr_xsb} Datentyp: Boolesch | | envType | Erforderlich. Umgebungstyp für das bereitstellbare Element. Gültige Werte (Groß-/Kleinschreibung beachten): * Entwicklung * Produktion * Test Hinweis: Der bereitstellbare Umgebungstyp kann nach der Erstellung nicht mehr geändert werden. Datentyp: Zeichenfolge | | quantity | Erforderlich. Anzahl der zu erstellenden bereitstellbaren Elemente. Datentyp: Zahl | [Tabelle : 50. Abfrageparameter] {#apps-POST-deploy-create__entry__16} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 51. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#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} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 52. Anforderungskopfzeilen] {#apps-POST-deploy-create__entry__26} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 53. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apps-POST-deploy-create__entry__30}{#apps-POST-deploy-create__entry-200-status-code}{#apps-POST-deploy-create__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 54. Statuscodes] ### Parameter des Antwort-Haupttexts {#apps-POST-deploy-create__entry__36} | Name | Beschreibung | |-|-| | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | Ergebnis | Sys_ids der erstellten bereitstellbaren Elemente. Datentyp: Array | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Beispiel zeigt, wie Sie ein einzelnes bereitstellbares Element erstellen und einer vorhandenen CDM-Anwendung zuordnen. 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' Im Folgenden finden Sie die möglichen Antworten auf diese Anruf, sowohl als Erfolg als auch als Fehler. // 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/deployables/exports {#ariaid-title11} Sendet eine Anforderung zum Exportieren des aktuellen Snapshots für eine angegebene Anwendung und mindestens ein bereitstellbares Element in die Tabelle „CDM-Exporter-Cache" \[sn_cdm_exporter_cache\]. Dieser Endpunkt gibt einen eindeutigen Bezeichner für die Anforderung zurück, den Sie dann zum Aufrufen des Endpunkts [CdmApplicationsApi: GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-deploy-exports-status "Gibt den aktuellen Status der angegebenen Konfigurationsdaten-Exportanforderung zurück.") verwenden, um den Status des Exports abzurufen. Sobald der Export abgeschlossen ist, können Sie den Endpunkt [CdmApplicationsApi: GET /sn_cdm/applications/deployables/exports/{export_id}/content](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-deploy-exports-content "Gibt den Inhalt zurück, der einer angegebenen Konfigurationsdaten-Exportanforderung zugeordnet ist.") verwenden, um die Konfigurationsdaten der zugehörigen Anwendung abzurufen. Ein Snapshot ist das vollständige Datenmodell eines bereitstellbaren Elements zum Zeitpunkt, zu dem eine Konfigurationsänderung committet wird. Dies umfasst alle enthaltenen Komponenten, Sammlungen und Vars sowie bereitstellbare spezifische Vars und Überschreibungen. Weitere Informationen zu bereitstellbaren Elementen finden Sie unter Bereitstellbares Element [erstellen und aktualisieren](https://www.servicenow.com/docs/access?context=cdm-deployable-define&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Hinweis: Snapshots dürfen 10.000 Configuration Data Items (CDIs) pro bereitstellbarem Element oder 100.000 CDIs pro Anwendung nicht überschreiten. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables/exports Standard-URL: /api/sn_cdm/applications/deployables/exports ### Unterstützte Anforderungsparameter {#apps-POST-deploy-exports__entry__2}{#apps-POST-deploy-exports__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 55. Pfadparameter] {#apps-POST-deploy-exports__entry__6} | Name | Beschreibung | |-|-| | zusätzliche bereitstellbare Elemente | Nicht primäre bereitstellbare Elemente für Export von. Datentyp: Array von Objekten "additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ] Beispiel: `[{'app_name':'TestApp', "deployable_name:'DEP-1'}]` Standard: Leeres Array -- \[\] | | Zusätzliche bereitstellbare Elemente.app_name | Erforderlich, wenn das Array additionalDeployables angegeben ist. Name der Anwendung, die dem bereitstellbaren Element zugeordnet ist, dessen Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge | | zusätzlicheDeployables.deployable_name | Erforderlich, wenn das Array additionalDeployables angegeben ist. Name des nicht primären bereitstellbaren Elements, dessen Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge | | appName | Erforderlich. Name der Anwendung, deren Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge | | args | Ein JSON-Objekt, das Schlüssel-Wert-Paare für anwenderdefinierte Argumenteenthält. Datentyp: Objekt | | dataFormat | Ausgabeformat der exportierten Daten Gültige Werte (Groß-/Kleinschreibung beachten): * ini * json * Eigenschaften * unformatiert (Daten werden im Zeichenfolgenformat zurückgegeben) * XML * YAML Datentyp: Zeichenfolge Standard: json | | bereitstellbarerName | Erforderlich. Name des bereitstellbaren Elements, dessen Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge | | exporterName | Erforderlich. Name des Exporters, der zum Exportieren der Snapshot-Daten verwendet werden soll. Exporter sind für den Implementierer anwenderdefiniert. Weitere Informationen zum Erstellen eines anwenderdefinierten Exporters finden [Sie unter Anwenderdefinierten Exporter erstellen](https://www.servicenow.com/docs/access?context=cdm-exporter-create-custom&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge | | einschränkenExport | Kennzeichnung, die angibt, ob der Endpunkt Snapshots beim Exportieren der Daten validiert. Gültige Werte: * „wahr": Snapshots validieren. * „falsch": Snapshots werden nicht validiert. Datentyp: Boolesch Standardwert: false | | snapshotName | Name des zu exportierenden Snapshots. Dies kann nur einer der Snapshot-Namen sein, die dem in deployableName oder additionalDeployables.deployable_nameangegebenen bereitstellbaren Element zugeordnet sind. Standard: Der Endpunkt exportiert den zuletzt veröffentlichten Snapshot. Wenn kein veröffentlichter Snapshot vorhanden ist, gibt das System den Fehler „Aktueller veröffentlichter Snapshot für bereitstellbares Element ‚{0}' wurde nicht gefunden" aus. | [Tabelle : 56. Abfrageparameter] {#apps-POST-deploy-exports__entry__28} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 57. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#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} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. | [Tabelle : 58. Anforderungskopfzeilen] {#apps-POST-deploy-exports__entry__38} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 59. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apps-POST-deploy-exports__entry__42}{#apps-POST-deploy-exports__entry-200-status-code}{#apps-POST-deploy-exports__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Fehlermeldungen: * Fehler: Erforderlicher Parameter „appName" fehlt. * Fehler: Anwender verfügt nicht über die erforderliche Berechtigung zum Erstellen einer Exportanforderung * Fehler: Ungültiger boolescher Wert (\ ). | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 60. Statuscodes] ### Parameter des Antwort-Haupttexts {#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} | Name | Beschreibung | |-|-| | Fehler | Details zum aufgetretenen Fehler. "error": { "detail": "String", "message": "String" } Datentyp: Array | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | export_id | Eindeutiger Bezeichner der Exportanforderung. Verwenden Sie diese ID, wenn Sie den -Endpunkt [CdmApplicationsApi: GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-deploy-exports-status "Gibt den aktuellen Status der angegebenen Konfigurationsdaten-Exportanforderung zurück.") aufrufen, um den aktuellen Status der Exportanforderung zu überprüfen. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Im folgenden Beispiel wird der Export der Konfigurationsdaten für Folgendes angefordert: Anwendungsname = TestAppA, Name des bereitstellbaren Elements = DEP, Exporteur = 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' Gibt den eindeutigen Bezeichner der Exportanforderung zurück. { "result": { "export_id": "64b5f79f5379301096edddeeff7b12eb" } } ## CdmApplicationsApi -- POST /sn_cdm/applications/shared_components {#ariaid-title12} Ordnet die angegebene gemeinsam genutzte Komponente der Anwendung innerhalb eines angegebenen Changesets zu. Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. Hinweis: Der angegebenen gemeinsam genutzten Komponente muss eine veröffentlichte Version (Snapshot) zugeordnet sein. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/shared_components Standard-URL: /api/sn_cdm/applications/shared_components ### Unterstützte Anforderungsparameter {#apps-POST-shared_components__entry__2}{#apps-POST-shared_components__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 61. Pfadparameter] {#apps-POST-shared_components__entry__6}{#apps-POST-shared_components__cdm_apps-returnFields-entry} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name der Anwendung, die der gemeinsam genutzten Komponente zugeordnet werden soll. Datentyp: Zeichenfolge | | changesetNumber | Erforderlich. Eindeutiger Bezeichner des Changesets, das der Komponente zugeordnet ist. Datentyp: Zeichenfolge | | returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt | | SharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, die der angegebenen Anwendung zugeordnet werden soll. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente" \[sn_cdm_shared_component\]. Datentyp: Zeichenfolge | | sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, unter der die Komponente erstellt werden soll. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. In der gemeinsamen Bibliothek müssen die folgenden Felder wie folgt definiert sein: * Status = Aktiv * Verfügbar = Wahr * Typ = Shared_library Datentyp: Zeichenfolge | [Tabelle : 62. Abfrageparameter] {#apps-POST-shared_components__entry__18} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 63. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-POST-shared_components__entry__22}{#apps-POST-shared_components__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 64. Anforderungskopfzeilen] {#apps-POST-shared_components__entry__26} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 65. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apps-POST-shared_components__entry__30}{#apps-POST-shared_components__entry-200-status-code}{#apps-POST-shared_components__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Das übergebene Changeset ist nicht vorhanden. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 66. Statuscodes] ### Parameter des Antwort-Haupttexts Die Antwortfelder hängen davon ab, welche Felder im Parameter returnFields in der Anforderung angegeben wurden. Im Folgenden werden einige der wichtigeren Felder beschrieben. {#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} | Name | Beschreibung | |-|-| | changeset_id | Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" } | | changeset_id.link | Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge | | changeset_id.value | Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge | | Beschreibung | Beschreibung des CDM-Knotens. Datentyp: Zeichenfolge | | Fehler | Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Meldung, die eine Übersicht über den Fehler bietet. Datentyp: Zeichenfolge | | linked_to | ID des Hauptknotens, der der gemeinsam genutzten Komponente zugeordnet ist. Datentyp: Zeichenfolge | | linked_to_version | Details des CDM-Snapshot-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "linked_to_version": { "link": "String", "value": "String" } | | linked_to_version.link | Rufen Sie die Syntax zum Abfragen dieses Versionsdatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge | | linked_to_version.value | Sys_id des Versionsdatensatzes. Datentyp: Zeichenfolge | | Haupt | Kennzeichnung, die angibt, ob der zugeordnete Snapshot veröffentlicht wurde. Gültige Werte: * wahr: Snapshot wurde veröffentlicht. * „falsch": Snapshot wurde nicht veröffentlicht. | | main_id | Eindeutige ID des neu erstellten Hauptknotens. Datentyp: Zeichenfolge | | main_id_encoded | Codierte ID des neu erstellten Hauptknotens. Datentyp: Zeichenfolge | | name | Name des CDM-Knotens. Datentyp: Zeichenfolge | | Knoten | Sys_id des Knotens der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | | node_path | Pfad zum neuen verknüpften Knoten, der beim Hinzufügen der gemeinsam genutzten Komponente erstellt wird. Datentyp: Zeichenfolge | | status | Status des Knotens. Mögliche Werte: Neu Datentyp: Zeichenfolge | | sys_created_by | Anwendername des Anwenders, der den CDM-Knoten erstellt. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_created_on | Datum und Uhrzeit der Erstellung des CDM-Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | | sys_id | Sys_id des Knotens. Befindet sich in der Tabelle „CDM-Knoten" \[sn_cdm_node\]. Datentyp: Zeichenfolge | | sys_updated_by | Anwendername des Anwenders, der den CDM-Knoten zuletzt aktualisiert hat. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des CDM-Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | | type | Knotentyp. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die Anwendung „App1" der gemeinsam genutzten Komponente „paymentService-V1.1" in der gemeinsamen Bibliothek „OracleG-Library-10" im Changeset „Chset-20" zuzuordnen. 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' Antwort: { "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} Sendet eine Anforderung zum Hochladen der übergebenen Konfigurationsdaten für eine bestimmte Komponente im Systemkomponentenordner für die angegebene Anwendung. Dieser Endpunkt gibt die ID der Upload-Anforderung zurück. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Hinweis: Die maximale Standardgröße für Uploads beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft sn_cdm.max_allowed_upload_file_size aktualisieren. Die folgende Abbildung zeigt ein Beispiel dafür, wo die Komponentenkonfigurationsdaten in Referenz zur ServiceNow DevOps Config -UI hochgeladen werden. Angenommen, die Komponente ist „dbComponent" und die Anwendung „paymentSvc"ist. Hinweis: Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die alternative Methode , um Knoten zu ändern. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/uploads/components Standard-URL: /api/sn_cdm/applications/uploads/components ### Unterstützte Anforderungsparameter {#apps-POST-uploads-components__entry__2}{#apps-POST-uploads-components__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 67. Pfadparameter] {#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} | Name | Beschreibung | |-|-| | appName | Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „Aktiv" befinden. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | autoCommit | Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Hochladen für das Datenmodell übernommen wird. Gültige Werte: * „wahr": Changeset wird nach dem Hochladen committet. * „falsch": Changeset wird nach dem Hochladen nicht committet. Datentyp: Boolesch Standardwert: false | | autoDelete | Kennzeichnung, die angibt, ob die vorhandenen Knoten, die nicht Teil des Upload-Inhalts sind, nach Abschluss der Verarbeitung gelöscht werden. Gültige Werte: * „wahr": Vorhandene Knoten werden automatisch gelöscht. * „falsch": Vorhandene Knoten werden nicht automatisch gelöscht. Datentyp: Boolesch Standardwert: false | | autoValidate | Kennzeichnung, die angibt, ob die beim Committen erstellten Snapshots validiert sind. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. Hinweis: Diese Option ist nur verfügbar, wenn der Parameter autoCommitauf truefestgelegt ist. Datentyp: Boolesch Standardwert: false | | changesetNumber | Zeichenfolge, die das der Anwendung zugeordnete [Changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) eindeutig identifiziert, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen" befinden. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil der [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") -Ergebnisse zurückgegeben. | | dataFormat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte: * CSV * ini * json * Eigenschaften * roh * XML * YAML Datentyp: Zeichenfolge | | dataFormatAttributes | Wird nur unterstützt, wenn der Parameter dataFormat auf csvfestgelegt ist. Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter [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). Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | Kennzeichnung, die angibt, ob die Daten eine Headerzeile enthalten. Gültige Werte: * „wahr": Daten enthalten eine Headerzeile. Die erste Zeile in den Daten wird als Headerzeile betrachtet. * false: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen im Parameter dataFormatAttributes.headers übergeben. Datentyp: Boolesch Standardwert: false | | dataFormatAttributes.delimeter | Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet wird. Datentyp: Zeichenfolge Standard: Komma "," | | dataFormatAttributes.headers | Erforderlich, wenn Parameter dataFormatAttributes.containsHeaders auf „ false" festgelegt ist. Felder in den Daten, aus denen der Header besteht. Diese Header werden in die Schlüsselnamen der CDIs im JSON-Format konvertiert. Die Anzahl der Header muss mit der Anzahl der Datensatzfelder übereinstimmen. Datentyp: Array Standard: Leeres Array | | dataFormatAttributes.secureHeaders | Felder in den Daten, die sichere Felder sind und in den in CDMhochgeladenen Daten verschlüsselt werden müssen. Der Name der gesicherten Header muss mit dem Namen der Header im Header-Attribut oder in der Datendatei übereinstimmen. Diese Felder werden in einer Spalte vom Typ „Passwort" (zweifach verschlüsselt) gespeichert. Hinweis: Sie können nur Felder mit diesem Attribut sichern. Sie können die Sicherung der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array | | deleteRedundantOverrides | Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, wenn redundante Werte vorhanden sind. Gültige Werte: * wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. * false: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standardwert: true | | fileName | Name der hochzuladenden Datei Dieser Name kann vom tatsächlichen Dateinamen abweichen und die Dateierweiterung enthalten. Beispiel: .txt/.scv/.jar. Der Wert für „fileName" wird beim Herunterladen der Datei angewendet. Datentyp: Zeichenfolge | | Dateiknotenname | Name des Dateiknotens. Dieser Dateiname wird beim Exportieren in den Konfigurationsdaten verwendet. Dieser Name erfordert keine Dateierweiterung und wirkt sich auch nicht auf den Download aus. Datentyp: Zeichenfolge | | IdentifierKeys | Liste von Namen, die angeben, welcher Schlüssel in einem untergeordneten Array-Array zum Identifizieren desselben Knotens verwendet werden soll. Beispiel: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] und wenn Sie identifierKeys auf den Namenfestlegen, erzeugt dies die folgende Ausgabe: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Andernfalls wird die folgende Ausgabe erzeugt: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Datentyp: Array von Zeichenfolgen | | ignoriertAttribute | Kennzeichnung, die angibt, ob das angegebene Datenformat Attribute unterstützt (derzeit nur XML). Gültige Werte: * „wahr": Wenn das angegebene Datenformat Attribute unterstützt, werden Attribute in den Eingabedaten während des Uploads übersprungen. * „falsch": Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten in den Upload einbezogen. {#apps-POST-uploads-components__ul_egn_4q4_1yb} Datentyp: Boolesch Standardwert: false | | namePath | Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt). Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`zu definieren, gehen Sie wie folgt vor: * Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/") enthält, können Sie dieses Format nicht verwenden. * Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬Development1cdi1 * Array: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components__cdm_apps-namePath-ul} Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System sie automatisch im angegebenen Pfad und lädt dann die Daten hoch. Datentyp: Zeichenfolge | | sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die zu löschende Komponente befindet. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | [Tabelle : 68. Abfrageparameter] {#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} | Name | Beschreibung | |-|-| | Variable zum Hochladen von Daten | Konfigurationsdaten zum Hochladen. Dies können beliebige Daten in dem Format sein, die durch den Parameter dataFormat der Abfrageparameter definiert werden. | [Tabelle : 69. Anforderungstextparameter (XML oder JSON)] {#apps-POST-uploads-components__id_lx4_bvh_psb} ### Header Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-POST-uploads-components__id_trg_k25_2wb__entry__2}{#apps-POST-uploads-components__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: text/plain und application/x-www-form-urlencoded. Standard: text/plain | [Tabelle : 70. Anforderungskopfzeilen.] {#apps-POST-uploads-components__id_trg_k25_2wb} {#apps-POST-uploads-components__entry__54} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 71. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Anforderung zum Hochladen wurde abgelehnt. Mögliche Probleme: * Die Größe der Konfigurationsnutzlast ist größer als der zulässige Höchstwert -- standardmäßig 2 MB. * Erforderliche Parameter fehlen im Aufruf. {#apps-POST-uploads-components__ul_kmn_gkh_psb} | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 72. Statuscodes] {#apps-POST-uploads-components__id_vvq_4wh_psb} ### Parameter des Antworttexts (JSON oder 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} | Name | Beschreibung | |-|-| | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Datentyp: Zeichenfolge | [ ] {#apps-POST-uploads-components__id_b4z_nwh_psb} ### cURL-Anforderung Das folgende Beispiel zeigt eine Upload-Anforderung für die Anwendung Demo_App1631126164773. 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' Die folgenden Rückgabeergebnisse zeigen sowohl eine erfolgreiche als auch eine fehlerhafte Antwort für diese Anforderung. // 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} Sendet eine Anforderung zum Hochladen der übergebenen Konfigurationsdaten im Ordner „vars" im Ordner „Systemkomponenten" für die angegebene Anwendung. Die folgende Abbildung zeigt ein Beispiel dafür, wo die vars-Konfigurationsdaten der Komponente in Referenz zur ServiceNow DevOps Config Workspace-UI hochgeladen werden. Angenommen, die Anwendung ist paymentSvc. Hinweis: Die maximale Standardgröße für Uploads beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft sn_cdm.max_allowed_upload_file_size aktualisieren. ### URL-Format {#apps-POST-uploads-components-var__section_xgv_syh_psb} URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/uploads/components/vars Standard-URL: /api/sn_cdm/applications/uploads/components/vars ### Unterstützte Anforderungsparameter {#apps-POST-uploads-components-var__entry__2}{#apps-POST-uploads-components-var__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 73. Pfadparameter] {#apps-POST-uploads-components-var__id_ey4_w13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-dataFormat-row} | Name | Beschreibung | |-|-| | appName | Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „Aktiv" befinden. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | autoCommit | Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Hochladen für das Datenmodell übernommen wird. Gültige Werte: * „wahr": Changeset wird nach dem Hochladen committet. * „falsch": Changeset wird nach dem Hochladen nicht committet. Datentyp: Boolesch Standardwert: false | | autoDelete | Kennzeichnung, die angibt, ob die vorhandenen Knoten, die nicht Teil des Upload-Inhalts sind, nach Abschluss der Verarbeitung gelöscht werden. Gültige Werte: * „wahr": Vorhandene Knoten werden automatisch gelöscht. * „falsch": Vorhandene Knoten werden nicht automatisch gelöscht. Datentyp: Boolesch Standardwert: false | | autoValidate | Kennzeichnung, die angibt, ob die beim Committen erstellten Snapshots validiert sind. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. Hinweis: Diese Option ist nur verfügbar, wenn der Parameter autoCommitauf truefestgelegt ist. Datentyp: Boolesch Standardwert: false | | changesetNumber | Zeichenfolge, die das der Anwendung zugeordnete [Changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) eindeutig identifiziert, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen" befinden. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil der [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") -Ergebnisse zurückgegeben. | | dataFormat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte: * ini * json * Eigenschaften * roh * XML * YAML Datentyp: Zeichenfolge | | deleteRedundantOverrides | Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, wenn redundante Werte vorhanden sind. Gültige Werte: * wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. * false: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standardwert: true | | fileName | Name der hochzuladenden Datei Dieser Name kann vom tatsächlichen Dateinamen abweichen und die Dateierweiterung enthalten. Beispiel: .txt/.scv/.jar. Der Wert für „fileName" wird beim Herunterladen der Datei angewendet. Datentyp: Zeichenfolge | | Dateiknotenname | Name des Dateiknotens. Dieser Dateiname wird beim Exportieren in den Konfigurationsdaten verwendet. Dieser Name erfordert keine Dateierweiterung und wirkt sich auch nicht auf den Download aus. Datentyp: Zeichenfolge | | IdentifierKeys | Liste von Namen, die angeben, welcher Schlüssel in einem untergeordneten Array-Array zum Identifizieren desselben Knotens verwendet werden soll. Beispiel: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] und wenn Sie identifierKeys auf den Namenfestlegen, erzeugt dies die folgende Ausgabe: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Andernfalls wird die folgende Ausgabe erzeugt: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Datentyp: Array von Zeichenfolgen | | ignoriertAttribute | Kennzeichnung, die angibt, ob das angegebene Datenformat Attribute unterstützt (derzeit nur XML). Gültige Werte: * „wahr": Wenn das angegebene Datenformat Attribute unterstützt, werden Attribute in den Eingabedaten während des Uploads übersprungen. * „falsch": Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten in den Upload einbezogen. {#apps-POST-uploads-components-var__ul_egn_4q4_1yb} Datentyp: Boolesch Standardwert: false | | namePath | Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt). Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`zu definieren, gehen Sie wie folgt vor: * Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/") enthält, können Sie dieses Format nicht verwenden. * Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬Development1cdi1 * Array: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components-var__cdm_apps-namePath-ul} Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System sie automatisch im angegebenen Pfad und lädt dann die Daten hoch. Datentyp: Zeichenfolge | | sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, in der sich die zu löschende Komponente befindet. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | [Tabelle : 74. Abfrageparameter] {#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} | Name | Beschreibung | |-|-| | Variable zum Hochladen von Daten | Konfigurationsdaten zum Hochladen. Dies können beliebige Daten in dem Format sein, die durch den Parameter dataFormat der Abfrageparameter definiert werden. | [Tabelle : 75. Anforderungstextparameter (XML oder JSON)] {#apps-POST-uploads-components-var__id_x4h_y13_psb} ### Header Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-POST-uploads-components-var__id_cvs_bmb_fwb__entry__2}{#apps-POST-uploads-components-var__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: text/plain und application/x-www-form-urlencoded. Standard: text/plain | [Tabelle : 76. Anforderungskopfzeilen.] {#apps-POST-uploads-components-var__id_cvs_bmb_fwb} {#apps-POST-uploads-components-var__entry__44} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 77. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Anforderung zum Hochladen wurde abgelehnt. Mögliche Probleme: * Die Größe der Konfigurationsnutzlast ist größer als der zulässige Höchstwert -- standardmäßig 2 MB. * Erforderliche Parameter fehlen im Aufruf. {#apps-POST-uploads-components-var__ul_kmn_gkh_psb} | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 78. Statuscodes] {#apps-POST-uploads-components-var__id_dqr_z13_psb} ### Parameter des Antworttexts (JSON oder 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} | Name | Beschreibung | |-|-| | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Datentyp: Zeichenfolge | [ ] {#apps-POST-uploads-components-var__id_pcq_1b3_psb} ### cURL-Anforderung Das folgende Beispiel zeigt eine Vars-Upload-Anforderung für die Anwendung Demo_App1631126164773. curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/vars?changesetNumber=Chset-102&autoValidate=false&autoDelete=true&publishOption=publish_none&appName=Demo_App1631126164773&namePath=%2FSettings%2FdbSettings&autoCommit=false&dataFormat=json" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "{ \"dbSettings\": { \"dbIPAddress\": \"10.10.10.110\", \"dbPort\": \"8080\", \"dbConnectionString\": \"username:password server1.xyz.com:8080 dbName_payments\", \"dbConnectionStringBackup\": \"username:password server2.xyz.com dbName_payments_backup\" } }" --user 'username':'password' Die folgenden Rückgabeergebnisse zeigen sowohl eine erfolgreiche als auch eine fehlerhafte Antwort für diese Anforderung. // Successful completion of the upload request { "result": { "upload_id": "d21f71f45322301096eccceaff7b1ce3" } } // Error response. Payload is too large. { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi -- POST /sn_cdm/applications/uploads/collections {#ariaid-title15} Sendet eine Anforderung zum Hochladen der übergebenen Konfigurationsdaten für eine bestimmte Sammlung im Systemsammlungsordner für die angegebene Anwendung. Dieser Endpunkt gibt die ID der Upload-Anforderung zurück. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Hinweis: Die maximale Standardgröße für Uploads beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft sn_cdm.max_allowed_upload_file_size aktualisieren. Die folgende Abbildung zeigt ein Beispiel dafür, wo die Konfigurationsdaten in Bezug auf die ServiceNow DevOps Config Workspace-UI hochgeladen werden. Angenommen, die Sammlung ist „db0Release1.0" und die Anwendung „paymentSvc"ist. Hinweis: Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die alternative Methode , um Knoten zu ändern. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/uploads/collections Standard-URL: /api/sn_cdm/applications/uploads/collections ### Unterstützte Anforderungsparameter {#apps-POST-uploads-collections__entry__2}{#apps-POST-uploads-collections__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 79. Pfadparameter] {#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} | Name | Beschreibung | |-|-| | appName | Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „Aktiv" befinden. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | autoCommit | Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Hochladen für das Datenmodell übernommen wird. Gültige Werte: * „wahr": Changeset wird nach dem Hochladen committet. * „falsch": Changeset wird nach dem Hochladen nicht committet. Datentyp: Boolesch Standardwert: false | | autoDelete | Kennzeichnung, die angibt, ob die vorhandenen Knoten, die nicht Teil des Upload-Inhalts sind, nach Abschluss der Verarbeitung gelöscht werden. Gültige Werte: * „wahr": Vorhandene Knoten werden automatisch gelöscht. * „falsch": Vorhandene Knoten werden nicht automatisch gelöscht. Datentyp: Boolesch Standardwert: false | | autoValidate | Kennzeichnung, die angibt, ob die beim Committen erstellten Snapshots validiert sind. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. Hinweis: Diese Option ist nur verfügbar, wenn der Parameter autoCommitauf truefestgelegt ist. Datentyp: Boolesch Standardwert: false | | changesetNumber | Zeichenfolge, die das der Anwendung zugeordnete [Changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) eindeutig identifiziert, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen" befinden. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil der [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") -Ergebnisse zurückgegeben. | | collectionName | Erforderlich. Name der Sammlung, unter der die hochgeladene Nutzlast gespeichert werden soll. Hinweis: Wenn das angegebene namePath in dieser Sammlung nicht vorhanden ist, erstellt das System automatisch die Komponente(n) in dieser Sammlung und lädt dann den Konfigurationsinhalt hoch. Wenn Sie beispielsweise die Sammlung `collA`mit dem Pfad `CompA/comp/compC`hochladen möchten, werden die Daten unter `/collA/collections/compa/compB/compC hochgeladen`. Wenn `CompA` vorhanden ist, jedoch nicht `CompB` und `CompC`, erstellt der Endpunkt diese Komponenten und lädt die Daten unter `CompC hoch`. Datentyp: Zeichenfolge | | dataFormat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte: * CSV * ini * json * Eigenschaften * roh * XML * YAML Datentyp: Zeichenfolge | | dataFormatAttributes | Wird nur unterstützt, wenn der Parameter dataFormat auf csvfestgelegt ist. Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter [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). Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | Kennzeichnung, die angibt, ob die Daten eine Headerzeile enthalten. Gültige Werte: * „wahr": Daten enthalten eine Headerzeile. Die erste Zeile in den Daten wird als Headerzeile betrachtet. * false: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen im Parameter dataFormatAttributes.headers übergeben. Datentyp: Boolesch Standardwert: false | | dataFormatAttributes.delimeter | Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet wird. Datentyp: Zeichenfolge Standard: Komma "," | | dataFormatAttributes.headers | Erforderlich, wenn Parameter dataFormatAttributes.containsHeaders auf „ false" festgelegt ist. Felder in den Daten, aus denen der Header besteht. Diese Header werden in die Schlüsselnamen der CDIs im JSON-Format konvertiert. Die Anzahl der Header muss mit der Anzahl der Datensatzfelder übereinstimmen. Datentyp: Array Standard: Leeres Array | | dataFormatAttributes.secureHeaders | Felder in den Daten, die sichere Felder sind und in den in CDMhochgeladenen Daten verschlüsselt werden müssen. Der Name der gesicherten Header muss mit dem Namen der Header im Header-Attribut oder in der Datendatei übereinstimmen. Diese Felder werden in einer Spalte vom Typ „Passwort" (zweifach verschlüsselt) gespeichert. Hinweis: Sie können nur Felder mit diesem Attribut sichern. Sie können die Sicherung der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array | | deleteRedundantOverrides | Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, wenn redundante Werte vorhanden sind. Gültige Werte: * wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. * false: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standardwert: true | | ignoriertAttribute | Kennzeichnung, die angibt, ob das angegebene Datenformat Attribute unterstützt (derzeit nur XML). Gültige Werte: * „wahr": Wenn das angegebene Datenformat Attribute unterstützt, werden Attribute in den Eingabedaten während des Uploads übersprungen. * „falsch": Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten in den Upload einbezogen. {#apps-POST-uploads-collections__ul_egn_4q4_1yb} Datentyp: Boolesch Standardwert: false | | namePath | Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt). Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`zu definieren, gehen Sie wie folgt vor: * Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/") enthält, können Sie dieses Format nicht verwenden. * Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬Development1cdi1 * Array: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-collections__cdm_apps-namePath-ul} Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System sie automatisch im angegebenen Pfad und lädt dann die Daten hoch. Datentyp: Zeichenfolge | [Tabelle : 80. Abfrageparameter] {#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} | Name | Beschreibung | |-|-| | Variable zum Hochladen von Daten | Konfigurationsdaten zum Hochladen. Dies können beliebige Daten in dem Format sein, die durch den Parameter dataFormat der Abfrageparameter definiert werden. | [Tabelle : 81. Anforderungstextparameter (XML oder JSON)] {#apps-POST-uploads-collections__id_afd_233_psb} ### Header Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-POST-uploads-collections__id_h4r_fmb_fwb__entry__2}{#apps-POST-uploads-collections__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: text/plain und application/x-www-form-urlencoded. Standard: text/plain | [Tabelle : 82. Anforderungskopfzeilen.] {#apps-POST-uploads-collections__id_h4r_fmb_fwb} {#apps-POST-uploads-collections__entry__48} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 83. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Anforderung zum Hochladen wurde abgelehnt. Mögliche Probleme: * Die Größe der Konfigurationsnutzlast ist größer als der zulässige Höchstwert -- standardmäßig 2 MB. * Erforderliche Parameter fehlen im Aufruf. {#apps-POST-uploads-collections__ul_kmn_gkh_psb} | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 84. Statuscodes] {#apps-POST-uploads-collections__id_szz_f33_psb} ### Parameter des Antworttexts (JSON oder 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} | Name | Beschreibung | |-|-| | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Datentyp: Zeichenfolge | [ ] {#apps-POST-uploads-collections__id_i55_g33_psb} ### cURL-Anforderung Dieses Beispiel zeigt, wie ein JSON-formatiertes Konfigurationsdatum dbSettings in den Sammlungsordner für die Anwendung Demo_App1631126164773 hochgeladen wird. 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' Im Folgenden finden Sie die möglichen Antworten auf diese Anruf, sowohl als Erfolg als auch als Fehler. // 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} Sendet eine Anforderung zum Hochladen des Konfigurationsinhalts für ein bestimmtes bereitstellbares Element im Systemordner für bereitstellbare Elemente einer angegebenen Anwendung. Dieser Endpunkt gibt die ID der Upload-Anforderung zurück. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Hinweis: Die maximale Standardgröße für Uploads beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft sn_cdm.max_allowed_upload_file_size aktualisieren. Die folgende Abbildung zeigt ein Beispiel dafür, wo die bereitstellbaren Konfigurationsdaten in Referenz zur ServiceNow DevOps Config -UI hochgeladen werden. Angenommen, das bereitstellbare Element ist Development_1 und die Anwendung ist paymentSvc. Hinweis: Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die alternative Methode , um Knoten zu ändern. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/uploads/deployables Standard-URL: /api/sn_cdm/applications/uploads/deployables ### Unterstützte Anforderungsparameter {#apps-POST-uploads-deployables__entry__2}{#apps-POST-uploads-deployables__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 85. Pfadparameter] {#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} | Name | Beschreibung | |-|-| | appName | Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „Aktiv" befinden. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. Datentyp: Zeichenfolge | | autoCommit | Kennzeichnung, die angibt, ob das im Parameter changesetNumber identifizierte Changeset nach dem Hochladen für das Datenmodell übernommen wird. Gültige Werte: * „wahr": Changeset wird nach dem Hochladen committet. * „falsch": Changeset wird nach dem Hochladen nicht committet. Datentyp: Boolesch Standardwert: false | | autoDelete | Kennzeichnung, die angibt, ob die vorhandenen Knoten, die nicht Teil des Upload-Inhalts sind, nach Abschluss der Verarbeitung gelöscht werden. Gültige Werte: * „wahr": Vorhandene Knoten werden automatisch gelöscht. * „falsch": Vorhandene Knoten werden nicht automatisch gelöscht. Datentyp: Boolesch Standardwert: false | | autoValidate | Kennzeichnung, die angibt, ob die beim Committen erstellten Snapshots validiert sind. Gültige Werte: * „wahr": Validiert die Snapshots. * „falsch": Die Snapshots werden nicht validiert. Hinweis: Diese Option ist nur verfügbar, wenn der Parameter autoCommitauf truefestgelegt ist. Datentyp: Boolesch Standardwert: false | | changesetNumber | Zeichenfolge, die das der Anwendung zugeordnete [Changeset](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US) eindeutig identifiziert, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen" befinden. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil der [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") -Ergebnisse zurückgegeben. | | dataFormat | Erforderlich. Format der Konfigurationsdaten. Gültige Werte: * CSV * ini * json * Eigenschaften * roh * XML * YAML Datentyp: Zeichenfolge | | dataFormatAttributes | Wird nur unterstützt, wenn der Parameter dataFormat auf csvfestgelegt ist. Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter [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). Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | Kennzeichnung, die angibt, ob die Daten eine Headerzeile enthalten. Gültige Werte: * „wahr": Daten enthalten eine Headerzeile. Die erste Zeile in den Daten wird als Headerzeile betrachtet. * false: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen im Parameter dataFormatAttributes.headers übergeben. Datentyp: Boolesch Standardwert: false | | dataFormatAttributes.delimeter | Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet wird. Datentyp: Zeichenfolge Standard: Komma "," | | dataFormatAttributes.headers | Erforderlich, wenn Parameter dataFormatAttributes.containsHeaders auf „ false" festgelegt ist. Felder in den Daten, aus denen der Header besteht. Diese Header werden in die Schlüsselnamen der CDIs im JSON-Format konvertiert. Die Anzahl der Header muss mit der Anzahl der Datensatzfelder übereinstimmen. Datentyp: Array Standard: Leeres Array | | dataFormatAttributes.secureHeaders | Felder in den Daten, die sichere Felder sind und in den in CDMhochgeladenen Daten verschlüsselt werden müssen. Der Name der gesicherten Header muss mit dem Namen der Header im Header-Attribut oder in der Datendatei übereinstimmen. Diese Felder werden in einer Spalte vom Typ „Passwort" (zweifach verschlüsselt) gespeichert. Hinweis: Sie können nur Felder mit diesem Attribut sichern. Sie können die Sicherung der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array | | deleteRedundantOverrides | Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, wenn redundante Werte vorhanden sind. Gültige Werte: * wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. * false: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standardwert: true | | bereitstellbarerName | Erforderlich. Name des bereitstellbaren Elements, unter dem die hochgeladene Nutzlast gespeichert werden soll. Hinweis: Wenn der angegebene namePath unter diesem bereitstellbaren Element nicht vorhanden ist, erstellt das System automatisch die Komponente(n) unter diesem bereitstellbaren Element und lädt dann den Konfigurationsinhalt hoch. | | IdentifierKeys | Liste von Namen, die angeben, welcher Schlüssel in einem untergeordneten Array-Array zum Identifizieren desselben Knotens verwendet werden soll. Beispiel: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] und wenn Sie identifierKeys auf den Namenfestlegen, erzeugt dies die folgende Ausgabe: [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] Andernfalls wird die folgende Ausgabe erzeugt: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Datentyp: Array von Zeichenfolgen | | ignoriertAttribute | Kennzeichnung, die angibt, ob das angegebene Datenformat Attribute unterstützt (derzeit nur XML). Gültige Werte: * „wahr": Wenn das angegebene Datenformat Attribute unterstützt, werden Attribute in den Eingabedaten während des Uploads übersprungen. * „falsch": Wenn das angegebene Datenformat Attribute unterstützt, werden alle Attribute in den Eingabedaten in den Upload einbezogen. {#apps-POST-uploads-deployables__ul_egn_4q4_1yb} Datentyp: Boolesch Standardwert: false | | namePath | Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad ist relativ zu den Komponenten, der Sammlung oder dem bereitstellbaren Ordner (abhängig vom aufgerufenen Endpunkt). Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`zu definieren, gehen Sie wie folgt vor: * Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/") enthält, können Sie dieses Format nicht verwenden. * Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬Development1cdi1 * Array: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-deployables__cdm_apps-namePath-ul} Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System sie automatisch im angegebenen Pfad und lädt dann die Daten hoch. Datentyp: Zeichenfolge | | VeröffentlichenOption | Veröffentlichungsoption für die zugeordneten konfigurierten Snapshots. Gültige Werte: * veröffentlichen_none: Keine Snapshots veröffentlichen. * veröffentlichen_valid: Es werden nur die Snapshots veröffentlicht, die nach dem Commit validiert wurden. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Snapshots [veröffentlichen oder Veröffentlichung aufheben](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=xanadu&pubname=xanadu-it-service-management&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Publisher_none Hinweis: Diese Option ist nur verfügbar, wenn der Wert für den Parameter autoCommit wahr ist. | [Tabelle : 86. Abfrageparameter] {#apps-POST-uploads-deployables__id_njw_zv3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-var_up_data-entry} | Name | Beschreibung | |-|-| | Variable zum Hochladen von Daten | Konfigurationsdaten zum Hochladen. Dies können beliebige Daten in dem Format sein, die durch den Parameter dataFormat der Abfrageparameter definiert werden. | [Tabelle : 87. Anforderungstextparameter (XML oder JSON)] {#apps-POST-uploads-deployables__id_njw_zv3_psb} ### Header Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-POST-uploads-deployables__id_ilq_dmb_fwb__entry__2}{#apps-POST-uploads-deployables__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | | Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: text/plain und application/x-www-form-urlencoded. Standard: text/plain | [Tabelle : 88. Anforderungskopfzeilen.] {#apps-POST-uploads-deployables__id_ilq_dmb_fwb} {#apps-POST-uploads-deployables__entry__52} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 89. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#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} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Anforderung zum Hochladen wurde abgelehnt. Mögliche Probleme: * Die Größe der Konfigurationsnutzlast ist größer als der zulässige Höchstwert -- standardmäßig 2 MB. * Erforderliche Parameter fehlen im Aufruf. {#apps-POST-uploads-deployables__ul_kmn_gkh_psb} | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 90. Statuscodes] {#apps-POST-uploads-deployables__id_gty_cw3_psb} ### Parameter des Antworttexts (JSON oder 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} | Name | Beschreibung | |-|-| | Fehler | Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge | | status | Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge | | „upload_id" | Sys_id der Upload-Anforderung. Verwenden Sie diese ID, um den Endpunkt [CdmApplicationsApi -- GET /sn_cdm/applications/upload-status/{upload_id}](https://www.servicenow.com/docs/AVmbtqeQ~VvH5wUOJt_Cmg#apps-GET-upload-status "Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.") aufzurufen und den Status des Uploads zu erhalten. Datentyp: Zeichenfolge | [ ] {#apps-POST-uploads-deployables__id_gcv_2w3_psb} ### cURL-Anforderung Das folgende Beispiel zeigt eine Upload-Anforderung für die Anwendung Demo_App1631126164773. 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' Die folgenden Rückgabeergebnisse zeigen sowohl eine erfolgreiche als auch eine fehlerhafte Antwort für diese Anforderung. // 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/deployables {#ariaid-title17} Aktualisiert die angegebene gemeinsam genutzte Komponente in einer Anwendung innerhalb eines angegebenen Changesets. Ermöglicht eine Aktualisierung der folgenden Felder: * Name * Beschreibung * Anwendungsservice\\Dynamische CI-Gruppe * Bereitstellbarer Bezeichner {#apps-PUT-application_deployables__ul_dgk_lzh_qxb} Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/deployables Standard-URL: /api/sn_cdm/applications/deployables ### Unterstützte Anforderungsparameter {#apps-PUT-application_deployables__entry__2} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 91. Pfadparameter] {#apps-PUT-application_deployables__entry__6} | Name | Beschreibung | |-|-| | appName | Erforderlich. Name der CDM-Anwendung. Datentyp: Zeichenfolge | | name | Erforderlich. Name des bereitstellbaren Elements für CDM. Datentyp: Zeichenfolge | | newDescription | Optional. Eine Beschreibung für das bereitstellbare Element für CDM. Datentyp: Zeichenfolge | | neueServiceId | Optional. Die ID des gewünschten Anwendungsservice/der dynamischen CI-Gruppe. Geben Sie in der cURL-Anforderung `„"` an, um das bereitstellbare Element vom Service zu trennen. | | newIdentifier | Optional. Der Bezeichner des bereitstellbaren Elements. Datentyp: Auswahl (Entwicklung/Test/Produktion) | | neuerName | Optional. Der neue Name des bereitstellbaren Elements. Datentyp: Zeichenfolge | | returnFields | Optional. Kommagetrennte Liste von Feldern, die als Teil der Antwort zurückgegeben werden sollen. | [Tabelle : 92. Abfrageparameter] {#apps-PUT-application_deployables__entry__22} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 93. Anforderungstextparameter (XML oder JSON)] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-PUT-application_deployables__entry__26} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json | [Tabelle : 94. Anforderungskopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apps-PUT-application_deployables__entry__30} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 95. Statuscodes] ### Parameter des Antworttexts (JSON oder XML) {#apps-PUT-application_deployables__entry__38} | Name | Beschreibung | |-|-| | sys_id | CDM -- sys_Id des bereitstellbaren Elements | | name | Name des bereitstellbaren Elements für CDM. | | Knoten | Bereitstellbares Knotenobjekt. `{ 'Wert': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` | | Beschreibung | Beschreibung der CDM-Bereitstellungskomponente. | | Kennung | Ein Bezeichner für das bereitstellbare Element. | | cmdb_ci | Das App-Service-Objekt, das mit einem bereitstellbaren Element verbunden ist. `{ 'Wert': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` | | cmdb_app | Das CDM-Anwendungsobjekt. `{ 'Wert': ' ', 'link': 'http://localhost:8081/api/now/table/*'}` | | Snapshot_Version_Zähler | Anzahl der Snapshots, die für ein bereitstellbares Element erstellt wurden. | | cdi_count | Die Anzahl der CDIs, die in diesem CDM-Bereitstellungselement enthalten sind. | | cdi_usage | Prozentsatz der CDI-Nutzung. | | environment_type | Der Umgebungstyp. Mögliche Werte: * Entwicklung * Produktion * testen {#apps-PUT-application_deployables__ul_y2w_5c3_qxb} | | Staat | Status „Aktiv" oder „Gelöscht". . Mögliche Werte: * aktiv * gelöscht {#apps-PUT-application_deployables__ul_cth_wc3_qxb} | | sys_created_by | Bereitstellbares CDM-Element erstellt von\ . | | sys_created_on | CDM-Zeitstempel für die Erstellung des bereitstellbaren Elements im Format\ . | | sys_updated_by | Bereitstellbares CDM-Element aktualisiert von\ . | | sys_updated_on | Bereitstellbares CDM aktualisiert durch Zeitstempel im Format\ . | [ ] ### cURL-Anforderung curl "http://localhost:8080/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ --request PUT\ --header "Accept:application/json" \ --user 'cdm_admin':'password1!' Ausgabe: { "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} Aktualisiert die angegebene gemeinsam genutzte Komponente in einer Anwendung innerhalb eines angegebenen Changesets. Für den Zugriff auf diesen Endpunkt ist die Rolle „CDM-Administrator" erforderlich. ### URL-Format URL mit Versionsnummer: /api/sn_cdm/{api_version}/applications/shared_components Standard-URL: /api/sn_cdm/applications/shared_components ### Unterstützte Anforderungsparameter {#apps-PUT-shared_components__entry__2}{#apps-PUT-shared_components__version-RESTAPI} | Name | Beschreibung | |-|-| | api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge | [Tabelle : 96. Pfadparameter] {#apps-PUT-shared_components__entry__6}{#apps-PUT-shared_components__cdm_apps-returnFields-entry} | Name | Beschreibung | |-|-| | changesetNumber | Erforderlich. Eindeutiger Bezeichner des Changesets, das der Komponente zugeordnet ist. Datentyp: Zeichenfolge | | returnFields | Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt | | SharedComponentName | Erforderlich. Name der gemeinsam genutzten Komponente, die der angegebenen Anwendung zugeordnet ist. Befindet sich in der Tabelle „Gemeinsam genutzte CDM-Komponente" \[sn_cdm_shared_component\]. Datentyp: Zeichenfolge | | sharedLibraryName | Erforderlich. Name der gemeinsamen Bibliothek, unter der sich die Komponente befindet. Befindet sich in der Tabelle „CDM-Anwendung" \[sn_cdm_application\]. In der gemeinsamen Bibliothek müssen die folgenden Felder wie folgt definiert sein: * Status = Aktiv * Verfügbar = Wahr * Typ = Shared_library Datentyp: Zeichenfolge | | Version | Erforderlich. Versionsname, der der gemeinsam genutzten Komponente zugeordnet ist. Befindet sich in der CDM-Snapshot-Tabelle \[sn_cdm_snapshot\]. Datentyp: Zeichenfolge | [Tabelle : 97. Abfrageparameter] {#apps-PUT-shared_components__entry__18} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 98. Anforderungstextparameter] ### Kopfzeilen Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter [Unterstützte REST API-Header](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apps-PUT-shared_components__entry__22}{#apps-PUT-shared_components__accept-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json | [Tabelle : 99. Anforderungskopfzeilen] {#apps-PUT-shared_components__entry__26} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 100. Antwortkopfzeilen] ### Statuscodes Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apps-PUT-shared_components__entry__30}{#apps-PUT-shared_components__entry-200-status-code}{#apps-PUT-shared_components__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Ungültige Anforderung. Das übergebene Changeset ist nicht vorhanden. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 101. Statuscodes] ### Parameter des Antwort-Haupttexts Die Antwortfelder hängen davon ab, welche Felder im Parameter returnFields in der Anforderung angegeben wurden. Im Folgenden werden einige der wichtigeren Felder beschrieben. {#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} | Name | Beschreibung | |-|-| | changeset_id | Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" } | | changeset_id.link | Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge | | changeset_id.value | Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz" \[sn_cdm_changeset\]. Datentyp: Zeichenfolge | | Beschreibung | Beschreibung des CDM-Knotens. Datentyp: Zeichenfolge | | Fehler | Wird nur zurückgegeben, wenn während der Verarbeitung ein Fehler aufgetreten ist. Datentyp: Objekt "error": { "detail": "String", "message": "String" } | | Fehler.detail | Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge | | Fehlernachricht | Meldung, die eine Übersicht über den Fehler bietet. Datentyp: Zeichenfolge | | linked_to | ID des Hauptknotens, der der gemeinsam genutzten Komponente zugeordnet ist. Datentyp: Zeichenfolge | | linked_to_version | Details des CDM-Snapshot-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "linked_to_version": { "link": "String", "value": "String" } | | linked_to_version.link | Rufen Sie die Syntax zum Abfragen dieses Versionsdatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge | | linked_to_version.value | Sys_id des Versionsdatensatzes. Datentyp: Zeichenfolge | | Haupt | Kennzeichnung, die angibt, ob der zugeordnete Snapshot veröffentlicht wurde. Gültige Werte: * wahr: Snapshot wurde veröffentlicht. * „falsch": Snapshot wurde nicht veröffentlicht. | | main_id | Eindeutige ID des neu erstellten Hauptknotens. Datentyp: Zeichenfolge | | main_id_encoded | Codierte ID des neu erstellten Hauptknotens. Datentyp: Zeichenfolge | | name | Name des CDM-Knotens. Datentyp: Zeichenfolge | | Knoten | Sys_id des Knotens der gemeinsam genutzten Komponente. Datentyp: Zeichenfolge | | node_path | Pfad zum neuen verknüpften Knoten, der beim Hinzufügen der gemeinsam genutzten Komponente erstellt wird. Datentyp: Zeichenfolge | | status | Status des Knotens. Mögliche Werte: Neu Datentyp: Zeichenfolge | | sys_created_by | Anwendername des Anwenders, der den CDM-Knoten erstellt. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_created_on | Datum und Uhrzeit der Erstellung des CDM-Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | | sys_id | Sys_id des Knotens. Befindet sich in der Tabelle „CDM-Knoten" \[sn_cdm_node\]. Datentyp: Zeichenfolge | | sys_updated_by | Anwendername des Anwenders, der den CDM-Knoten zuletzt aktualisiert hat. Beispiel: able.tuter. Datentyp: Zeichenfolge | | sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des CDM-Knotens. Format: JJJJ-mm-TT hh:mm:ss Datentyp: Zeichenfolge | | type | Knotentyp. Datentyp: Zeichenfolge | [ ] ### cURL-Anforderung Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die Anwendung „App1" mit der gemeinsam genutzten Komponente „paymentService-V1.1" unter der gemeinsamen Bibliothek „OracleG-Library-10" im Changeset „Chset-20" zu aktualisieren. "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' Antwort: "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 }