CDMEditorAPI

Die CdmEditorApi stellt Endpunkte bereit, mit denen Sie Knoten erstellen, Knoten aktualisieren, vorhandene Knoten unter anderen Knoten einfügen, Knoten löschen und Knoten und Knoteneinbindungen abrufen können.

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)

Um verschlüsselte Felder anzuzeigen, benötigen Sie die Rolle „CDM-Geheimnis“.

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

Hinweis:

Die CdmEditorApi- API kann nicht zum Ändern von Dateien verwendet werden. Derzeit ist nur das Löschen von Dateien zulässig.

CdmEditorApi – /sn_cdm/editor/nodes LÖSCHEN

Löscht einen angegebenen Knoten.

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/nodes

Standard-URL: /api/sn_cdm/editor/nodes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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

Tabelle : 2. Abfrageparameter

Name	Beschreibung
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
vollständigerNamenspfad	Erforderlich. Pfadname des zu löschenden Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den folgenden Knoten testApp/deployables/Development1/cdi1zu löschen: Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬​Development1​​​cdi1 Array: ['testApp','deployables','Development1','cdi1'] Datentyp: Zeichenfolge

Tabelle : 3. 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 : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. 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-Antwortcodes der 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 Antwort-Haupttexts

Name	Beschreibung
Keine

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie der Knoten „cdi88“ gelöscht wird.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?changesetNumber=Chset783&fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment-1%2Fcdi88" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

None - just the associated HTTP status code

CdmEditorApi: GET /sn_cdm/editor/includes

Gibt die Liste der Knoten zurück, die in einem angegebenen Knotenpfad enthalten waren.

Der Anrufer dieses Endpunkts muss über die Rolle „CDM-Betrachter“ verfügen.

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/includes

Standard-URL: /api/sn_cdm/editor/includes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter

Name	Beschreibung
changesetNumber	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
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
sourceFullNamePath	Erforderlich. Pfadname des Quellknotens, für den die enthaltenen Knoten zurückgegeben werden sollen. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise die Einbindungen für den Knoten „collectionA“ im Verzeichnis „testApp/collections“ zurückzugeben, gehen Sie wie folgt vor: Format mit umgekehrtem Schrägstrich: testApp/collections/collectionA Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: testApp Sammlungsammlungen SammlungA Array: ['testApp','collections','collectionA'] Datentyp: Zeichenfolge

Header

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

Tabelle : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. 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-Antwortcodes der 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 Antwort-Haupttexts

Name	Beschreibung
changeset_id	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. „falsch“: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, wird der Typ des erkannten Konflikts erkannt. NULL, wenn kein Konflikt erkannt wird. Mögliche Werte: beschädigter_Knoten delete_node duplicated_node unvollständig_gelöscht_übergeordnet unvollständig_gelöscht_ref unvollständig_umbenannt_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unrennamed_include update_node Datentyp: Zeichenfolge
description	Kurze Beschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), wenn der Knoten als Teil des Changesets committet wurde. Wenn der Knoten nicht festgelegt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wann er gelöscht oder durch einen anderen Knoten ersetzt wurde, ansonsten „null“. Datentyp: Zahl (Ganzzahl)
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
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Beispiel: Der Knoten /AppA/components/compA hat zwei Ebenen. Datentyp: Zeichenfolge
linked_to	Der Parameter main_id des referenzierten Knotens, mit dem dieser Knoten verknüpft ist. Wenn dieser Knoten nicht mit einem Referenzknoten verknüpft ist, ist der Wert „null“. Datentyp: Zeichenfolge
main_id	Primärer Bezeichner für den Knoten. Sie können diesen Wert in der Skripteinbindung CdmQuery() verwenden, um eine JSON-Struktur abzurufen. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
main_id_encoded	RADIX 57-Zeichenfolgendarstellung des Parameters main_id des Knotens. Datentyp: Zeichenfolge
name	Name des Knotens, der im Zielpfad enthalten war. Datentyp: Zeichenfolge
node_classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten innerhalb der Ordnerhierarchie zu finden. Ein bereitstellbares Element hat beispielsweise die Hierarchie /application/deployables/env:Development Während eine Sammlung eine Hierarchie von /applications/collectionshätte Datentyp: Zeichenfolge
node_path	Vollständiger Pfadname des Knotens, der im Zielpfad enthalten war, z.  B. /Production/deployables/Development1/cdi1. Datentyp: Zeichenfolge
position	Knotenposition. Beispiel: Wenn Sie das folgende Array hochladen: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Die Positionswerte werden wie folgt festgelegt: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Wenn ein komplexes Objekt unter einem Array hochgeladen wird, in diesem Fall {"cdi1": 1}, erstellt der Endpunkt einen neuen virtuellen Knoten, dessen Name seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Einbindungen ist die Position immer leer. Datentyp: Zeichenfolge
previous_version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, gibt der Endpunkt für diesen Parameter „ previous_version“ = null zurück. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Beschränken_auf	Details der Gruppe, die Zugriff auf den zugeordneten Knoten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (maskiert zurückgegeben) Ein Anwender muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt so festlegen, dass diese Felder nicht zurückgegeben werden, indem Sie das Abfrageparameterfeld returnFields festlegen. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
sys_id	Sys_id des Knotens. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: wahr: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Datentyp: Zeichenfolge
Wert	Knotenwert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie die Includes im Quellpfad /testApp/collections/collAabgerufen werden.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&sourceFullNamePath=%2FtestApp%2Fcollections%2FcollA" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

