engine:procedures:im_gettreenodeinformation

Inhaltsverzeichnis

im_GetTreeNodeInformation_Pu

im_GetTreeNodeInformation_Pu

Gibt diverse Informationen zu einem Element des Artikelbaums aus.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Tree, Node, Information, Pu]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
NodeOrTreeNodeID		Je nach „IsTreeNodeID“ entweder die ID eines Artikel-Elementes oder die ID eines Elementes im Artikelbaum, zu dem Informationen ausgegeben werden sollen	integer	5.1.2
IsTreeNodeID	1	Um was handelt es sich bei „NodeOrTreeNodeID“ ? „0“ : Bei der angegebenen ID handelt es sich um ein Artikel-Element („NodeID“ aus der Tabelle „dStore“) „1“ : Die ID ist ein Element des Artikelbaums („TreeNodeID“ aus „TreeView“)	bit	5.1.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
NodeID	ID des zur „TreeNodeID“ zugehörigen Artikel-Elementes - entspricht im Fall „IsTreeNodeID = 0“ dem Wert von „NodeOrTreeNodeID“	integer	5.1.2
TreeNodeID	ID eines Elementes im Artikelbaum - entspricht im Fall „IsTreeNodeID = 1“ dem Wert von „NodeOrTreeNodeID“	integer	5.1.2
Predecessor	ID des Vorgängers von „TreeNodeID“	integer	5.1.2
InheritsFrom	ID eines Elementes im Artikelbaum, VON dem „TreeNodeID“ Eigenschaften erbt	integer	5.1.2
SymbolID	ID eines Symbols, das der „NodeID“ zugeordnet ist	smallint	5.1.2
LevelID	ID der Hierarchie der „NodeID“	tinyint	5.1.2
LevelNo	Nummer der Hierarchie der „NodeID“	tinyint	5.1.2

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-569	Der Benutzer hat kein Ausführungsrecht für die Prozedur	nur indirekt
-567	Die Prozedur darf z. Zt. nicht ausgeführt werden	nur indirekt
-566	Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden	nur indirekt
-535	Das Datum liegt nicht in der Vergangenheit	nur indirekt
-530	Der Wert ist nicht konvertierbar	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-504	Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen	nur indirekt
-500	Falsche Parameter	direkt und indirekt
-120	Der Benutzer hat keine Berechtigung für das (die) Element(e)	nur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7	2015-01-29	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
5.5.2	2008-10-21	1. Neue Rückgabespalte „NodeDescription“ 2. Quellcode-Anpassung an den aktuellen Standard
5.1.2	2006-06-26	Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

im_GetTreeNodeInformation_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetTreeNodeInformation_Pu?NodeOrTreeNodeID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetTreeNodeInformation_Pu?NodeOrTreeNodeID=<value>' | xmllint --format -

dStore_php

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'im_GetTreeNodeInformation_Pu',
		array(
			'NodeOrTreeNodeID' => <value>,
			// 'IsTreeNodeID' => 1
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="im_GetTreeNodeInformation_Pu">
			<Parameters>
				<Parameter Name="NodeOrTreeNodeID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="IsTreeNodeID">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org