CdmAnwendungenApi

Die CdmAnwendungenApi Stellt Endpunkte bereit, die Ihnen ermöglichen Uploadzoominsoftware.io/utah-devops/ Konfigurationsdaten für die Ordner „Komponente“, „Sammlung“, „bereitstellbares Element“ und „Komponentenvariablen“, die in gefunden wurden DevOps ConfigArbeitsbereich-UI. Es verfügt auch über Endpunkte, mit denen Sie bereitstellbare Konfigurationsdaten in exportieren können DevOpsLeiten Sie gemeinsam genutzte Komponenten und gemeinsam genutzte Anwendungen ab, und verwalten Sie sie.

Die Export- und Upload-Endpunkte verwenden eine asynchrone Warteschlangenimplementierung. Bei dieser Art von Implementierung rufen Sie zuerst den gewünschten Endpunkt für Export- oder Upload-Anforderungen an. Diese Endpunkte stellen Ihre Anforderung in die Warteschlange und geben einen Anforderungsbezeichner zurück. Sie verwenden dann diesen Anforderungsbezeichner, um den entsprechenden Statusendpunkt aufzurufen, einen für Uploads und einen anderen für Exporte, um den Status des Uploads/Exports abzurufen. 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 Tabelle API.

Sie müssen über eine der folgenden Rollen verfügen, um auf diese API zuzugreifen:

• Geskriptete REST-CDM-Zugriffssteuerungsliste anzeigen (sn_cdm.cdm.Viewer)
• Geskriptete REST-CDM-Editor-ACL (sn_cdm.cdm_Editor)

Darüber hinaus wird Konfigurationsdaten-Management(CDM) Plugin muss aktiviert sein, damit diese API in einer Instanz verfügbar ist.

Für zusätzliche Informationen zu Konfigurationsdaten-ManagementUnd DevOps ConfigArbeitsbereich-UI, siehe Ihre Konfigurationsdaten werden hochgeladen .

Weitere Informationen zu gemeinsam genutzten Komponenten und gemeinsam genutzten Bibliotheken finden Sie unter Freigeben von Komponenten zwischen Anwendungen – Komponentenbibliotheken .

CdmApplicationsApi: LÖSCHEN SIE /sn_cdm/Applications/proviyables

Löscht ein angegebenes bereitstellbares Element für Konfigurationsdatenverwaltung (Configuration Data Management, CDM).

Der Aufrufer dieses Endpunkts muss über die CDM-Administratorrolle verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der CDM-Anwendung, der das bereitstellbare Element zugeordnet ist. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
name	Name des bereitzustellbaren Elements, das gelöscht werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]

Tabelle : 3. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 4. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.

Tabelle : 5. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

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' 

Für eine erfolgreiche Löschung des bereitstellbaren Elements wird keine andere Antwort als der HTTP-Statuscode zurückgegeben.

None - results defined by the HTTP status code

CdmApplicationsApi: LÖSCHEN SIE /sn_cdm/Applications/Shared_components

Entfernt die Nutzungsreferenz der gemeinsam genutzten Komponente aus einem angegebenen Konfigurationsdaten-Management(CDM)-Anwendung.

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Shared_components

Standard-URL: /api/sn_cdm/Applications/Shared_components

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 7. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der Anwendung, aus der die angegebene Zuordnung der gemeinsam genutzten Komponente entfernt werden soll. Für die angegebene Anwendung muss das Typfeld auf „Shared_Library“ festgelegt sein. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
SharedComponentName	Erforderlich. Eindeutiger Name der gemeinsam genutzten Komponente, die aus der angegebenen Anwendung entfernt werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_shared_component]

Tabelle : 9. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 10. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 11. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
Ergebnis	Leer. Der HTTP-Statuscode gibt das Ergebnis des Aufrufs an.
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/content AB

Gibt den Inhalt zurück, der einer angegebenen Konfigurationsdaten-Exportanforderung zugeordnet ist.

Rufen Sie diesen Endpunkt erst an, wenn Sie einen erhalten haben Abgeschlossen Antwort von CdmApplicationsApi – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/Status ABEndpunkt. Wenn Sie diesen Endpunkt aufrufen, bevor der Export abgeschlossen ist, wird ein Statusfehler 400 zurückgegeben.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente/Exporte/{Export_ID}/content

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente/Exporte/{Export_ID}/content

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 13. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 von zurückgegeben CdmApplicationsApi – POST /sn_cdm/Applications/proviyables/ExportsEndpunkt.

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 16. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.

Tabelle : 17. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Beschreibung der beim Export aufgetretenen Fehler. Datentyp: Zeichenfolge
Export_ID	Exportanforderungs-ID. Identisch mit dem, der an den Endpunkt übergeben wurde. Datentyp: Zeichenfolge
exporteur_Ergebnis	Inhalt des angegebenen Konfigurationsdatenexports. Datentyp: JSON-Objekt: Wenn die Anforderung das Exportieren von Daten im JSON-Format war. Zeichenfolge: Wenn die Anforderung den Export von Daten in einem anderen Format war.
request_id	Exportanforderungs-ID. Identisch mit dem, der an den Endpunkt übergeben wurde. Datentyp: Zeichenfolge
Staat	Aktueller Status des angegebenen Exports. Mögliche Werte: Abgeschlossen error in_progress neu Bereit Datentyp: Zeichenfolge Tabelle: Spalte „in Status“ der Tabelle „CDM-Anforderungswarteschlange“ [sn_cdm_request_queue].

Curl-Anforderung

Das folgende Beispiel fordert die Konfigurationsdaten einer Exportanforderung mit der ID 3ab14a7d53b1301096edddeeff7b12f an.

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

Im Folgenden werden die möglichen Rückgabeergebnisse angezeigt.

// 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 – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/Status AB

Gibt den aktuellen Status der angegebenen Konfigurationsdaten-Exportanforderung zurück.

Verwenden Sie CdmApplicationsApi – POST /sn_cdm/Applications/proviyables/ExportsEndpunkt zum Stellen einer Exportanforderung.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente/Exporte/{Export_ID}/Status

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente/Exporte/{Export_ID}/Status

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 19. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 von zurückgegeben CdmApplicationsApi – POST /sn_cdm/Applications/proviyables/ExportsEndpunkt.

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 22. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.

