CdmEditorApi

Die CdmEditorApi Stellt Endpunkte bereit, mit denen Sie Knoten erstellen, Knoten aktualisieren, vorhandene Knoten unter anderen Knoten einschließen, Knoten löschen und Knoten und Knoteneinbindungen abrufen können.

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

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

Um verschlüsselte Felder anzuzeigen, müssen Sie über die Rolle „CDM-Geheimnis“ verfügen.

Darüber hinaus die Konfigurationsdaten-Management Das Plugin (CDM) muss 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: LÖSCHEN SIE /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

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

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

Tabelle : 2. Abfrageparameter

Name	Beschreibung
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
FullNamePath	Erforderlich. Pfadname des zu löschenden Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Beispiel: Um den folgenden Knoten zu löschen TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Umgekehrtes Schrägstrichformat: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1​​cdi1 Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] 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 REST API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

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: /sn_cdm/Editor/include ABRUFEN

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

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Editor/include

Standard-URL: /api/sn_cdm/Editor/include

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

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

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter

Name	Beschreibung
changesetNumber	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt
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. Zum Beispiel, um die -Einbindungen für zurückzugeben SammlungA Knoten in TestApp/Sammlungen Verzeichnis: Umgekehrtes Schrägstrichformat: TestApp/Sammlungen/SammlungA Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp-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 REST API-HTTP-Antwortcodes .

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
changeset_ID	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. 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: Wahr: Konflikt erkannt. Falsch: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Conflict_type	Wenn conflictParameter ist „wahr“, der Typ des erkannten Konflikts. Null, wenn kein Konflikt erkannt wird. Mögliche Werte: Corrupted_node Deleted_node Duplicate_node Unvollständig_gelöscht_übergeordnet Unvollständig_gelöscht_ref Unvollständig_umbenannt_ref INVALID_include Verwaiste_descendant Related_conflict Unlinked_include Unenamed_include Updated_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
Effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), zu dem der Knoten als Teil des Changesets bestätigt wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
Effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „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" }
error.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 der Knoten /APPA/components/compa Hat zwei Ebenen. Datentyp: Zeichenfolge
Linked_to	Die main_idParameter 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 verwenden CdmQuery() Skripteinbindung zum Abrufen einer JSON-Struktur. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
Main_ID_encoded	RADIX 57-Zeichenfolgendarstellung der Knoten main_idParameter. Datentyp: Zeichenfolge
name	Name des Knotens, der unter dem Zielpfad enthalten war. Datentyp: Zeichenfolge
Node_Classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten in der Ordnerhierarchie zu suchen. Beispielsweise hätte ein bereitstellbares Element eine Hierarchie von /Application/proviyables/env:Development Während eine Sammlung eine Hierarchie von hat /Applications/Collections Datentyp: Zeichenfolge
Node_path	Vollständiger Pfadname des Knotens, der im Zielpfad enthalten war, z. B. /Production/bereitstellbare/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 in diesem Fall ein komplexes Objekt unter einem Array hochgeladen wird {"cdi1": 1} , Der Endpunkt erstellt einen neuen virtuellen Knoten mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Includes ist die Position immer leer. Datentyp: Zeichenfolge
Vorherige_Version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, wird der Endpunkt zurückgegeben „Previous_Version“ = null Für diesen Parameter. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Restricted_to	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). Ein Anwender 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 festlegen returnFieldsAbfrageparameterfeld. 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]
Systemordner	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: Wahr: Knoten ist ein Systemordner. Falsch: 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 Einbindungen im Quellpfad abgerufen werden /TestApp/Collections/colla .

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: /sn_cdm/Editor/nodes ABRUFEN

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

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Editor/nodes

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

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

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

Tabelle : 14. Abfrageparameter

