CdmSnapshotApi

Die CdmSnapshotApi stellt Endpunkte bereit, mit denen Sie Snapshots in Konfigurationsdaten-Management (CDM) veröffentlichen, die Veröffentlichung aufheben und sie erneut validieren können.

Sie veröffentlichen einen Snapshot, damit er exportiert werden kann. Dadurch kann die Pipeline Kontinuierliche Integration und kontinuierliche Bereitstellung (CICD) auf die zugehörigen Konfigurationsdaten zugreifen und sie verwenden. 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 aufheben, um die Gewissheit zu verringern, dass der Snapshot noch lebensfähig ist.

Sie müssen eine der folgenden Rollen aufweisen, um auf diese API zugreifen zu können:

• Scripted REST CDM View ACL (sn_cdm.cdm.viewer)
• Scripted REST CDM Editor ACL (sn_cdm.cdm_editor)

Außerdem muss das Plugin Konfigurationsdaten-Management (CDM) aktiviert sein, damit diese API in einer -Instanz verfügbar ist.

Weitere Informationen zu Snapshots finden Sie unter Snapshots anzeigen.

CdmSnapshotAPI – POST /sn_cdm/snapshots/{snapshot_id}/publish

Veröffentlicht einen angegebenen unveröffentlichten Snapshot.

Bevor ein Snapshot veröffentlicht werden kann, muss er validiert werden. Mit dem Endpunkt CdmSnapshotAPI – POST /sn_cdm/snapshots/{snapshot_id}/validate können Sie Snapshots validieren oder automatisch validieren lassen, wenn Sie einen Commit ausführen. Ein bereitstellbares Element muss mit einem Service verbunden werden, um seine Snapshots zu veröffentlichen. Auch wenn der Snapshot bereits veröffentlicht wurde, schlägt die Anforderung fehl.

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/publish

Standard-URL: /api/sn_cdm/snapshots/{snapshot_id}/publish

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Snapshot_ID	Sys_id des zu verarbeitenden Snapshot-Datensatzes. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge

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

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.