{ 
  "result": [ 
    { 
      "sys_id": "a1c517a953b70110a1d3ddeeff7b129b", 
      "type": "sn_cdm_node_deployable", 
      "main_id": "6", 
      "main_id_encoded": ",", 
      "node_path": "!$!+!,", 
      "level": 2, 
      "status": "valid", 
      "node_classifier": "/application/deployables/env:Development", 
      "position": null, 
      "restricted_to": null, 
      "changeset_id": "e9c517a953b70110a1d3ddeeff7b1299", 
      "previous_version": null, 
      "effective_from": "1654002206866", 
      "effective_to": null, 
      "name": "Development_1", 
      "description": null, 
      "value": null, 
      "secure_value": null, 
      "system_folder": "0", 
      "linked_to": null, 
      "conflict": "0", 
      "conflict_type": null 
    } 
  ] 
}

CdmEditorApi – GET /sn_cdm/editor/nodes

Gibt die Details eines angegebenen Knotens oder einer Liste von untergeordneten Knoten Konfigurationsdaten-Management (CDM) für einen angegebenen übergeordneten Knoten zurück.

Der Anrufer dieses Endpunkts muss über die Rolle „CDM-Betrachter“ verfügen.

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/nodes

Standard-URL: /api/sn_cdm/editor/nodes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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

Tabelle : 14. Abfrageparameter

Name	Beschreibung
changesetNumber	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
decryptPassword	Kennzeichnung, die angibt, ob der Wert für die Endknoten verschlüsselt werden soll. Gültige Werte: true: Verschlüsselt false: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
name	Knotenname Wenn Sie diesen Parameter übergeben, werden nur die Ergebnisse für den angegebenen Knoten zurückgegeben. Datentyp: Zeichenfolge Standard: Alle Knoten innerhalb des übergeordneten Knotens
parentFullNamePath	Erforderlich. Pfadname des übergeordneten Knotens, für den die untergeordneten Knoten zurückgegeben werden sollen oder an dem sich der im Parameter name angegebene Knoten befindet. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise die Knoten für den Knoten „collectionA“ im Verzeichnis „testApp/collections“ zurückzugeben, gehen Sie wie folgt vor: Format mit umgekehrtem Schrägstrich: testApp/collections/collectionA Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: testApp Sammlungsammlungen SammlungA Array: ['testApp','collections','collectionA'] 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
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi ODER cdi sn_cdm_node_collection ODER Sammlung sn_cdm_node_component ODER Komponente sn_cdm_node_folder ODER Ordner sn_cdm_node_variable ODER-Variable Datentyp: Zeichenfolge Standard: Alle

Tabelle : 15. 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 : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. 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-Antwortcodes der REST-API.