Name	Beschreibung
changesetNumber	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Entschlüsseln Sie das Passwort	Kennzeichnung, die angibt, ob der Wert für die Blattknoten verschlüsselt werden soll. Gültige Werte: Wahr: Verschlüsselt Falsch: 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 für den der in angegebene Knoten angegeben ist nameParameter befindet sich. Sie können den Namenspfad in einem der folgenden Formate übergeben. Beispiel: Um die Knoten für zurückzugeben SammlungA Knoten in TestApp/Sammlungen Verzeichnis: Umgekehrtes Schrägstrichformat: TestApp/Sammlungen/SammlungA Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp-SammlungA ​ Array: ['TestApp','Collections','collectionA'] Datentyp: Zeichenfolge
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder 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 ODER Collection sn_cdm_node_component ODER component sn_cdm_node_folder ODER Folder 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 REST API-HTTP-Antwortcodes .

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	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: Wahr: Konflikt erkannt. Falsch: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Conflict_type	Wenn conflictParameter ist „wahr“, der Typ des erkannten Konflikts. Null, wenn kein Konflikt erkannt wird. Mögliche Werte: Corrupted_node Deleted_node Duplicate_node Unvollständig_gelöscht_übergeordnet Unvollständig_gelöscht_ref Unvollständig_umbenannt_ref INVALID_include Verwaiste_descendant Related_conflict Unlinked_include Unenamed_include Updated_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
Effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), zu dem der Knoten als Teil des Changesets bestätigt wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
Effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „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" }
error.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 der Knoten /APPA/components/compa Hat zwei Ebenen. Datentyp: Zeichenfolge
Linked_to	Die main_idParameter 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 verwenden CdmQuery() Skripteinbindung zum Abrufen einer JSON-Struktur. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
Main_ID_encoded	RADIX 57-Zeichenfolgendarstellung der Knoten main_idParameter. 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. Beispielsweise hätte ein bereitstellbares Element eine Hierarchie von /Application/proviyables/env:Development Während eine Sammlung eine Hierarchie von hat /Applications/Collections 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 in diesem Fall ein komplexes Objekt unter einem Array hochgeladen wird {"cdi1": 1} , Der Endpunkt erstellt einen neuen virtuellen Knoten mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Includes ist die Position immer leer. Datentyp: Zeichenfolge
Vorherige_Version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, wird der Endpunkt zurückgegeben „Previous_Version“ = null Für diesen Parameter. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Previous_Version.Link	Aufrufsyntax zum Abfragen dieses Knotendatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Previous_Version.value	SYS_ID des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Grund_für_Konflikt	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
Restricted_to	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
Restricted_to.Link	Aufrufsyntax zum Abfragen dieses Gruppendatensatzes mit Tabelle REST-API. 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 anweisen, diese Felder nicht zurückzugeben, indem Sie festlegen returnFieldsAbfrageparameterfeld. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
Systemordner	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: Wahr: Knoten ist ein Systemordner. Falsch: 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 Anwenders, 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 abgerufen werden /TestApp/Fprovisionables/Development_1 Übergeordneter Knoten.

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

Schließt einen vorhandenen Knoten in einen anderen Knoten ein, z. B. einen Komponentenknoten in einem Sammlungsknoten oder einen Sammlungsknoten in einem bereitstellbaren Knoten. Nach dem Einbeziehen eines Knotens hat der neue Knoten seine 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/include

Standard-URL: /api/sn_cdm/Editor/include

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

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

Tabelle : 20. Abfrageparameter

