CdmSnapshotApi

Die CdmSnapshotApi Stellt Endpunkte bereit, mit denen Sie Snapshots in veröffentlichen, ihre Veröffentlichung rückgängig machen und erneut validieren können Konfigurationsdaten-Management(CDM).

Sie veröffentlichen einen Snapshot, damit er exportiert werden kann, wodurch aktiviert wird Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) Pipeline für den Zugriff auf die zugehörigen Konfigurationsdaten und deren Verwendung. Exporter können nur für veröffentlichte Snapshots ausgeführt werden. Wenn Snapshots nicht mehr benötigt werden, können Sie ihre Veröffentlichung rückgängig machen, um die Verwirrung hinsichtlich der Eignung des Snapshots zu verringern.

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

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

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

Weitere Informationen zu Snapshots finden Sie unter Zeigen Sie Snapshots an .

CdmSnapshotAPI – /sn_cdm/Snapshots/{Snapshot_ID}/published veröffentlichen

Veröffentlicht einen angegebenen unveröffentlichten Snapshot.

Bevor ein Snapshot veröffentlicht werden kann, muss er validiert werden. Sie können verwenden CdmSnapshotAPI – NACH /sn_cdm/Snapshots/{Snapshot_ID}/validieren Endpunkt zum Validieren von Snapshots oder zum automatischen Validieren, wenn Sie einen Commit ausführen. Ein bereitstellbares Element muss mit einem Service verbunden sein, um seine Snapshots zu veröffentlichen. Außerdem schlägt die Anforderung fehl, wenn der Snapshot bereits veröffentlicht wurde.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/{Snapshot_ID}/publish

Standard-URL: /api/sn_cdm/Snapshots/{Snapshot_ID}/published

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

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
Snapshot_ID	SYS_ID des zu verarbeitenden Snapshot-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	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	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

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

cURL-Anforderung

Das folgende Beispiel zeigt, wie der Snapshot mit der sys_ID 3a168d9dc342301054c1582e1340dd68 veröffentlicht wird.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/publish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Folgendes zeigt sowohl eine Erfolgs- als auch eine Fehlerantwort auf die Veröffentlichungsanforderung.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotAPI – VERÖFFENTLICHUNG von /sn_cdm/Snapshots/{Snapshot_ID}/Aufheben der Veröffentlichung

Hebt die Veröffentlichung eines zuvor veröffentlichten Snapshots auf.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/{Snapshot_ID}/Veröffentlichung aufheben

Standard-URL: /api/sn_cdm/Snapshots/{Snapshot_ID}/Veröffentlichung aufheben

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

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
Snapshot_ID	SYS_ID des zu verarbeitenden Snapshot-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	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	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

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

cURL-Anforderung

Das folgende Beispiel zeigt, wie die Veröffentlichung des Snapshots mit der sys_ID 3a168d9dc342301054c1582e1340dd68 aufgehoben wird.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/unpublish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Folgendes zeigt sowohl eine Erfolgs- als auch eine Fehlerantwort auf die Anforderung zum Aufheben der Veröffentlichung.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotAPI – NACH /sn_cdm/Snapshots/{Snapshot_ID}/validieren

Validiert einen angegebenen unveröffentlichten Snapshot.

Die Validierung wird als asynchroner Prozess durchgeführt. Der Aufruf dieses Endpunkts startet nur den Validierungsprozess. Die Rückgabeergebnisse dieses Aufrufs geben nur an, ob der Validierungsprozess gestartet wurde, nicht die Ergebnisse der Validierung selbst. Um herauszufinden, ob der Snapshot validiert wurde, verwenden Sie Tabelle API zum Auffinden des Snapshots und zum Überprüfen des Validierungsstatus.

Hinweis:

Sie können einen veröffentlichten Snapshot nicht validieren.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/{Snapshot_ID}/validieren

Standard-URL: /api/sn_cdm/Snapshots/{Snapshot_ID}/validieren

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

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
Snapshot_ID	SYS_ID des zu verarbeitenden Snapshot-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	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. Der angegebene Snapshot wurde bereits veröffentlicht oder kann nicht gefunden werden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält 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

cURL-Anforderung

Das folgende Beispiel zeigt, wie der Snapshot mit der sys_ID 3a168d9dc342301054c1582e1340dd68 validiert wird.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/validate"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