Tabelle : 18. 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
changeset_id	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. „falsch“: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, wird der Typ des erkannten Konflikts erkannt. NULL, wenn kein Konflikt erkannt wird. Mögliche Werte: beschädigter_Knoten delete_node duplicated_node unvollständig_gelöscht_übergeordnet unvollständig_gelöscht_ref unvollständig_umbenannt_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unrennamed_include update_node Datentyp: Zeichenfolge
description	Kurze Beschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), wenn der Knoten als Teil des Changesets committet wurde. Wenn der Knoten nicht festgelegt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wann er gelöscht oder durch einen anderen Knoten ersetzt wurde, ansonsten „null“. Datentyp: Zahl (Ganzzahl)
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
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Beispiel: Der Knoten /AppA/components/compA hat zwei Ebenen. Datentyp: Zeichenfolge
linked_to	Der Parameter main_id des referenzierten Knotens, mit dem dieser Knoten verknüpft ist. Wenn dieser Knoten nicht mit einem Referenzknoten verknüpft ist, ist der Wert „null“. Datentyp: Zeichenfolge
main_id	Primärer Bezeichner für den Knoten. Sie können diesen Wert in der Skripteinbindung CdmQuery() verwenden, um eine JSON-Struktur abzurufen. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
main_id_encoded	RADIX 57-Zeichenfolgendarstellung des Parameters main_id des Knotens. Datentyp: Zeichenfolge
name	Name des Knotens. Datentyp: Zeichenfolge
node_classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten innerhalb der Ordnerhierarchie zu finden. Ein bereitstellbares Element hat beispielsweise die Hierarchie /application/deployables/env:Development Während eine Sammlung eine Hierarchie von /applications/collectionshätte Datentyp: Zeichenfolge
node_path	Vollständiger Knotenpfadname. Datentyp: Zeichenfolge
position	Knotenposition. Beispiel: Wenn Sie das folgende Array hochladen: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Die Positionswerte werden wie folgt festgelegt: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Wenn ein komplexes Objekt unter einem Array hochgeladen wird, in diesem Fall {"cdi1": 1}, erstellt der Endpunkt einen neuen virtuellen Knoten, dessen Name seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Einbindungen ist die Position immer leer. Datentyp: Zeichenfolge
previous_version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, gibt der Endpunkt für diesen Parameter „ previous_version“ = null zurück. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
previous_version.link	Rufen Sie die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Reason_for_conflict	Ausführliche Erklärung des Konflikts. Datentyp: Zeichenfolge
Beschränken_auf	Details der Gruppe, die Zugriff auf den zugeordneten Knoten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
strict_to.link	Rufen Sie die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
„restricted_to.value“	Sys_id des Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Gruppe [sys_user_group]
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (maskiert zurückgegeben) Ein Anwender muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt so festlegen, dass diese Felder nicht zurückgegeben werden, indem Sie das Abfrageparameterfeld returnFields festlegen. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: wahr: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
sys_class_name	Tabelle, in der sich der Knoten befindet. Datentyp: Zeichenfolge
sys_created_by	Name des Anwenders, der den Knoten erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
sys_id	Sys_id des Knotens. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
sys_updated_by	Name des Benutzers, der den Knoten aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Datentyp: Zeichenfolge Standard: Alle
Wert	Knotenwert Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Codebeispiel zeigt, wie die untergeordneten Knoten vom Typ „sn_cdm_node_cdi“ unter dem übergeordneten Knoten „/testApp/Fdeployables/Development_1“ abgerufen werden.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?decryptPassword=true&name=cdi45&changesetNumber=Chset3&parentFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&type=sn_cdm_node_cdi" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

{ 
  "result": [ 
    { 
      "changeset_id": { 
        "value": "d403648653b70110a1d3ddeeff7b12c5", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
      }, 
      "node_path": "!$!+!,![:", 
      "description": null, 
      "sys_updated_on": "2022-06-30 09:24:07", 
      "type": "sn_cdm_node_cdi", 
      "sys_class_name": "sn_cdm_node", 
      "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
      "sys_updated_by": "admin", 
      "previous_version": null, 
      "sys_created_on": "2022-06-30 08:53:13", 
      "value": "cdcdc", 
      "effective_from": null, 
      "linked_to": null, 
      "sys_created_by": "admin", 
      "restricted_to": null, 
      "level": "3", 
      "conflict_type": null, 
      "main_id": "2869", 
      "effective_to": null, 
      "secure_value": null, 
      "node_classifier": "/application/deployables/env:Development", 
      "main_id_encoded": "[:", 
      "name": "cdi45", 
      "position": null, 
      "reason_for_conflict": null, 
      "system_folder": false, 
      "status": "new", 
      "conflict": false 
    } 
  ] 
}