Tabelle : 23. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Beschreibung der beim Export aufgetretenen Fehler. Datentyp: Zeichenfolge
Export_ID	Exportanforderungs-ID. Identisch mit dem, der an den Endpunkt übergeben wurde. Datentyp: Zeichenfolge
exporteur_Ergebnis	Details zum zugehörigen Fehler. Datentyp: Objekt
exporter_result.error	Beschreibung der Fehler, die beim Export aufgetreten sind. Datentyp: Array
exporteur_Ergebnis.Ausführung_ID	Eindeutiger Bezeichner für den Exporter-Ausführungsdatensatz. Datentyp: Zeichenfolge Tabelle: CDM-Exporteur-Ausführung [sn_cdm_exporter_execution]
exporter_result.State	Aktueller Status des angegebenen Exports. Mögliche Werte: Abschließen Fehler in_progress neu Datentyp: Zeichenfolge Tabelle: CDM-Exporteur-Ausführung [sn_cdm_exporter_execution]
request_id	Exportanforderungs-ID. Identisch mit dem, der an den Endpunkt übergeben wurde. Datentyp: Zeichenfolge
Staat	Aktueller Status des angegebenen Exports. Mögliche Werte: Abgeschlossen error in_progress neu Bereit Datentyp: Zeichenfolge Tabelle: Spalte „in Status“ der Tabelle „CDM-Anforderungswarteschlange“ [sn_cdm_request_queue].

Curl-Anforderung

Das folgende Beispiel fordert den Status eines Exports mit der ID 3ab14a7d53b1301096edddeeff7b12f an.

curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \ 
--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": { 
    "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 AB

Gibt die Liste der gemeinsam genutzten Komponenten zurück, die von einer angegebenen Anwendung verwendet werden. Sie können auch angeben, dass nur die gemeinsam genutzten Komponenten zurückgegeben werden sollen, für die eine neue Version verfügbar ist.

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Shared_components

Standard-URL: /api/sn_cdm/Applications/Shared_components

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 25. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der Anwendung, deren Liste der gemeinsam genutzten Komponenten zurückgegeben werden soll. Das Typfeld der Anwendung muss auf Shared_Library festgelegt werden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
MitAktualisierenOnly	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: Gibt nur gemeinsam genutzte Komponenten zurück, 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. Standard: Falsch

Tabelle : 27. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 28. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 29. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
currentVersion	Aktuelle Version der CDM-Anwendung. Datentyp: Zahl (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" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 Version der gemeinsam genutzten Komponente, die zum Aktualisieren verfügbar ist. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um die gemeinsam genutzten Komponenten abzurufen, die eine neue Version haben, 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

Gibt eine Zuordnung der gemeinsam genutzten Komponenten und der Anwendungen zurück, die sie verwenden, die sich in einer angegebenen Bibliothek befinden.

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Shared_Libraries/components/Applications

Standard-URL: /api/sn_cdm/Applications/Shared_Libraries/components/Applications

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 31. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 32. Abfrageparameter

Name	Beschreibung
SharedComponentName	Erforderlich. Name der gemeinsam genutzten Komponente, die in die Zuordnung aufgenommen werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_shared_component]
sharedLibraryName	Erforderlich. Name der gemeinsamen Bibliothek, die in die Zuordnung aufgenommen werden soll. Für die angegebene Anwendung muss das Typfeld auf „Shared_Library“ festgelegt sein. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]

Tabelle : 33. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 34. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 35. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
Beschreibung	Beschreibung der Anwendung, die eine 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" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 verwendet. 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}

Gibt den aktuellen Status der angegebenen Anforderung zum Hochladen von Konfigurationsdaten zurück.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Upload-Status/{Upload_ID}