Name	Beschreibung
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 Namen der Datensatzspalte, z. B. 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. Zum Beispiel, um den folgenden Knoten einzubeziehen Bereitstellung/bereitstellbare Elemente/Entwickler1/cdi1 : Umgekehrtes Schrägstrichformat: Bereitstellung/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: Bereitstellung bereitstellbarer Elemente​Entwickler1 cdi1 ​​ Array: ['Staging','bereitstellbare Elemente','Development1','cdi1'] Datentyp: Zeichenfolge
TargetFullNamePath	Erforderlich. Pfadname des Knotens, unter dem der Quellknoten aufgenommen werden soll. Sie können den Namenspfad in einem der folgenden Formate übergeben. Zum Beispiel, um den folgenden Knoten einzubeziehen Produktion/bereitstellbare Elemente/Entwickler1 : Umgekehrtes Schrägstrichformat: Produktion/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: In der Produktion bereitstellbare​Entwicklung1​​cdi1 Array: ['Produktion','bereitstellbare Elemente','Entwickler1','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 REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
changeset_ID	Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. 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: Wahr: Konflikt erkannt. Falsch: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Conflict_type	Wenn conflictParameter ist „wahr“, der Typ des erkannten Konflikts. Null, wenn kein Konflikt erkannt wird. Mögliche Werte: Corrupted_node Deleted_node Duplicate_node Unvollständig_gelöscht_übergeordnet Unvollständig_gelöscht_ref Unvollständig_umbenannt_ref INVALID_include Verwaiste_descendant Related_conflict Unlinked_include Unenamed_include Updated_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
Effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), zu dem der Knoten als Teil des Changesets bestätigt wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
Effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „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" }
error.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 der Knoten /APPA/components/compa Hat zwei Ebenen. Datentyp: Zeichenfolge
Linked_to	Die main_idParameter 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 verwenden CdmQuery() Skripteinbindung zum Abrufen einer JSON-Struktur. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
Main_ID_encoded	RADIX 57-Zeichenfolgendarstellung der Knoten main_idParameter. Datentyp: Zeichenfolge
name	Name des Knotens, der unter dem Zielpfad enthalten war. Datentyp: Zeichenfolge
Node_Classifier	Klassifiziererhierarchie des Knotens. Verwenden Sie diese Informationen, um einen Knoten in der Ordnerhierarchie zu suchen. Beispielsweise hätte ein bereitstellbares Element eine Hierarchie von /Application/proviyables/env:Development Während eine Sammlung eine Hierarchie von hat /Applications/Collections Datentyp: Zeichenfolge
Node_path	Vollständiger Pfadname des Knotens, der im Zielpfad enthalten war, z. B. /Production/bereitstellbare/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 in diesem Fall ein komplexes Objekt unter einem Array hochgeladen wird {"cdi1": 1} , Der Endpunkt erstellt einen neuen virtuellen Knoten mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Includes ist die Position immer leer. Datentyp: Zeichenfolge
Vorherige_Version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, wird der Endpunkt zurückgegeben „Previous_Version“ = null Für diesen Parameter. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Restricted_to	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). Ein Anwender 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 festlegen returnFieldsAbfrageparameterfeld. 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]
Systemordner	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: Wahr: Knoten ist ein Systemordner. Falsch: 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 einbezogen wird /TestApp/Collections/colla Unter /TestApp/bereitstellbare Elemente/Entwicklung_1 .

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 (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“ haben.

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Editor/nodes

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

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

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

Tabelle : 26. Abfrageparameter

Name	Beschreibung
AutoCreateParents	Kennzeichnung, die angibt, ob die nicht vorhandenen übergeordneten Elemente im Namenspfad automatisch als Komponenten erstellt werden sollen. Ausnahmen davon sind die App, das bereitstellbare Element und die Sammlung. Wenn Sie diese Kennzeichnung nicht festlegen und die übergeordneten Elemente nicht bereits vorhanden sind, schlägt der Endpunkt fehl. Gültige Werte: Wahr: Die nicht vorhandenen übergeordneten Elemente werden automatisch erstellt. Falsch: Nicht vorhandene übergeordnete Elemente nicht automatisch erstellen. Datentyp: Boolesch Standardwert: false
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
FullNamePath	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Umgekehrtes Schrägstrichformat: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1​​cdi1 Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Datentyp: Zeichenfolge
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder 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: Wahr: Verschlüsselt Falsch: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
type	Erforderlich. Typ des neuen Knotens. Gültige Werte: sn_cdm_node_Collection ODER Collection sn_cdm_node_component ODER component sn_cdm_node_folder ODER Folder 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 REST API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts

Name	Beschreibung
changeset_ID	Details des Changeset-Datensatzes, der dem Knoten zugeordnet ist. Datentyp: Objekt "changeset_id": { "link": "String", "value": "String" }
changeset_ID.Link	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: Wahr: Konflikt erkannt. Falsch: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Conflict_type	Wenn conflictParameter ist „wahr“, der Typ des erkannten Konflikts. Null, wenn kein Konflikt erkannt wird. Mögliche Werte: Corrupted_node Deleted_node Duplicate_node Unvollständig_gelöscht_übergeordnet Unvollständig_gelöscht_ref Unvollständig_umbenannt_ref INVALID_include Verwaiste_descendant Related_conflict Unlinked_include Unenamed_include Updated_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
Effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), zu dem der Knoten als Teil des Changesets bestätigt wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
Effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „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" }
error.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 der Knoten /APPA/components/compa Hat zwei Ebenen. Datentyp: Zeichenfolge
Linked_to	Die main_idParameter 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 verwenden CdmQuery() Skripteinbindung zum Abrufen einer JSON-Struktur. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
Main_ID_encoded	RADIX 57-Zeichenfolgendarstellung der Knoten main_idParameter. 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. Beispielsweise hätte ein bereitstellbares Element eine Hierarchie von /Application/proviyables/env:Development Während eine Sammlung eine Hierarchie von hat /Applications/Collections 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 in diesem Fall ein komplexes Objekt unter einem Array hochgeladen wird {"cdi1": 1} , Der Endpunkt erstellt einen neuen virtuellen Knoten mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Includes ist die Position immer leer. Datentyp: Zeichenfolge
Vorherige_Version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, wird der Endpunkt zurückgegeben „Previous_Version“ = null Für diesen Parameter. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Previous_Version.Link	Aufrufsyntax zum Abfragen dieses Knotendatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Previous_Version.value	SYS_ID des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Grund_für_Konflikt	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
Restricted_to	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
Restricted_to.Link	Aufrufsyntax zum Abfragen dieses Gruppendatensatzes mit Tabelle REST-API. 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 anweisen, diese Felder nicht zurückzugeben, indem Sie festlegen returnFieldsAbfrageparameterfeld. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
Systemordner	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: Wahr: Knoten ist ein Systemordner. Falsch: 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 Anwenders, 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 Sie einen Knoten mit diesem Endpunkt 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: /sn_cdm/Editor/nodes PLATZIEREN