CdmEditorApi – POST /sn_cdm/editor/includes

Schließt einen vorhandenen Knoten in einen anderen Knoten ein, z. B. einen Komponentenknoten in einen Sammlungsknoten oder einen Sammlungsknoten in einen bereitstellbaren Knoten. Nach dem Einfügen eines Knotens verfügt der neue Knoten über eine eigene eindeutige sys_id und main_Id.

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

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/includes

Standard-URL: /api/sn_cdm/editor/includes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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
changesetNumber	Erforderlich. Eindeutige Nummer des offenen Changesets, das in den Zielknoten aufgenommen werden soll. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
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
sourceFullNamePath	Erforderlich. Pfadname des Knotens, der in den Zielknoten aufgenommen werden soll. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den folgenden Knoten Staging/deployables/Development1/cdi1einzubeziehen: Format mit umgekehrtem Schrägstrich: Staging/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: Staging¬deployables¬​Development1​¬​cdi1 Array: ['Staging','deployables','Development1','cdi1'] Datentyp: Zeichenfolge
targetFullNamePath	Erforderlich. Pfadname des Knotens, unter dem der Quellknoten enthalten sein soll. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den folgenden Knoten einzubeziehen : Production/deployables/Development1: Format mit umgekehrtem Schrägstrich: Production/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: Produktion, bereitstellbare Elemente, Entwicklung1, cdi1 Array: ['Production','deployables','Development1','cdi1'] Datentyp: Zeichenfolge

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-Antwortcodes der 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
changeset_id	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. „falsch“: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, wird der Typ des erkannten Konflikts erkannt. NULL, wenn kein Konflikt erkannt wird. Mögliche Werte: beschädigter_Knoten delete_node duplicated_node unvollständig_gelöscht_übergeordnet unvollständig_gelöscht_ref unvollständig_umbenannt_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unrennamed_include update_node Datentyp: Zeichenfolge
description	Kurze Beschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), wenn der Knoten als Teil des Changesets committet wurde. Wenn der Knoten nicht festgelegt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wann er gelöscht oder durch einen anderen Knoten ersetzt wurde, ansonsten „null“. Datentyp: Zahl (Ganzzahl)
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
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Beispiel: Der Knoten /AppA/components/compA hat zwei Ebenen. Datentyp: Zeichenfolge
linked_to	Der Parameter main_id des referenzierten Knotens, mit dem dieser Knoten verknüpft ist. Wenn dieser Knoten nicht mit einem Referenzknoten verknüpft ist, ist der Wert „null“. Datentyp: Zeichenfolge
main_id	Primärer Bezeichner für den Knoten. Sie können diesen Wert in der Skripteinbindung CdmQuery() verwenden, um eine JSON-Struktur abzurufen. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
main_id_encoded	RADIX 57-Zeichenfolgendarstellung des Parameters main_id des Knotens. Datentyp: Zeichenfolge
name	Name des Knotens, der im Zielpfad enthalten war. Datentyp: Zeichenfolge
node_classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten innerhalb der Ordnerhierarchie zu finden. Ein bereitstellbares Element hat beispielsweise die Hierarchie /application/deployables/env:Development Während eine Sammlung eine Hierarchie von /applications/collectionshätte Datentyp: Zeichenfolge
node_path	Vollständiger Pfadname des Knotens, der im Zielpfad enthalten war, z.  B. /Production/deployables/Development1/cdi1. Datentyp: Zeichenfolge
position	Knotenposition. Beispiel: Wenn Sie das folgende Array hochladen: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Die Positionswerte werden wie folgt festgelegt: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Wenn ein komplexes Objekt unter einem Array hochgeladen wird, in diesem Fall {"cdi1": 1}, erstellt der Endpunkt einen neuen virtuellen Knoten, dessen Name seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Einbindungen ist die Position immer leer. Datentyp: Zeichenfolge
previous_version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, gibt der Endpunkt für diesen Parameter „ previous_version“ = null zurück. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Beschränken_auf	Details der Gruppe, die Zugriff auf den zugeordneten Knoten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (maskiert zurückgegeben) Ein Anwender muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt so festlegen, dass diese Felder nicht zurückgegeben werden, indem Sie das Abfrageparameterfeld returnFields festlegen. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
sys_id	Sys_id des Knotens. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: wahr: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Datentyp: Zeichenfolge
Wert	Knotenwert Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie der Knoten /testApp/collections/collA unter /testApp/deployables/Development_1eingefügt wird.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&targetFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&sourceFullNamePath=%2FtestApp%2Fcollecti
ons%2FcollA" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![?", 
    "description": null, 
    "sys_updated_on": "2022-06-30 09:19:47", 
    "type": "sn_cdm_node_linked", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "1642015b53981110a1d3ddeeff7b1232", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 09:19:47", 
    "value": null, 
    "effective_from": null, 
    "linked_to": "2870", 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2872", 
    "effective_to": null, 
    "secure_value": null, 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[?", 
    "name": "collA", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi – POST /sn_cdm/editor/nodes

Erstellt einen bestimmten Knotentyp, z. B. Komponente, Sammlung, Ordner, Configuration Data Item (CDI) oder Variable.

Sie können auch angeben, ob übergeordnete Knoten, die derzeit nicht definiert sind, automatisch generiert werden sollen.

Der Aufrufer dieses Endpunkts muss entweder die Rolle „CDM-Editor“ oder „CDM-Geheimnis“ aufweisen.

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/nodes

Standard-URL: /api/sn_cdm/editor/nodes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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
autoCreateParents	Kennzeichnung, die angibt, ob die nicht vorhandenen übergeordneten Elemente im Namenspfad automatisch als Komponenten erstellt werden sollen. Ausnahmen sind die App, das bereitstellbare Element und die Sammlung. Wenn Sie diese Kennzeichnung nicht festlegen und die übergeordneten Elemente noch nicht vorhanden sind, schlägt der Endpunkt fehl. Gültige Werte: wahr: Nicht vorhandene übergeordnete Elemente werden automatisch erstellt. „falsch“: Die nicht vorhandenen übergeordneten Elemente werden nicht automatisch erstellt. Datentyp: Boolesch Standardwert: false
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
vollständigerNamenspfad	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten testApp/deployables/Development1/cdi1zu definieren, gehen Sie wie folgt vor: Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬​Development1​​​cdi1 Array: ['testApp','deployables','Development1','cdi1'] 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
sicher	Kennzeichnung, die angibt, ob der Wert für die Endknoten verschlüsselt werden soll. Gültige Werte: true: Verschlüsselt false: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
Typ	Erforderlich. Typ des neuen Knotens. Gültige Werte: sn_cdm_node_collection ODER Sammlung sn_cdm_node_component ODER Komponente sn_cdm_node_folder ODER Ordner sn_cdm_node_cdi ODER cdi sn_cdm_node_variable oder Variable Datentyp: Zeichenfolge
Wert	Wert des neuen Knotens. Datentyp: Zeichenfolge Standard: Entspricht „null“

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-Antwortcodes der 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
changeset_id	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. „falsch“: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, wird der Typ des erkannten Konflikts erkannt. NULL, wenn kein Konflikt erkannt wird. Mögliche Werte: beschädigter_Knoten delete_node duplicated_node unvollständig_gelöscht_übergeordnet unvollständig_gelöscht_ref unvollständig_umbenannt_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unrennamed_include update_node Datentyp: Zeichenfolge
description	Kurze Beschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), wenn der Knoten als Teil des Changesets committet wurde. Wenn der Knoten nicht festgelegt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wann er gelöscht oder durch einen anderen Knoten ersetzt wurde, ansonsten „null“. Datentyp: Zahl (Ganzzahl)
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
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Beispiel: Der Knoten /AppA/components/compA hat zwei Ebenen. Datentyp: Zeichenfolge
linked_to	Der Parameter main_id des referenzierten Knotens, mit dem dieser Knoten verknüpft ist. Wenn dieser Knoten nicht mit einem Referenzknoten verknüpft ist, ist der Wert „null“. Datentyp: Zeichenfolge
main_id	Primärer Bezeichner für den Knoten. Sie können diesen Wert in der Skripteinbindung CdmQuery() verwenden, um eine JSON-Struktur abzurufen. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
main_id_encoded	RADIX 57-Zeichenfolgendarstellung des Parameters main_id des Knotens. Datentyp: Zeichenfolge
name	Name des Knotens. Datentyp: Zeichenfolge
node_classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten innerhalb der Ordnerhierarchie zu finden. Ein bereitstellbares Element hat beispielsweise die Hierarchie /application/deployables/env:Development Während eine Sammlung eine Hierarchie von /applications/collectionshätte Datentyp: Zeichenfolge
node_path	Vollständiger Knotenpfadname. Datentyp: Zeichenfolge
position	Knotenposition. Beispiel: Wenn Sie das folgende Array hochladen: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Die Positionswerte werden wie folgt festgelegt: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Wenn ein komplexes Objekt unter einem Array hochgeladen wird, in diesem Fall {"cdi1": 1}, erstellt der Endpunkt einen neuen virtuellen Knoten, dessen Name seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Einbindungen ist die Position immer leer. Datentyp: Zeichenfolge
previous_version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, gibt der Endpunkt für diesen Parameter „ previous_version“ = null zurück. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
previous_version.link	Rufen Sie die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Reason_for_conflict	Ausführliche Erklärung des Konflikts. Datentyp: Zeichenfolge
Beschränken_auf	Details der Gruppe, die Zugriff auf den zugeordneten Knoten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
strict_to.link	Rufen Sie die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
„restricted_to.value“	Sys_id des Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Gruppe [sys_user_group]
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (maskiert zurückgegeben) Ein Anwender muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt so festlegen, dass diese Felder nicht zurückgegeben werden, indem Sie das Abfrageparameterfeld returnFields festlegen. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: wahr: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
sys_class_name	Tabelle, in der sich der Knoten befindet. Datentyp: Zeichenfolge
sys_created_by	Name des Anwenders, der den Knoten erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
sys_id	Sys_id des Knotens. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
sys_updated_by	Name des Benutzers, der den Knoten aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Datentyp: Zeichenfolge Standard: Alle
Wert	Knotenwert Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie Sie mit diesem Endpunkt einen -Knoten erstellen.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment1%2Fcdi1&secure=true&value=someVal&type=cdi&changesetNumber=Chset-760" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi: PUT /sn_cdm/editor/nodes