Standard-URL: /api/sn_cdm/Applications/Upload-Status/{Upload_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 37. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 der CdmApplications-Upload-Anforderung zurückgegeben.

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 39. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 40. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.

Tabelle : 41. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 42. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

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: Array von Zeichenfolge "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	Datum und Uhrzeit der Commit des hochgeladenen Inhalts. Datentyp: Zeichenfolge
output.committed_by	SYS_ID des Datensatzes der Entität, die den Commit ausgeführt hat. Datentyp: Zeichenfolge
output.description	Derzeit nicht verwendet. Datentyp: Zeichenfolge
output.last_conflict_detection_time	Aufruf der Konflikterkennung für Datum und Uhrzeit. Datentyp: Zeichenfolge
Ausgabe.Nummer	Eindeutige Nummer des Changesets. Datentyp: Zeichenfolge
Ausgabe.Publish_Option	Veröffentlichungsoption für die zugehörigen konfigurierten Snapshots. Gültige Werte: Publish_none: Veröffentlichen Sie keine Snapshots. Publish_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen oder heben Sie die Veröffentlichung eines Snapshots auf . Datentyp: Zeichenfolge Standard: Publish_none Hinweis: Diese Option ist nur verfügbar, wenn der Wert für autoCommitParameter ist „wahr“.
Ausgabe.Snapshot_description	Beschreibung des zugeordneten Snapshots. Datentyp: Zeichenfolge
Ausgabe.Snapshot_Name	Name des zugeordneten Snapshots. Datentyp: Zeichenfolge
Ausgabe.Status	Status des Upload-Inhalts. Mögliche Werte: Blockiert Check_for_conflict Commit_failed Commit_in_Progress Bestätigt offen Datentyp: Zeichenfolge
Ausgabe.sys_created_by	SYS_ID der Entität, die den Datensatz erstellt hat. Datentyp: Zeichenfolge
Ausgabe.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
Processing_State	Aktueller Verarbeitungsstatus der Upload-Anforderung. Mögliche Werte: NICHT_VERARBEITET VERARBEITET Datentyp: Zeichenfolge
Staat	Aktueller Status der Upload-Anforderung. Mögliche Werte: Abgeschlossen error in_progress neu Bereit
Typ	Typ der Upload-Anforderung. Mögliche Werte: Commit Upload_and_Commit Datentyp: Zeichenfolge
Upload_ID	SYS_ID der Upload-Anforderung. Verwenden Sie diese ID, um anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt die Anforderung des Status für einen Upload mit der ID 5560a6895326301096edddeeff7b1230.

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

Im Folgenden sind die möglichen Rückgabeergebnisse aufgeführt.

// 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/proviyables

Erstellt ein neues bereitstellbares Element und verbindet es automatisch mit einem angegebenen Konfigurationsdaten-Management(CDM)-Anwendung.

Sie können ein bereitstellbares Element für einen der drei Umgebungstypen erstellen: Entwicklung, Test oder Produktion.

Für den Zugriff auf diesen Endpunkt muss der Anrufer über die CDM-Administratorrolle verfügen.

Wenn Sie mehrere bereitstellbare Elemente erstellen müssen, verwenden Sie CdmApplicationsApi – POST /sn_cdm/Applications/proviyables/createEndpunkt.

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente

Unterstützte Anforderungsparameter

Tabelle : 43. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 44. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name einer vorhandenen, aktiven CDM-Anwendung, die dem bereitstellbaren Element zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
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 geändert werden. Datentyp: Zeichenfolge
name	Erforderlich. Name des bereitstellbaren CDM. Darf nicht länger als 255 Zeichen sein. Standardmäßig zulässige Zeichen sind 0–9, A–Z, a–z, _,-,., %, $, Leerzeichen, :, #. Datentyp: Zeichenfolge Maximale Länge: 255 Zeichen Zulässige Zeichen: 0–9, A–Z, a–z, _, -, ., %, $, Leerzeichen, :, und #
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder Status. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt

Tabelle : 45. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 46. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Nur unterstützt application/json.

Tabelle : 47. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 48. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
cdi_count	Anzahl der Konfigurationsdatenelemente (CDIs), die in der zugehörigen CDM-Anwendung enthalten sind. Datentyp: Zahl (Ganzzahl)
cdi_usage	Prozentsatz der CDIs, die vom bereitstellbaren Element verwendet werden. Datentyp: Zahl (Ganzzahl)
cdm_App	CDM-Anwendungsobjekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt "cdm_app": { "link": "String", "value": "String" }
cdm_App.Link	Aufruf zur Verwendung für den Zugriff auf den CDM-Anwendungsdatensatz mit dem REST Tabelle API. Datentyp: Zeichenfolge
cdm_App.value	SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
cdm_ci	Anwendungsserviceobjekt, das dem bereitstellbaren Element zugeordnet ist. Datentyp: Objekt "cdm_ci": { "link": "String", "value": "String" }
cdm_ci.Link	Aufruf zur Verwendung für den Zugriff auf den Anwendungsservice-Datensatz mit dem REST Tabelle API. Datentyp: Zeichenfolge
cdm_ci.value	SYS_ID des zugehörigen Anwendungsservice-Datensatzes. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci]
Beschreibung	Beschreibung des generierten bereitstellbaren CDM. 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" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
name	Name des bereitstellbaren CDM. Datentyp: Zeichenfolge
Knoten	Details zum bereitstellbaren Knoten. Datentyp: Objekt "node": { "link": "String", "value": "String" }
Node.Link	Aufruf zur Verwendung für den Zugriff auf den Datensatz des bereitstellbaren Knotens mit dem REST Tabelle API. Datentyp: Zeichenfolge
Knoten.Wert	SYS_ID des Datensatzes des bereitstellbaren Knotens. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
Snapshot_Version_Counter	Anzahl der Snapshots, die für das bereitstellbare Element erstellt wurden. Datentyp: Zahl (Ganzzahl)
Staat	Aktueller Status des bereitstellbaren Elements. Mögliche Werte: aktiv gelöscht Datentyp: Zeichenfolge
sys_created_by	Anwendername des Anwenders, der das bereitstellbare CDM erstellt hat. Beispiel: Able.tuter. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss
sys_id	SYS_ID des erstellten bereitstellbaren Elements. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
sys_updated_by	Anwendername des Anwenders, der das bereitstellbare CDM zuletzt aktualisiert hat. Beispiel: Able.tuter. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des bereitstellbaren CDM-Elements. Datentyp: Zeichenfolge Format: JJJJ-mm-TT hh:mm:ss

Wellung Anforderung

Das folgende Codebeispiel zeigt, wie ein bereitstellbares Element erstellt und einer CDM-Anwendung zugeordnet wird.

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/proviyables/create

Erstellt mindestens ein neues bereitstellbares Element.

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 der drei Umgebungstypen erstellen: Entwicklung, Test oder Produktion.Beim Erstellen mehrerer bereitstellbarer Elemente folgen die automatisch generierten Namen der bereitstellbaren Elemente dem Muster: Bereitstellbarer Typ_Nummer , Wo Nummer Ist eine laufende Sequenznummer basierend auf der Erstellung eines neuen bereitstellbaren Elements. Beispiel: Wenn Sie drei bereitstellbare Elemente vom Typ erstellen Testen In einem Endpunktaufruf werden sie Test_1, Test_2 und Test_3 genannt. Wenn Sie den Endpunkt dann 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

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/proviyables/create

Standard-URL: /api/sn_cdm/Applications/proviyables/create

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 49. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 50. Abfrageparameter

Name	Beschreibung
appSysId	Erforderlich. SYS_ID einer aktiven CDM-Anwendung, die den bereitstellbaren Elementen zugeordnet werden soll. Datentyp: Zeichenfolge
Automatische Verbindung herstellen	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: Erstellen Sie einfach die bereitstellbaren Elemente. Diese bereitstellbaren Elemente müssen über die Anwenderoberfläche manuell Anwendungsmodellen zugeordnet werden. Datentyp: Boolescher Wert
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 geändert werden. Datentyp: Zeichenfolge
quantity	Erforderlich. Anzahl der zu erstellenden bereitstellbaren Elemente. Datentyp: Zahl

Tabelle : 51. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 52. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Nur unterstützt application/json.

Tabelle : 53. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 54. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 ein einzelnes bereitstellbares Element erstellt und mit einer vorhandenen CDM-Anwendung verknüpft wird.

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 werden die möglichen Antworten auf diesen Anruf angezeigt, 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/proviyables/Exports

Sendet eine Anforderung zum Exportieren des aktuellen Snapshots für eine angegebene Anwendung und mindestens ein bereitstellbares Element in die Tabelle „CDM-Exporteur-Cache“ [sn_cdm_exporter_cache].