Folgendes zeigt sowohl eine Erfolgs- als auch eine Fehlerantwort auf die Validierungsanforderung.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Invalid Snapshot id:test",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotApi: /sn_cdm/Snapshots/published PLATZIEREN

Veröffentlicht einen angegebenen unveröffentlichten Snapshot.

Bevor ein Snapshot veröffentlicht werden kann, muss er validiert werden. Sie können verwenden CdmSnapshotApi: /sn_cdm/Snapshots/validieren Endpunkt zum Validieren von Snapshots oder zum automatischen Validieren, wenn Sie einen Commit ausführen. Ein bereitstellbares Element muss mit einem Service verbunden sein, um seine Snapshots zu veröffentlichen. Außerdem schlägt die Anforderung fehl, wenn der Snapshot bereits veröffentlicht wurde.

Der Aufrufer dieses Endpunkts muss über die Rolle „CDM-Editor“ verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/Publish

Standard-URL: /api/sn_cdm/Snapshots/published

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

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 : 20. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name des Konfigurationsdaten-Management(CDM)-Anwendung, für die der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
name	Erforderlich. Name des Snapshots Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
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 State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt

Tabelle : 21. Anforderungstextparameter

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 22. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	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	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
cdm_Application_ID	Details zur CDM-Anwendung, die dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_application_id": { "link": "String", "value": "String" }
cdm_Application_ID.Link	Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge
cdm_Application_ID.Wert	SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
cdm_bereitstellbare_ID	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_bereitstellbar_ID.Link	Aufrufsyntax zum Abfragen dieses bereitstellbaren Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
cdm_bereitstellbar_ID.Wert	SYS_ID des bereitstellbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
changeset_ID	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Beschreibung	Kurze Beschreibung des Snapshots. 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
Last_published	Datum und Uhrzeit der letzten Veröffentlichung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Last_validated	Datum und Uhrzeit der letzten Validierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
name	Name des Snapshots Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Snapshot identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge
Veröffentlicht	Kennzeichnung, die angibt, ob der Snapshot veröffentlicht wurde. Mögliche Werte: Wahr: Snapshot wurde veröffentlicht. Falsch: Snapshot wurde nicht veröffentlicht. Datentyp: Boolesch
sys_created_by	Name des Anwenders, der den Snapshot erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
sys_id	SYS_ID des Snapshots. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
sys_updated_by	Name des Anwenders, der den Snapshot aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Validierung	Aktueller Validierungsstatus des Snapshots. Mögliche Werte: Execution_error Fehlgeschlagen in_progress Not_validated Bestanden Pass_with_Exception Angefordert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie ein Snapshot veröffentlicht wird.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/publish?deployableName=Development_1&name=Development_1-v1.dpl&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