Aktualisiert den Namen und/oder den Wert eines angegebenen Knotens.

Der Aufrufer dieses Endpunkts muss entweder die Rolle „CDM-Editor“ oder „CDM-Geheimnis“ aufweisen.

URL-Format

URL mit Versionsnummer: /api/sn_cdm/{api_version}/editor/nodes

Standard-URL: /api/sn_cdm/editor/nodes

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

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
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDMChangeset [sn_cdm_changeset]
vollständigerNamenspfad	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den Namenspfad für den Knoten testApp/deployables/Development1/cdi1zu definieren, gehen Sie wie folgt vor: Backslash-Format: testApp/deployables/Development1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich („/“) enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersetzungszeichen: testApp¬deployables¬​Development1​​​cdi1 Array: ['testApp','deployables','Development1','cdi1'] Datentyp: Zeichenfolge
neuerName	Neuer Name für den zugeordneten Knoten. Datentyp: Zeichenfolge
newValue	Neuer Wert für den zugeordneten Knoten. Datentyp: Zeichenfolge
sicher	Kennzeichnung, die angibt, ob der Wert für die Endknoten verschlüsselt werden soll. Gültige Werte: true: Verschlüsselt false: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
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-Antwortcodes der REST-API.

Tabelle : 36. 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
changeset_id	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_id.link	Rufen Sie die Syntax zum Abfragen dieses Changeset-Datensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
changeset_id.value	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. „falsch“: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, wird der Typ des erkannten Konflikts erkannt. NULL, wenn kein Konflikt erkannt wird. Mögliche Werte: beschädigter_Knoten delete_node duplicated_node unvollständig_gelöscht_übergeordnet unvollständig_gelöscht_ref unvollständig_umbenannt_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unrennamed_include update_node Datentyp: Zeichenfolge
description	Kurze Beschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), wenn der Knoten als Teil des Changesets committet wurde. Wenn der Knoten nicht festgelegt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wann er gelöscht oder durch einen anderen Knoten ersetzt wurde, ansonsten „null“. Datentyp: Zahl (Ganzzahl)
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
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Beispiel: Der Knoten /AppA/components/compA hat zwei Ebenen. Datentyp: Zeichenfolge
linked_to	Der Parameter main_id des referenzierten Knotens, mit dem dieser Knoten verknüpft ist. Wenn dieser Knoten nicht mit einem Referenzknoten verknüpft ist, ist der Wert „null“. Datentyp: Zeichenfolge
main_id	Primärer Bezeichner für den Knoten. Sie können diesen Wert in der Skripteinbindung CdmQuery() verwenden, um eine JSON-Struktur abzurufen. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
main_id_encoded	RADIX 57-Zeichenfolgendarstellung des Parameters main_id des Knotens. Datentyp: Zeichenfolge
name	Name des Knotens. Datentyp: Zeichenfolge
node_classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten innerhalb der Ordnerhierarchie zu finden. Ein bereitstellbares Element hat beispielsweise die Hierarchie /application/deployables/env:Development Während eine Sammlung eine Hierarchie von /applications/collectionshätte Datentyp: Zeichenfolge
node_path	Vollständiger Knotenpfadname. Datentyp: Zeichenfolge
position	Knotenposition. Beispiel: Wenn Sie das folgende Array hochladen: arrayNode1: [ "literal1", {"cdi1": 1}, "literal3" ] Die Positionswerte werden wie folgt festgelegt: arrayNode1.literal1 = 1000 arrayNode1.2000 = 2000 arrayNode1.literal3 = 3000 Wenn ein komplexes Objekt unter einem Array hochgeladen wird, in diesem Fall {"cdi1": 1}, erstellt der Endpunkt einen neuen virtuellen Knoten, dessen Name seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Einbindungen ist die Position immer leer. Datentyp: Zeichenfolge
previous_version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, gibt der Endpunkt für diesen Parameter „ previous_version“ = null zurück. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
previous_version.link	Rufen Sie die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Reason_for_conflict	Ausführliche Erklärung des Konflikts. Datentyp: Zeichenfolge
Beschränken_auf	Details der Gruppe, die Zugriff auf den zugeordneten Knoten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
strict_to.link	Rufen Sie die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
„restricted_to.value“	Sys_id des Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Gruppe [sys_user_group]
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (maskiert zurückgegeben) Ein Anwender muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt so festlegen, dass diese Felder nicht zurückgegeben werden, indem Sie das Abfrageparameterfeld returnFields festlegen. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: wahr: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
sys_class_name	Tabelle, in der sich der Knoten befindet. Datentyp: Zeichenfolge
sys_created_by	Name des Anwenders, der den Knoten erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
sys_id	Sys_id des Knotens. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
sys_updated_by	Name des Benutzers, der den Knoten aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Knotens. Datentyp: Zeichenfolge Format: jjjj-mm-tt hh:mm:ss
Typ	Knotentyp. Mögliche Werte: sn_cdm_node_cdi sn_cdm_node_collection sn_cdm_node_component sn_cdm_node_folder sn_cdm_node_variable Datentyp: Zeichenfolge Standard: Alle
Wert	Knotenwert Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie der Wert eines -Knotens aktualisiert wird.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?newValue=cdcdc&fullNamePath=%2FtestApp%2Fdeployables%2FDe
velopment-1%2Fcdi45&changesetNumber=Chset-5" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'

Ergebnis zurückgeben:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}