Dieser Endpunkt gibt einen eindeutigen Bezeichner für die Anforderung zurück, den Sie dann zum Aufrufen von verwenden CdmApplicationsApi – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/Status ABEndpunkt zum Abrufen des Status des Exports. Sobald der Export abgeschlossen ist, können Sie verwenden CdmApplicationsApi – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/content ABEndpunkt zum Abrufen der Konfigurationsdaten der zugeordneten Anwendung.

Ein Snapshot ist das vollständige Datenmodell eines bereitstellbaren Elements zum Zeitpunkt des Commits einer Konfigurationsänderung. Dies umfasst alle enthaltenen Komponenten, Sammlungen und Vars sowie bereitstellbare spezifische Vars und Überschreibungen. Weitere Informationen zu bereitstellbaren Elementen finden Sie unter Erstellen und aktualisieren Sie ein bereitstellbares Element .

Hinweis:

Snapshots dürfen 10.000 Konfigurationsdatenelemente (Configuration Data Items, CDIs) pro bereitstellbarem Element oder 100.000 CDIs pro Anwendung nicht überschreiten.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente/Exporte

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente/Exporte

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 55. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 56. Abfrageparameter

Name	Beschreibung
Zusätzlich bereitstellbare Elemente	Nicht primäre bereitstellbare Elemente zum Exportieren. Datentyp: Array von Objekten "additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ] Beispiel: [{'App_Name':'TestApp', "bereitstellbarer_Name:'DEP-1'}] Standard: Leeres Array – []
AdditionalDeployables.App_Name	Erforderlich, wenn additionalDeployablesArray ist angegeben. Name der Anwendung, die dem bereitstellbaren Element zugeordnet ist, dessen Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge
additionalDeployables.deployable_name	Erforderlich, wenn additionalDeployablesArray ist angegeben. 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 Argumente enthält. Datentyp: Objekt
Datenformat	Ausgabeformat der exportierten Daten. Gültige Werte (Groß-/Kleinschreibung beachten): ini json Eigenschaften Rohdaten (Daten werden im Zeichenfolgenformat zurückgegeben) XML yaml Datentyp: Zeichenfolge Standard: json
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren Elements, dessen Konfigurationsdaten Sie exportieren möchten. Datentyp: Zeichenfolge
ExporterName	Erforderlich. Name des Exporter, der zum Exportieren der Snapshot-Daten verwendet werden soll. Exporter sind für den Implementierer anwenderdefiniert. Details zum Erstellen eines anwenderdefinierten Exporter finden Sie unter Erstellen Sie einen anwenderdefinierten Exporter . Datentyp: Zeichenfolge
Export einschränken	Kennzeichnung, die angibt, ob der Endpunkt Snapshots beim Exportieren der Daten validiert. Gültige Werte: Wahr: Snapshots validieren. Falsch: Snapshots nicht validieren. Datentyp: Boolescher Wert Standard: Falsch
snapshotName	Name des zu exportierenden Snapshots. Dies kann nur einer der Snapshot-Namen sein, die dem bereitstellbaren Element zugeordnet sind, wie in angegeben deployableNameOder additionalDeployables.deployable_nameParameter. Standard: Der Endpunkt exportiert den zuletzt veröffentlichten Snapshot. Wenn kein veröffentlichter Snapshot vorhanden ist, löst das System den Fehler aus, dass der neueste veröffentlichte Snapshot für das bereitstellbare Element „{0}“ nicht gefunden werden konnte.

Tabelle : 57. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 58. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Nur unterstützt application/json.

Tabelle : 59. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 60. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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 (<xyz>).
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Name	Beschreibung
Fehler	Details zum aufgetretenen Fehler. Datentyp: Array "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
Export_ID	Eindeutiger Bezeichner der Exportanforderung. Verwenden Sie diese ID, wenn Sie aufrufen CdmApplicationsApi – RUFT /sn_cdm/Applications/proviyables/Exports/{Export_ID}/Status ABEndpunkt zum Überprüfen des aktuellen Status der Exportanforderung. Datentyp: Zeichenfolge
Status	Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel fordert den Export der Konfigurationsdaten für Folgendes an: Anwendungsname = TestAppA, Name des bereitstellbaren Elements = DEP, mit dem Exporter = Exporter-1-primary_bereitstellbar.

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

Ordnet die angegebene gemeinsam genutzte Komponente der Anwendung innerhalb eines angegebenen Changesets zu.

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

Hinweis:

Der angegebenen gemeinsam genutzten Komponente muss eine zugehörige veröffentlichte Version (Snapshot) zugeordnet sein.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Shared_components

Standard-URL: /api/sn_cdm/Applications/Shared_components

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 61. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 62. Abfrageparameter

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 Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder Status. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt
SharedComponentName	Erforderlich. Name der gemeinsam genutzten Komponente, die der angegebenen Anwendung zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_shared_component]
sharedLibraryName	Erforderlich. Name der gemeinsamen Bibliothek, unter der die Komponente erstellt werden soll. Für die gemeinsame Bibliothek müssen die folgenden Felder wie folgt definiert sein: status = aktiv Verfügbar = wahr Typ = Shared_Library Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]

Tabelle : 63. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 64. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 65. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 66. Statuscodes

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. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Die Antwortfelder hängen davon ab, welche Felder in angegeben wurden returnFieldsParameter in der Anforderung. Im Folgenden werden einige der wichtigsten Felder beschrieben.

Name	Beschreibung
änderungssatz_ID	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
änderungssatz_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
änderungssatz_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
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" }
error.detail	Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Nachricht, die einen Überblick ü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	Aufrufsyntax zum Abfragen dieses Versionsdatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Linked_to_Version.value	SYS_ID des Versionsdatensatzes. Datentyp: Zeichenfolge
Haupt	Kennzeichnung, die angibt, ob der zugehörige 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 wurde. 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. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
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
Typ	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“ unter 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 – POSTEN SIE /sn_cdm/Applications/uploads/components

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 anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads.

Hinweis:

Die maximale Standardgröße für Upload-Inhalte 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 Bezug auf hochgeladen werden ServiceNow DevOps ConfigUI. Nimmt an, dass die Komponente ist DbKomponente Und die Anwendung ist PaymentSvc .

Hinweis:

Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die Alternative Methode zum Ändern von Knoten.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/uploads/components