Aktualisiert den Namen und/oder Wert eines angegebenen Knotens.

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

URL-Format

Versionierte URL: /api/sn_cdm/{api_Version}/Editor/nodes

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

Hinweis:

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

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

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

Tabelle : 32. Abfrageparameter

Name	Beschreibung
changesetNumber	Erforderlich. Eindeutiger Bezeichner des zugeordneten Changesets, z. B. „Chset-10“. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
FullNamePath	Erforderlich. Pfadname des Knotens. Sie können den Namenspfad in einem der folgenden Formate übergeben. Beispiel: Um den Namenspfad für den Knoten zu definieren TestApp/bereitstellbare Elemente/Entwickler1/cdi1 : Umgekehrtes Schrägstrichformat: TestApp/bereitstellbare Elemente/Entwickler1/cdi1 Hinweis: Wenn Ihr Knotenname einen umgekehrten Schrägstrich ("/") enthält, können Sie dieses Format nicht verwenden. Back-End-Namenspfad mit Ersatzzeichen: TestApp bereitstellbare​Entwickler1​​cdi1 Array: ['TestApp','bereitstellbare Elemente','Development1','cdi1'] Datentyp: Zeichenfolge
NEWNAME	Neuer Name für den zugehörigen 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: Wahr: Verschlüsselt Falsch: Nicht verschlüsselt Datentyp: Boolesch Standardwert: false
returnFields	Liste der Felder, die als Teil der Antwort zurückgegeben werden sollen. Übergeben Sie die Namen der Datensatzspalte, z. B. sys_ID, sys_updated_by oder State. Datentyp: Array Standard: Alle Felder, wie vom Endpunkt bestimmt