Parameter des Antworttexts (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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
status	Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie den Snapshot mit der sys_id 3a168d9dc342301054c1582e1340dd68 veröffentlichen.

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' 

Im Folgenden finden Sie eine Erfolgs- und 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 – POST /sn_cdm/snapshots/{snapshot_id}/unpublish

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/unpublish

Standard-URL: /api/sn_cdm/snapshots/{snapshot_id}/unpublish

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Snapshot_ID	Sys_id des zu verarbeitenden Snapshot-Datensatzes. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge

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

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.

Parameter des Antworttexts (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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
status	Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie die Veröffentlichung des Snapshots mit der sys_id 3a168d9dc342301054c1582e1340dd68 aufheben.

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' 

Im Folgenden finden Sie eine Erfolgs- und 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 – POST /sn_cdm/snapshots/{snapshot_id}/validate

Validiert einen angegebenen unveröffentlichten Snapshot.

Die Validierung wird als asynchroner Prozess durchgeführt. Durch das Aufrufen dieses Endpunkts wird nur der Validierungsprozess gestartet. Die zurückgegebenen Ergebnisse dieses Aufrufs geben nur an, ob der Validierungsprozess gestartet wurde, und nicht die Ergebnisse der Validierung selbst. Um herauszufinden, ob der Snapshot validiert wurde, verwenden Sie die Tabellen -API, um den Snapshot zu finden und seinen Validierungsstatus zu überprüfen.

Hinweis:

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/validate

Standard-URL: /api/sn_cdm/snapshots/{snapshot_id}/validate

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Snapshot_ID	Sys_id des zu verarbeitenden Snapshot-Datensatzes. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge

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

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Der angegebene Snapshot wurde bereits veröffentlicht oder wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
status	Fehlerstatus der Anforderung. Mögliche Werte: Fehler Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie den Snapshot mit der sys_id 3a168d9dc342301054c1582e1340dd68 validieren.

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' 

Im Folgenden finden Sie eine Erfolgs- und 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: PUT /sn_cdm/snapshots/publish

Veröffentlicht einen angegebenen unveröffentlichten Snapshot.

Bevor ein Snapshot veröffentlicht werden kann, muss er validiert werden. Mit dem Endpunkt CdmSnapshotApi: PUT /sn_cdm/snapshots/validate können Sie Snapshots validieren oder automatisch validieren lassen, wenn Sie einen Commit ausführen. Ein bereitstellbares Element muss mit einem Service verbunden werden, um seine Snapshots zu veröffentlichen. Auch wenn der Snapshot bereits veröffentlicht wurde, schlägt die Anforderung fehl.

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/publish

Standard-URL: /api/sn_cdm/snapshots/publish

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

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

Tabelle : 20. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der Anwendung Konfigurationsdaten-Management (CDM), für die der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
bereitstellbarerName	Erforderlich. Name des CDM-Bereitstellungselements, für das der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
name	Erforderlich. Name des Snapshots Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt

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

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	Rufen Sie auf, um mit der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge
cdm_application_id.value	Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
cdm_deployable_id	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.link	Rufen Sie die Syntax zum Abfragen dieses bereitstellbaren Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
cdm_deployable_id.value	Sys_id des bereitstellbaren Datensatzes. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
changeset_id	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
Beschreibung	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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	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 Benutzers, 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. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
sys_updated_by	Name des Benutzers, 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 bestanden_mit_Ausnahme 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: PUT /sn_cdm/snapshots/unpublish

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/unpublish

Standard-URL: /api/sn_cdm/snapshots/unpublish

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

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

Tabelle : 26. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der Anwendung Konfigurationsdaten-Management (CDM), für die der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
bereitstellbarerName	Erforderlich. Name des CDM-Bereitstellungselements, für das der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
name	Erforderlich. Name des Snapshots Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt

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

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	Rufen Sie auf, um mit der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge
cdm_application_id.value	Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
cdm_deployable_id	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.link	Rufen Sie die Syntax zum Abfragen dieses bereitstellbaren Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
cdm_deployable_id.value	Sys_id des bereitstellbaren Datensatzes. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
changeset_id	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
Beschreibung	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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	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 Benutzers, 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. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
sys_updated_by	Name des Benutzers, 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 bestanden_mit_Ausnahme angefordert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie Sie die Veröffentlichung eines Snapshots aufheben.

Ergebnisse zurückgeben:

CdmSnapshotApi: PUT /sn_cdm/snapshots/validate

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

Die Validierung wird als asynchroner Prozess durchgeführt. Durch das Aufrufen dieses Endpunkts wird nur der Validierungsprozess gestartet. Die zurückgegebenen Ergebnisse dieses Aufrufs geben nur an, ob der Validierungsprozess gestartet wurde, und nicht die Ergebnisse der Validierung selbst. Um herauszufinden, ob der Snapshot validiert wurde, verwenden Sie die Tabellen -API, um den Snapshot zu suchen und seinen Validierungsstatus zu überprüfen.

Hinweis:

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

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/snapshots/validate

Standard-URL: /api/sn_cdm/snapshots/validate

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

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

Tabelle : 32. Abfrageparameter

Name	Beschreibung
appName	Erforderlich. Name der Anwendung Konfigurationsdaten-Management (CDM), für die der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
bereitstellbarerName	Erforderlich. Name des CDM-Bereitstellungselements, für das der Snapshot erstellt werden soll. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
name	Erforderlich. Name des Snapshots Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Datensatzspaltennamen wie sys_id, sys_updated_by oder state. Datentyp: Array Standard: Alle Felder wie vom Endpunkt bestimmt

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

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Der angegebene Snapshot wurde bereits veröffentlicht oder wurde nicht gefunden.
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	Rufen Sie auf, um mit der REST- Tabellen -API auf den CDM-Anwendungsdatensatz zuzugreifen. Datentyp: Zeichenfolge
cdm_application_id.value	Sys_id des zugeordneten CDM-Anwendungsdatensatzes. Befindet sich in der Tabelle „CDM-Anwendung“ [sn_cdm_application]. Datentyp: Zeichenfolge
cdm_deployable_id	Details zum bereitstellbaren CDM-Element, das dem Snapshot zugeordnet ist. Datentyp: Objekt "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.link	Rufen Sie die Syntax zum Abfragen dieses bereitstellbaren Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
cdm_deployable_id.value	Sys_id des bereitstellbaren Datensatzes. Befindet sich in der Tabelle „CDM – Bereitstellbar“ [sn_cdm_deployable]. Datentyp: Zeichenfolge
changeset_id	Details zum Changeset, das dem Snapshot zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
Beschreibung	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" }
Fehler.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehlernachricht	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 Benutzers, 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. Befindet sich in der CDM-Snapshot-Tabelle [sn_cdm_snapshot]. Datentyp: Zeichenfolge
sys_updated_by	Name des Benutzers, 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 bestanden_mit_Ausnahme 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" 
  } 
}