Standard-URL: /api/sn_cdm/Applications/uploads/components

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 67. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 68. Abfrageparameter

Name	Beschreibung
appName	Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „aktiv“ befinden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Automatisches Commit	Kennzeichnung, die angibt, ob das Changeset in identifiziert wurde changesetNumberParameter wird nach dem Hochladen an das Datenmodell übergeben. Gültige Werte: Wahr: Changeset wird nach dem Hochladen bestätigt. Falsch: Changeset wird nach dem Hochladen nicht bestätigt. Datentyp: Boolescher Wert Standard: Falsch
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 automatisch löschen. Falsch: Vorhandene Knoten nicht automatisch löschen. Datentyp: Boolescher Wert Standard: Falsch
Automatisch validieren	Kennzeichnung, die angibt, ob die Snapshots, die beim Commit erstellt wurden, validiert werden. Gültige Werte: Wahr: Validieren Sie die Snapshots. Falsch: Snapshots nicht validieren. Hinweis: Diese Option ist nur verfügbar, wenn autoCommitParameter ist Wahr . Datentyp: Boolescher Wert Standard: Falsch
changesetNumber	Zeichenfolge, die eindeutig identifiziert änderungssatz Der Anwendung zugeordnet, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen“ befinden. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil von zurückgegeben CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Ergebnisse. Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
Datenformat	Erforderlich. Format der Konfigurationsdaten. Gültige Werte: CSV ini json Eigenschaften roh XML yaml Datentyp: Zeichenfolge
DataFormatAttribute	Wird nur unterstützt, wenn dataFormatParameter ist auf festgelegt csv . Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter Parsing of CSV files in CDM. Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }
DataFormatAttributes.containsHeader	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. Falsch: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen in übergeben dataFormatAttributes.headersParameter. Datentyp: Boolescher Wert Standard: Falsch
dataFormatAttributes.delimeter	Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet werden soll. Datentyp: Zeichenfolge Standard: Komma „,“
DataFormatAttributes.Header	Erforderlich, wenn dataFormatAttributes.containsHeadersParameter ist Falsch . 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.securedHeaders	Felder in den Daten, die sichere Felder sind und in den Daten verschlüsselt werden müssen, die in hochgeladen werden CDM. 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“ gespeichert (zweifach verschlüsselt). Hinweis: Sie können Felder nur mit diesem Attribut sichern. Sie können die Sicherheit der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array
DeleteRedundantÜberschreibungen	Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, bei der redundante Werte vorhanden sind. Gültige Werte: Wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. Falsch: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standard: Wahr
fileName	Name der hochzuladenden Datei. Dieser Name kann sich vom tatsächlichen Dateinamen unterscheiden und die Dateierweiterung enthalten. Beispiel: .Txt/.scv/.jar. Der Dateiname wird beim Herunterladen der Datei angewendet. Datentyp: Zeichenfolge
FileNodeName	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 der Namen, die angeben, welcher Schlüssel in einem untergeordneten Array zur Identifizierung desselben Knotens verwendet werden soll. Beispiel: Wenn Sie hochladen: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] Und Sie haben festgelegt identifierKeysBis Name , Erzeugt 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
IgnorierAttribute	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 alle 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 aufgenommen. Datentyp: Boolescher Wert Standard: Falsch
namePath	Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad bezieht sich 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. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Backslash-Format: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1 cdi1 ​​ Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten hoch. Datentyp: Zeichenfolge
sharedLibraryName	Erforderlich. Name der gemeinsamen Bibliothek, in der sich die zu löschende Komponente befindet. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]

Tabelle : 69. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Variablen-Upload-Daten	Hochzuladende Konfigurationsdaten. Dies können beliebige Daten in dem von definierten Format sein dataFormatParameter der Abfrageparameter.

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 70. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: text/plainUnd application/x-www-form-urlencoded. Standard: text/plain

Tabelle : 71. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 72. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Upload-Anforderung wurde abgelehnt. Mögliche Probleme: Die Größe der Konfigurationsnutzlast ist größer als das zulässige Maximum – standardmäßig 2 MB. Erforderliche Parameter fehlen im Aufruf.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads. Datentyp: Zeichenfolge

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 Fehlerantwort 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

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 Bezug auf hochgeladen werden ServiceNow DevOps ConfigArbeitsbereich-UI. Nimmt an, dass die Anwendung ist PaymentSvc .

Hinweis:

Die maximale Standardgröße für Upload-Inhalte beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft „sn_cdm.max_allowed_upload_file_size.“ aktualisieren

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/uploads/components/vars

Standard-URL: /api/sn_cdm/Applications/uploads/components/vars

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 73. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 74. Abfrageparameter

Name	Beschreibung
appName	Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „aktiv“ befinden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Automatisches Commit	Kennzeichnung, die angibt, ob das Changeset in identifiziert wurde changesetNumberParameter wird nach dem Hochladen an das Datenmodell übergeben. Gültige Werte: Wahr: Changeset wird nach dem Hochladen bestätigt. Falsch: Changeset wird nach dem Hochladen nicht bestätigt. Datentyp: Boolescher Wert Standard: Falsch
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 automatisch löschen. Falsch: Vorhandene Knoten nicht automatisch löschen. Datentyp: Boolescher Wert Standard: Falsch
Automatisch validieren	Kennzeichnung, die angibt, ob die Snapshots, die beim Commit erstellt wurden, validiert werden. Gültige Werte: Wahr: Validieren Sie die Snapshots. Falsch: Snapshots nicht validieren. Hinweis: Diese Option ist nur verfügbar, wenn autoCommitParameter ist Wahr . Datentyp: Boolescher Wert Standard: Falsch
changesetNumber	Zeichenfolge, die eindeutig identifiziert änderungssatz Der Anwendung zugeordnet, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen“ befinden. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil von zurückgegeben CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Ergebnisse. Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
Datenformat	Erforderlich. Format der Konfigurationsdaten. Gültige Werte: ini json Eigenschaften roh XML yaml Datentyp: Zeichenfolge
DeleteRedundantÜberschreibungen	Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, bei der redundante Werte vorhanden sind. Gültige Werte: Wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. Falsch: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standard: Wahr
fileName	Name der hochzuladenden Datei. Dieser Name kann sich vom tatsächlichen Dateinamen unterscheiden und die Dateierweiterung enthalten. Beispiel: .Txt/.scv/.jar. Der Dateiname wird beim Herunterladen der Datei angewendet. Datentyp: Zeichenfolge
FileNodeName	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 der Namen, die angeben, welcher Schlüssel in einem untergeordneten Array zur Identifizierung desselben Knotens verwendet werden soll. Beispiel: Wenn Sie hochladen: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] Und Sie haben festgelegt identifierKeysBis Name , Erzeugt 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
IgnorierAttribute	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 alle 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 aufgenommen. Datentyp: Boolescher Wert Standard: Falsch
namePath	Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad bezieht sich 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. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Backslash-Format: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1 cdi1 ​​ Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten hoch. Datentyp: Zeichenfolge
sharedLibraryName	Erforderlich. Name der gemeinsamen Bibliothek, in der sich die zu löschende Komponente befindet. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]