Ergebnisse zurückgeben:

 
{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": true, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}

CdmSnapshotApi: /sn_cdm/Snapshots/Unpublished

Hebt die Veröffentlichung eines zuvor veröffentlichten Snapshots auf.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/Veröffentlichung aufheben

Standard-URL: /api/sn_cdm/Snapshots/Unpublished

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

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 des Konfigurationsdaten-Management(CDM)-Anwendung, für die der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
name	Erforderlich. Name des Snapshots Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
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 State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt

Tabelle : 27. Anforderungstextparameter

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 28. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	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	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
cdm_Application_ID	Details zur CDM-Anwendung, die dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_application_id": { "link": "String", "value": "String" }
cdm_Application_ID.Link	Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge
cdm_Application_ID.Wert	SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
cdm_bereitstellbare_ID	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_bereitstellbar_ID.Link	Aufrufsyntax zum Abfragen dieses bereitstellbaren Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
cdm_bereitstellbar_ID.Wert	SYS_ID des bereitstellbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
changeset_ID	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Beschreibung	Kurze Beschreibung des Snapshots. 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
Last_published	Datum und Uhrzeit der letzten Veröffentlichung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Last_validated	Datum und Uhrzeit der letzten Validierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
name	Name des Snapshots Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Snapshot identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge
Veröffentlicht	Kennzeichnung, die angibt, ob der Snapshot veröffentlicht wurde. Mögliche Werte: Wahr: Snapshot wurde veröffentlicht. Falsch: Snapshot wurde nicht veröffentlicht. Datentyp: Boolesch
sys_created_by	Name des Anwenders, der den Snapshot erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
sys_id	SYS_ID des Snapshots. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
sys_updated_by	Name des Anwenders, der den Snapshot aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Validierung	Aktueller Validierungsstatus des Snapshots. Mögliche Werte: Execution_error Fehlgeschlagen in_progress Not_validated Bestanden Pass_with_Exception Angefordert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie die Veröffentlichung eines Snapshots aufgehoben wird.

Ergebnisse zurückgeben:

CdmSnapshotApi: /sn_cdm/Snapshots/validieren

Validiert einen angegebenen unveröffentlichten Snapshot anhand seiner zugeordneten Richtlinien.

Die Validierung wird als asynchroner Prozess durchgeführt. Der Aufruf dieses Endpunkts startet nur den Validierungsprozess. Die Rückgabeergebnisse dieses Aufrufs geben nur an, ob der Validierungsprozess gestartet wurde, nicht die Ergebnisse der Validierung selbst. Um herauszufinden, ob der Snapshot validiert wurde, verwenden Sie Tabelle API zum Auffinden des Snapshots und zum Überprüfen des Validierungsstatus.

Hinweis:

Sie können einen veröffentlichten Snapshot nicht validieren.

Der Aufrufer dieses Endpunkts muss über die Rolle „CDM-Editor“ verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Snapshots/validieren

Standard-URL: /api/sn_cdm/Snapshots/validieren

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

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
appName	Erforderlich. Name des Konfigurationsdaten-Management(CDM)-Anwendung, für die der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
Bereitstellbarer Name	Erforderlich. Name des bereitstellbaren CDM-Elements, für das der Snapshot erstellt werden soll. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
name	Erforderlich. Name des Snapshots Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
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 State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt

Tabelle : 33. Anforderungstextparameter

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	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. Der angegebene Snapshot wurde bereits veröffentlicht oder kann nicht gefunden werden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
cdm_Application_ID	Details zur CDM-Anwendung, die dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_application_id": { "link": "String", "value": "String" }
cdm_Application_ID.Link	Aufruf zur Verwendung, um mit dem REST auf den CDM-Anwendungsdatensatz zuzugreifen Tabelle API. Datentyp: Zeichenfolge
cdm_Application_ID.Wert	SYS_ID des zugehörigen CDM-Anwendungsdatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application]
cdm_bereitstellbare_ID	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_bereitstellbar_ID.Link	Aufrufsyntax zum Abfragen dieses bereitstellbaren Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
cdm_bereitstellbar_ID.Wert	SYS_ID des bereitstellbaren Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM bereitstellbar [sn_cdm_bereitstellbar]
changeset_ID	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Beschreibung	Kurze Beschreibung des Snapshots. 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
Last_published	Datum und Uhrzeit der letzten Veröffentlichung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Last_validated	Datum und Uhrzeit der letzten Validierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
name	Name des Snapshots Datentyp: Zeichenfolge
Nummer	Eindeutige Nummer, die den Snapshot identifiziert. Dieser Wert stellt einen visuell lesbaren Bezeichner für die Zuordnung bereit. Datentyp: Zeichenfolge
Veröffentlicht	Kennzeichnung, die angibt, ob der Snapshot veröffentlicht wurde. Mögliche Werte: Wahr: Snapshot wurde veröffentlicht. Falsch: Snapshot wurde nicht veröffentlicht. Datentyp: Boolesch
sys_created_by	Name des Anwenders, der den Snapshot erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
sys_id	SYS_ID des Snapshots. Datentyp: Zeichenfolge Tabelle: CDM-Snapshot [sn_cdm_Snapshot]
sys_updated_by	Name des Anwenders, der den Snapshot aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Snapshots. Datentyp: Zeichenfolge Format: jjjj-mm-TT hh:mm:ss
Validierung	Aktueller Validierungsstatus des Snapshots. Mögliche Werte: Execution_error Fehlgeschlagen in_progress Not_validated Bestanden Pass_with_Exception Angefordert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie ein Snapshot validiert wird.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/validate?name=Development_1-v2.dpl&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

Ergebnisse zurückgeben:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": false, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}