Tabelle : 33. Anforderungstextparameter

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 34. Anforderungskopfzeilen

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

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	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	Aufrufsyntax zum Abfragen dieses Changeset-Datensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
changeset_ID.Wert	Eindeutiger Bezeichner des Changeset-Datensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Änderungssatz [sn_cdm_changeset]
Konflikt	Kennzeichnung, die angibt, ob bei der Verarbeitung des Knotens ein Konflikt aufgetreten ist. Mögliche Werte: Wahr: Konflikt erkannt. Falsch: Es wurde kein Konflikt erkannt. Datentyp: Boolesch
Conflict_type	Wenn conflictParameter ist „wahr“, der Typ des erkannten Konflikts. Null, wenn kein Konflikt erkannt wird. Mögliche Werte: Corrupted_node Deleted_node Duplicate_node Unvollständig_gelöscht_übergeordnet Unvollständig_gelöscht_ref Unvollständig_umbenannt_ref INVALID_include Verwaiste_descendant Related_conflict Unlinked_include Unenamed_include Updated_node Datentyp: Zeichenfolge
Beschreibung	Kurzbeschreibung des Zwecks des Knotens. Datentyp: Zeichenfolge
Effektiv_von	Zeitstempel (in eine lange Ganzzahl konvertiert), zu dem der Knoten als Teil des Changesets bestätigt wurde. Wenn der Knoten nicht bestätigt wurde, ist dieser Wert „null“. Datentyp: Zahl (Ganzzahl)
Effektiv_bis	Zeitstempel (in eine lange Ganzzahl konvertiert) des Knotens, wenn er entweder gelöscht oder durch einen anderen Knoten ersetzt wurde, andernfalls „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" }
error.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 der Knoten /APPA/components/compa Hat zwei Ebenen. Datentyp: Zeichenfolge
Linked_to	Die main_idParameter 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 verwenden CdmQuery() Skripteinbindung zum Abrufen einer JSON-Struktur. Beispiel: CdmQuery().mainId('123')/query().getTree(); Datentyp: Zeichenfolge
Main_ID_encoded	RADIX 57-Zeichenfolgendarstellung der Knoten main_idParameter. 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. Beispielsweise hätte ein bereitstellbares Element eine Hierarchie von /Application/proviyables/env:Development Während eine Sammlung eine Hierarchie von hat /Applications/Collections 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 in diesem Fall ein komplexes Objekt unter einem Array hochgeladen wird {"cdi1": 1} , Der Endpunkt erstellt einen neuen virtuellen Knoten mit dem Namen, der seiner Position entspricht. Im obigen Beispiel ist dies 2000. Bei Includes ist die Position immer leer. Datentyp: Zeichenfolge
Vorherige_Version	Details der vorherigen Version des Knotendatensatzes. Hinweis: Wenn ein neuer Knoten erstellt wurde, wird der Endpunkt zurückgegeben „Previous_Version“ = null Für diesen Parameter. Datentyp: Objekt "previous_version": { "link": "String", "value": "String" }
Previous_Version.Link	Aufrufsyntax zum Abfragen dieses Knotendatensatzes mit Tabelle REST-API. Datentyp: Zeichenfolge
Previous_Version.value	SYS_ID des Knotendatensatzes. Datentyp: Zeichenfolge Tabelle: CDM-Knoten [sn_cdm_node]
Grund_für_Konflikt	Detaillierte Erklärung des Konflikts. Datentyp: Zeichenfolge
Restricted_to	Details der Gruppe, die Zugriff auf den dem Knoten zugeordneten hat. Datentyp: Objekt "restricted_to": { "link": "String", "value": "String" }
Restricted_to.Link	Aufrufsyntax zum Abfragen dieses Gruppendatensatzes mit Tabelle REST-API. 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 anweisen, diese Felder nicht zurückzugeben, indem Sie festlegen returnFieldsAbfrageparameterfeld. Datentyp: Zeichenfolge
status	Knotenstatus Mögliche Werte: GELÖSCHT NEW ERSETZT AKTUALISIERT GÜLTIG Datentyp: Zeichenfolge
Systemordner	Kennzeichnung, die angibt, ob der zugeordnete Knoten ein Systemordner ist. Mögliche Werte: Wahr: Knoten ist ein Systemordner. Falsch: 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 Anwenders, 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 
  } 
}