Tabelle : 75. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Variablen-Upload-Daten	Hochzuladende Konfigurationsdaten. Dies können beliebige Daten in dem von definierten Format sein dataFormatParameter der Abfrageparameter.

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 76. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: text/plainUnd application/x-www-form-urlencoded. Standard: text/plain

Tabelle : 77. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 78. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Upload-Anforderung wurde abgelehnt. Mögliche Probleme: Die Größe der Konfigurationsnutzlast ist größer als das zulässige Maximum – standardmäßig 2 MB. Erforderliche Parameter fehlen im Aufruf.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads. Datentyp: Zeichenfolge

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 Fehlerantwort 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: /sn_cdm/Applications/uploads/Collections VERÖFFENTLICHEN

Sendet eine Anforderung zum Hochladen der übergebenen Konfigurationsdaten für eine bestimmte Sammlung im Systemerfassungsordner für die angegebene Anwendung.

Dieser Endpunkt gibt die ID der Upload-Anforderung zurück. Verwenden Sie diese ID, um anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads.

Hinweis:

Die maximale Standardgröße für Upload-Inhalte beträgt 2 MB. Sie können diesen Standard ändern, indem Sie die Eigenschaft „sn_cdm.max_allowed_upload_file_size.“ aktualisieren

Das folgende Bild zeigt ein Beispiel dafür, wo die Konfigurationsdaten in Bezug auf hochgeladen werden ServiceNow DevOps ConfigArbeitsbereich-UI. Nimmt an, dass die Sammlung ist Db0Release1.0 Und die Anwendung ist PaymentSvc .

Hinweis:

Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die Alternative Methode zum Ändern von Knoten.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/uploads/Collections

Standard-URL: /api/sn_cdm/Applications/uploads/Collections

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 79. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 80. Abfrageparameter

Name	Beschreibung
appName	Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „aktiv“ befinden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Automatisches Commit	Kennzeichnung, die angibt, ob das Changeset in identifiziert wurde changesetNumberParameter wird nach dem Hochladen an das Datenmodell übergeben. Gültige Werte: Wahr: Changeset wird nach dem Hochladen bestätigt. Falsch: Changeset wird nach dem Hochladen nicht bestätigt. Datentyp: Boolescher Wert Standard: Falsch
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 automatisch löschen. Falsch: Vorhandene Knoten nicht automatisch löschen. Datentyp: Boolescher Wert Standard: Falsch
Automatisch validieren	Kennzeichnung, die angibt, ob die Snapshots, die beim Commit erstellt wurden, validiert werden. Gültige Werte: Wahr: Validieren Sie die Snapshots. Falsch: Snapshots nicht validieren. Hinweis: Diese Option ist nur verfügbar, wenn autoCommitParameter ist Wahr . Datentyp: Boolescher Wert Standard: Falsch
changesetNumber	Zeichenfolge, die eindeutig identifiziert änderungssatz Der Anwendung zugeordnet, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen“ befinden. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil von zurückgegeben CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Ergebnisse. Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
Sammlungsname	Erforderlich. Name der Sammlung, unter der die hochgeladene Nutzlast gespeichert werden soll. Hinweis: Wenn angegeben namePathIst in dieser Sammlung nicht vorhanden. Das System erstellt automatisch die Komponente(n) in dieser Sammlung und lädt dann den Konfigurationsinhalt hoch. Beispiel: Wenn Sie die Sammlung hochladen möchten Colla , Mit dem Pfad Compa/Comp/CompC , Die Daten werden unter hochgeladen /Colla/Collections/compa/compB/compC . Wenn Kompa Ist vorhanden, aber nicht CompB Und Kompakt , Erstellt der Endpunkt diese Komponenten und lädt die Daten unter hoch Kompakt . Datentyp: Zeichenfolge
Datenformat	Erforderlich. Format der Konfigurationsdaten. Gültige Werte: CSV ini json Eigenschaften roh XML yaml Datentyp: Zeichenfolge
DataFormatAttribute	Wird nur unterstützt, wenn dataFormatParameter ist auf festgelegt csv . Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter Parsing of CSV files in CDM. Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }
DataFormatAttributes.containsHeader	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. Falsch: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen in übergeben dataFormatAttributes.headersParameter. Datentyp: Boolescher Wert Standard: Falsch
dataFormatAttributes.delimeter	Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet werden soll. Datentyp: Zeichenfolge Standard: Komma „,“
DataFormatAttributes.Header	Erforderlich, wenn dataFormatAttributes.containsHeadersParameter ist Falsch . 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.securedHeaders	Felder in den Daten, die sichere Felder sind und in den Daten verschlüsselt werden müssen, die in hochgeladen werden CDM. 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“ gespeichert (zweifach verschlüsselt). Hinweis: Sie können Felder nur mit diesem Attribut sichern. Sie können die Sicherheit der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array
DeleteRedundantÜberschreibungen	Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, bei der redundante Werte vorhanden sind. Gültige Werte: Wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. Falsch: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standard: Wahr
IgnorierAttribute	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 alle 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 aufgenommen. Datentyp: Boolescher Wert Standard: Falsch
namePath	Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad bezieht sich 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. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Backslash-Format: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1 cdi1 ​​ Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten hoch. Datentyp: Zeichenfolge

Tabelle : 81. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Variablen-Upload-Daten	Hochzuladende Konfigurationsdaten. Dies können beliebige Daten in dem von definierten Format sein dataFormatParameter der Abfrageparameter.

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 82. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: text/plainUnd application/x-www-form-urlencoded. Standard: text/plain

