CdmEditorApi

CdmEditorApi – DELETE /sn_cdm/editor/nodes

Löscht einen angegebenen Knoten.

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/nodes

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

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“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
fullNamePath	Erforderlich. Pfadname des zu löschenden Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. So löschen Sie beispielsweise den folgenden Knoten `testApp/deployables/Development1/cdi1`: 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: testAppdeployablesDevelopment1cdi1 Array: ['testApp','bereitstellbare Elemente','Entwicklung1','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-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 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 Aufrufer dieses Endpunkts muss über die Rolle „CDM-Betrachter“ verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/includes

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

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“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. 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
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. So geben Sie beispielsweise die Includes für den Knoten „ `collectionA` “ im Verzeichnis „testApp/collections“ zurück : Format des umgekehrten Schrägstrichs: 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 Collections CollectionA 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-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 Antwort-Haupttexts


Name	Beschreibung
changeset_id	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. false: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, der Typ des erkannten Konflikts. 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 incomplete_renamed_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unnamed_include update_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (konvertiert in eine lange Ganzzahl), zu dem der Knoten als Teil des Changesets festgeschrieben wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Ganzzahl
effektiv_zu	Zeitstempel (konvertiert in eine lange Ganzzahl) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „null“. Datentyp: 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
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Zum Beispiel hat der Knoten /AppA/components/compA 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 in der Ordnerhierarchie zu suchen. Zum Beispiel hat ein bereitstellbares Element 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 mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Für 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" }`
eingeschränkt_zu	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten 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) zurückgegeben. Ein Benutzer muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt anweisen, diese Felder nicht zurückzugeben, 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. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: true: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
type	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 im Quellpfad /testApp/collections/collA enthaltenen abgerufen 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 eine Liste von untergeordneten Configuration Data Management -Knoten (CDM) für einen angegebenen übergeordneten Knoten zurück.

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/nodes

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

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“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
entschlüsselnPasswort	Kennzeichnung, die angibt, ob der Wert für die Blattknoten 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 in dem sich der im Parameter name angegebene Knoten befindet. Sie können den Namenspfad in einem der folgenden Formate übergeben. So geben Sie beispielsweise die Knoten für den Knoten „ `collectionA` “ im Verzeichnis „testApp/collections“ zurück : Format des umgekehrten Schrägstrichs: 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 Collections CollectionA 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
type	Knotentyp Mögliche Werte: sn_cdm_node_cdi ODER cdi sn_cdm_node_collection OR-Sammlung sn_cdm_node_component ODER-Komponente sn_cdm_node_folder OR-Ordner sn_cdm_node_variable OR-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-Antwortcodesder 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	Ruft 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
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. false: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, der Typ des erkannten Konflikts. 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 incomplete_renamed_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unnamed_include update_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (konvertiert in eine lange Ganzzahl), zu dem der Knoten als Teil des Changesets festgeschrieben wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Ganzzahl
effektiv_zu	Zeitstempel (konvertiert in eine lange Ganzzahl) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „null“. Datentyp: 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
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Zum Beispiel hat der Knoten /AppA/components/compA 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 in der Ordnerhierarchie zu suchen. Zum Beispiel hat ein bereitstellbares Element 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 mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Für 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	Ruft die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
reason_for_conflict	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
eingeschränkt_zu	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt `"restricted_to": { "link": "String", "value": "String" }`
eingeschränkt_zu.link	Ruft die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
eingeschränkt_zu.Wert	Sys_id des Gruppendatensatzes. Befindet sich in der Tabelle „CDM-Gruppe“ [sys_user_group]. Datentyp: Zeichenfolge
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (Maskiert zurückgegeben) zurückgegeben. Ein Benutzer muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt anweisen, diese Felder nicht zurückzugeben, 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: true: 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 Benutzers, 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. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
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
type	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 Einschließen eines Knotens hat der neue Knoten eine eigene eindeutige sys_id und main_Id.

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/includes

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

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. Befindet sich in der Tabelle „CDM-Änderungssatz“ [sn_cdm_changeset]. 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
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/cdi1 einzubeziehen`: Backslash-Format: 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: Bereitstellungsbereitstellbare Elemente Entwicklung1 cdi1 Array: ['Staging','bereitstellbare Elemente','Entwicklung1','cdi1'] Datentyp: Zeichenfolge
targetFullNamePath	Erforderlich. Pfadname des Knotens, unter dem der Quellknoten eingefügt werden soll. Sie können den Namenspfad in einem der folgenden Formate übergeben. Um beispielsweise den folgenden Knoten `„Production/deployables/Development1“ einzubeziehen`: Backslash-Format: Produktion/bereitstellbare Elemente/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 ElementeEntwicklung1CDI1 Array: ['Produktion','bereitstellbare Elemente','Entwicklung1','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-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
changeset_id	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. false: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, der Typ des erkannten Konflikts. 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 incomplete_renamed_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unnamed_include update_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (konvertiert in eine lange Ganzzahl), zu dem der Knoten als Teil des Changesets festgeschrieben wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Ganzzahl
effektiv_zu	Zeitstempel (konvertiert in eine lange Ganzzahl) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „null“. Datentyp: 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
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Zum Beispiel hat der Knoten /AppA/components/compA 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 in der Ordnerhierarchie zu suchen. Zum Beispiel hat ein bereitstellbares Element 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 mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Für 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" }`
eingeschränkt_zu	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten 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) zurückgegeben. Ein Benutzer muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt anweisen, diese Felder nicht zurückzugeben, 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. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
system_folder	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: true: Knoten ist ein Systemordner. false: Knoten ist kein Systemordner. Datentyp: Boolesch
type	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_1 eingebunden 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, Konfigurationsdatenelement (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 über die Rolle „CDM-Editor“ oder „CDM-Geheimnis“ verfügen.

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/nodes

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

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: true: Nicht vorhandene übergeordnete Elemente automatisch erstellen. false: Nicht vorhandene übergeordnete Elemente nicht automatisch erstellen. Datentyp: Boolesch Standardwert: false
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
fullNamePath	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. So definieren Sie beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`: 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: testAppdeployablesDevelopment1cdi1 Array: ['testApp','bereitstellbare Elemente','Entwicklung1','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 Blattknoten verschlüsselt werden soll. Gültige Werte: true: Verschlüsselt false: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
type	Erforderlich. Typ des neuen Knotens. Gültige Werte: sn_cdm_node_collection OR-Sammlung sn_cdm_node_component ODER-Komponente sn_cdm_node_folder OR-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-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
changeset_id	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	Ruft 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
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. false: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, der Typ des erkannten Konflikts. 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 incomplete_renamed_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unnamed_include update_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (konvertiert in eine lange Ganzzahl), zu dem der Knoten als Teil des Changesets festgeschrieben wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Ganzzahl
effektiv_zu	Zeitstempel (konvertiert in eine lange Ganzzahl) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „null“. Datentyp: 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
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Zum Beispiel hat der Knoten /AppA/components/compA 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 in der Ordnerhierarchie zu suchen. Zum Beispiel hat ein bereitstellbares Element 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 mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Für 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	Ruft die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
reason_for_conflict	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
eingeschränkt_zu	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt `"restricted_to": { "link": "String", "value": "String" }`
eingeschränkt_zu.link	Ruft die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
eingeschränkt_zu.Wert	Sys_id des Gruppendatensatzes. Befindet sich in der Tabelle „CDM-Gruppe“ [sys_user_group]. Datentyp: Zeichenfolge
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (Maskiert zurückgegeben) zurückgegeben. Ein Benutzer muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt anweisen, diese Felder nicht zurückzugeben, 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: true: 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 Benutzers, 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. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
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
type	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 ein Knoten mit diesem Endpunkt erstellt wird.

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 Wert eines angegebenen Knotens.

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_version}/editor/nodes

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

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“. Befindet sich in der Tabelle „CDMChangeset“ [sn_cdm_changeset]. Datentyp: Zeichenfolge
fullNamePath	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. So definieren Sie beispielsweise den Namenspfad für den Knoten `testApp/deployables/Development1/cdi1`: 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: testAppdeployablesDevelopment1cdi1 Array: ['testApp','bereitstellbare Elemente','Entwicklung1','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 Blattknoten 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-Antwortcodesder 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	Ruft 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
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: true: Konflikt erkannt. false: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
konflikttyp	Wenn der Parameter conflict auf „true“ festgelegt ist, der Typ des erkannten Konflikts. 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 incomplete_renamed_ref ungültig_include verwaiste_descendant related_conflict unlinked_include unnamed_include update_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
effektiv_von	Zeitstempel (konvertiert in eine lange Ganzzahl), zu dem der Knoten als Teil des Changesets festgeschrieben wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Ganzzahl
effektiv_zu	Zeitstempel (konvertiert in eine lange Ganzzahl) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „null“. Datentyp: 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
Fehler.Nachricht	Fehlermeldung, die beim Versuch, die Anforderung zu verarbeiten, generiert wurde. Datentyp: Zeichenfolge
level	Ebene des Knotens, beginnend mit dem Stammknoten, der immer 0 ist. Zum Beispiel hat der Knoten /AppA/components/compA 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 in der Ordnerhierarchie zu suchen. Zum Beispiel hat ein bereitstellbares Element 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 mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Für 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	Ruft die Syntax zum Abfragen dieses Knotendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
previous_version.value	Sys_id des Knotendatensatzes. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
reason_for_conflict	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
eingeschränkt_zu	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt `"restricted_to": { "link": "String", "value": "String" }`
eingeschränkt_zu.link	Ruft die Syntax zum Abfragen dieses Gruppendatensatzes mit der Tabellen -REST-API auf. Datentyp: Zeichenfolge
eingeschränkt_zu.Wert	Sys_id des Gruppendatensatzes. Befindet sich in der Tabelle „CDM-Gruppe“ [sys_user_group]. Datentyp: Zeichenfolge
Secure_value	Wenn dieser Wert als gesichert gekennzeichnet wurde, wird das verschlüsselte Feld (Maskiert zurückgegeben) zurückgegeben. Ein Benutzer muss über die Rolle sn_cdm.cdm_secrets verfügen, um diese Informationen zu entschlüsseln. Sie können den Endpunkt anweisen, diese Felder nicht zurückzugeben, 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: true: 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 Benutzers, 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. Befindet sich in der Tabelle „CDM-Knoten“ [sn_cdm_node]. Datentyp: Zeichenfolge
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
type	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 
  } 
}