Tabelle : 83. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 84. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Upload-Anforderung wurde abgelehnt. Mögliche Probleme: Die Größe der Konfigurationsnutzlast ist größer als das zulässige Maximum – standardmäßig 2 MB. Erforderliche Parameter fehlen im Aufruf.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads. Datentyp: Zeichenfolge

Curl-Anforderung

Dieses Beispiel zeigt, wie JSON-formatiert hochgeladen wird dbSettingsKonfigurationsdatum im Sammlungsordner für die Anwendung „Demo_App1631126164773“.

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

Im Folgenden werden die möglichen Antworten auf diesen Anruf angezeigt, 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/deployment

Sendet eine Anforderung zum Hochladen des Konfigurationsinhalts für ein bestimmtes bereitstellbares Element im Systemordner „bereitstellbare Elemente“ einer angegebenen Anwendung.

Dieser Endpunkt gibt die ID der Upload-Anforderung zurück. Verwenden Sie diese ID, um anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads.

Hinweis:

Die maximale Standardgröße für Upload-Inhalte 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 Bezug auf hochgeladen werden ServiceNow DevOps ConfigUI. Nimmt an, dass das bereitstellbare Element ist Entwicklung_1 Und die Anwendung ist PaymentSvc .

Hinweis:

Diese Upload-Methode kann nicht zum Ändern von Knoten verwendet werden. Verwenden Sie die Alternative Methode zum Ändern von Knoten.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/uploads/bereitstellbare Elemente

Standard-URL: /api/sn_cdm/Applications/uploads/bereitstellbare Elemente

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 85. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 86. Abfrageparameter

Name	Beschreibung
appName	Name der Anwendung, die den Konfigurationsdaten zugeordnet werden soll. Diese Anwendung muss sich im Status „aktiv“ befinden. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Automatisches Commit	Kennzeichnung, die angibt, ob das Changeset in identifiziert wurde changesetNumberParameter wird nach dem Hochladen an das Datenmodell übergeben. Gültige Werte: Wahr: Changeset wird nach dem Hochladen bestätigt. Falsch: Changeset wird nach dem Hochladen nicht bestätigt. Datentyp: Boolescher Wert Standard: Falsch
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 automatisch löschen. Falsch: Vorhandene Knoten nicht automatisch löschen. Datentyp: Boolescher Wert Standard: Falsch
Automatisch validieren	Kennzeichnung, die angibt, ob die Snapshots, die beim Commit erstellt wurden, validiert werden. Gültige Werte: Wahr: Validieren Sie die Snapshots. Falsch: Snapshots nicht validieren. Hinweis: Diese Option ist nur verfügbar, wenn autoCommitParameter ist Wahr . Datentyp: Boolescher Wert Standard: Falsch
changesetNumber	Zeichenfolge, die eindeutig identifiziert änderungssatz Der Anwendung zugeordnet, z. B. Chset-102. Dieses Changeset muss sich im Status „Offen“ befinden. Datentyp: Zeichenfolge Standard: Erstellt ein zu verwendendes Changeset. Die Changeset-Details werden als Teil von zurückgegeben CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Ergebnisse. Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
Datenformat	Erforderlich. Format der Konfigurationsdaten. Gültige Werte: CSV ini json Eigenschaften roh XML yaml Datentyp: Zeichenfolge
DataFormatAttribute	Wird nur unterstützt, wenn dataFormatParameter ist auf festgelegt csv . Attribute, die das CSV-Datenformat definieren. Weitere Informationen finden Sie unter Parsing of CSV files in CDM. Datentyp: Objekt "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] }
DataFormatAttributes.containsHeader	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. Falsch: Daten enthalten keine Headerzeile. Sie müssen die Headerinformationen in übergeben dataFormatAttributes.headersParameter. Datentyp: Boolescher Wert Standard: Falsch
dataFormatAttributes.delimeter	Zeichen, das zum Abgrenzen von Feldern in den Daten verwendet werden soll. Datentyp: Zeichenfolge Standard: Komma „,“
DataFormatAttributes.Header	Erforderlich, wenn dataFormatAttributes.containsHeadersParameter ist Falsch . 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.securedHeaders	Felder in den Daten, die sichere Felder sind und in den Daten verschlüsselt werden müssen, die in hochgeladen werden CDM. 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“ gespeichert (zweifach verschlüsselt). Hinweis: Sie können Felder nur mit diesem Attribut sichern. Sie können die Sicherheit der gesicherten Felder nicht aufheben. Datentyp: Array Standard: Leeres Array
DeleteRedundantÜberschreibungen	Kennzeichnung, die angibt, ob eine Überschreibung erstellt werden soll, bei der redundante Werte vorhanden sind. Gültige Werte: Wahr: Wenn redundante Werte vorhanden sind, wird keine Überschreibung erstellt. Falsch: Wenn redundante Werte vorhanden sind, wird mit einer Überschreibung fortgefahren. Standard: Wahr
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren Elements, unter dem die hochgeladene Nutzlast gespeichert werden soll. Hinweis: Wenn angegeben namePathIst unter diesem bereitstellbaren Element nicht vorhanden. Das System erstellt automatisch die Komponente(n) unter diesem bereitstellbaren Element und lädt dann den Konfigurationsinhalt hoch.
IdentifierKeys	Liste der Namen, die angeben, welcher Schlüssel in einem untergeordneten Array zur Identifizierung desselben Knotens verwendet werden soll. Beispiel: Wenn Sie hochladen: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] Im folgenden vorhandenen Modell: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] Und Sie haben festgelegt identifierKeysBis Name , Erzeugt 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
IgnorierAttribute	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 alle 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 aufgenommen. Datentyp: Boolescher Wert Standard: Falsch
namePath	Pfad des Zielknotens, unter dem die Konfigurationsdaten hochgeladen werden sollen. Dieser Pfad bezieht sich 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. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Backslash-Format: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1 cdi1 ​​ Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Hinweis: Wenn die angegebene Komponente im angegebenen Pfad nicht vorhanden ist, erstellt das System die Komponente automatisch im angegebenen Pfad und lädt die Daten hoch. Datentyp: Zeichenfolge
PublishOption	Veröffentlichungsoption für die zugehörigen konfigurierten Snapshots. Gültige Werte: Publish_none: Veröffentlichen Sie keine Snapshots. Publish_valid: Veröffentlichen Sie nur die Snapshots, die die Validierung nach dem Commit bestehen. Weitere Informationen zum Veröffentlichen von Snapshots finden Sie unter Veröffentlichen oder heben Sie die Veröffentlichung eines Snapshots auf . Datentyp: Zeichenfolge Standard: Publish_none Hinweis: Diese Option ist nur verfügbar, wenn der Wert für autoCommitParameter ist „wahr“.

Tabelle : 87. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Variablen-Upload-Daten	Hochzuladende Konfigurationsdaten. Dies können beliebige Daten in dem von definierten Format sein dataFormatParameter der Abfrageparameter.

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 88. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: text/plainUnd application/x-www-form-urlencoded. Standard: text/plain

Tabelle : 89. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 90. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Upload-Anforderung wurde abgelehnt. Mögliche Probleme: Die Größe der Konfigurationsnutzlast ist größer als das zulässige Maximum – standardmäßig 2 MB. Erforderliche Parameter fehlen im Aufruf.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Wenn während der Verarbeitung ein Fehler aufgetreten ist, die Details zum Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	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 anzurufen CdmApplicationsApi – GET /sn_cdm/Applications/Upload-Status/{Upload_ID}Endpunkt zum Abrufen des Status des Uploads. Datentyp: Zeichenfolge

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 Fehlerantwort 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/proviyables

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

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/bereitstellbare Elemente

Standard-URL: /api/sn_cdm/Applications/bereitstellbare Elemente

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 91. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: V1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 92. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der CDM-Anwendung. Datentyp: Zeichenfolge
name	Erforderlich. Name des bereitstellbaren CDM. Datentyp: Zeichenfolge
NeuBeschreibung	Optional. Eine Beschreibung für das bereitstellbare CDM. Datentyp: Zeichenfolge
NewServiceId	Optional. Die ID des gewünschten Anwendungsservice/der dynamischen CI-Gruppe. Geben Sie in der Curl-Anforderung an „“ Zum Trennen des bereitstellbaren Elements vom Service.
NewIdentifier	Optional. Der Bezeichner des bereitstellbaren Elements. Datentyp: Auswahl (Entwicklung/Test/Produktion
NEWNAME	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 : 93. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 94. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: Application/JSON

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 REST-API-HTTP-Antwortcodes .

Tabelle : 95. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
sys_id	CDM bereitstellbare sys_ID.
name	Name des bereitstellbaren CDM.
Knoten	Bereitstellbares Knotenobjekt. { „Wert“: „<sysId>“, „Link“: „http://localhost:8081/api/now/table/*’}
Beschreibung	Beschreibung des bereitstellbaren CDM.
Bezeichner	Ein Bezeichner für das bereitstellbare Element.
cmdb_ci	Das App-Serviceobjekt, das mit einem bereitstellbaren Element verbunden ist. { „Wert“: „<sysId>“, „Link“: „http://localhost:8081/api/now/table/*’}
cmdb_App	Das CDM-Anwendungsobjekt. { „Wert“: „<sysId>“, „Link“: „http://localhost:8081/api/now/table/*’}
Snapshot_Version_Counter	Die Anzahl der Snapshots, die für ein bereitstellbares Element erstellt wurden.
cdi_count	Die Anzahl der CDIs, die in diesem bereitstellbaren CDM enthalten sind.
cdi_usage	Der CDI-Nutzungsprozentsatz.
Environment_type	Der Umgebungstyp. Mögliche Werte: Entwicklung Produktion testen
Staat	Der Status „aktiv“ oder „gelöscht“ an. Mögliche Werte: aktiv gelöscht
sys_created_by	Von <username> erstelltes bereitstellbares CDM-Element.
sys_created_on	Zeitstempel der Erstellung des bereitstellbaren CDM-Elements im Format <yyyy-MM-dd hh:mm:ss>.
sys_updated_by	Bereitstellbares CDM-Element von <username> aktualisiert.
sys_updated_on	Bereitstellbares CDM-Element aktualisiert durch Zeitstempel im Format <yyyy-MM-dd hh:mm:ss>.

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

Aktualisiert die angegebene gemeinsam genutzte Komponente in einer Anwendung innerhalb eines angegebenen Changesets.

Für den Zugriff auf diesen Endpunkt ist die CDM-Administratorrolle erforderlich.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Applications/Shared_components

Standard-URL: /api/sn_cdm/Applications/Shared_components

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 96. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 97. Abfrageparameter

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 Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder Status. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt
SharedComponentName	Erforderlich. Name der gemeinsam genutzten Komponente, die der angegebenen Anwendung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Gemeinsam genutzte CDM-Komponente [sn_cdm_shared_component]
sharedLibraryName	Erforderlich. Name der gemeinsamen Bibliothek, unter der sich die Komponente befindet. Für die gemeinsame Bibliothek müssen die folgenden Felder wie folgt definiert sein: status = aktiv Verfügbar = wahr Typ = Shared_Library Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Version	Erforderlich. Versionsname, der der gemeinsam genutzten Komponente zugeordnet ist. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]

Tabelle : 98. Anforderungstext-Parameter

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 99. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 100. Antwort-Header

Header	Beschreibung
Keine

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 REST-API-HTTP-Antwortcodes .

Tabelle : 101. Statuscodes

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. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter

Die Antwortfelder hängen davon ab, welche Felder in angegeben wurden returnFieldsParameter in der Anforderung. Im Folgenden werden einige der wichtigsten Felder beschrieben.

Name	Beschreibung
änderungssatz_ID	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
änderungssatz_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
änderungssatz_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_Changeset]
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" }
error.detail	Details zum aufgetretenen Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Nachricht, die einen Überblick ü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	Aufrufsyntax zum Abfragen dieses Versionsdatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Linked_to_Version.value	SYS_ID des Versionsdatensatzes. Datentyp: Zeichenfolge
Haupt	Kennzeichnung, die angibt, ob der zugehörige 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 wurde. 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. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
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
Typ	Knotentyp. Datentyp: Zeichenfolge

Curl-Anforderung

Das folgende Beispiel zeigt, wie Sie diesen Endpunkt aufrufen, 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
}