Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_gettreenodeinformation_ad

im_GetTreeNodeInformation_Ad

Gibt diverse Informationen zu einem Element des Artikelbaums aus.

Hinweis :
Gibt es das Element „TreeNodeID“ nicht, wird eine leere Ergebnismenge zurückgegeben und nicht etwa „-500“ !
Entsprechend gibt es auch im Fall „TreeNodeID = NULL“ KEINEN Fehler - ein nicht vorhandenes Element in „tempdb.dbo.OneID“ taucht dann eben auch nicht in der Ergebnismenge auf !

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieitem management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
TreeNodeID ID eines Elementes im Artikelbaum, zu dem die Informationen ausgegeben werden sollen. Ist „NULL“ angegeben, erwarten wir in „tempdb.dbo.OneID“ eine Menge von „TreeNodeID“s.
integer3.5.0
LanguageID0 ID einer Sprache, in der die Bezeichnungen des zur „TreeNodeID“ zugehörigen Artikel-Elementes ausgegeben werden soll; bei „LanguageID = 0“ wird die „DefaultLanguageID“ aus „Settings“ genommen.
tinyint3.5.0
GetAdditionalInformation1 Steuert, ob zusätzliche Rückgabespalten geliefert werden sollen („1“) oder nicht („0“)
bit5.1.10

Rückgabe

wenn GetAdditionalInformation = 1

Spaltenname Beschreibung SQL-Datentyp4) ab Version
NodeIDID des zur „TreeNodeID“ zugehörigen Artikel-Elementes
integer3.5.0
TreeNodeIDNochmal die übergebene „TreeNodeID“ (Richtig, diese Spalte ist eigentlich überflüssig)
integer3.5.0
PredecessorID des Vorgängers von „TreeNodeID“
integer5.1.10
InheritsFromID eines Elementes im Artikelbaum, VON dem „TreeNodeID“ Eigenschaften erbt
integer3.5.0
NodeDescriptionBezeichnung der „NodeID“
varchar(100)3.5.0
ActiveIst „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)
bit3.5.0
CountSuccessorsWieviele Nachfolger (egal ob aktiv oder nicht, egal ob gelöscht oder nicht) hat „TreeNodeID“
integer3.5.0
SymbolIDID eines Symbols, das der „NodeID“ zugeordnet ist
smallint3.5.0
LevelNoNummer der Hierarchie der „NodeID“
tinyint3.5.0
SortNoBestimmt die Reihenfolge von „TreeNodeID“ innerhalb aller „Nachbar“-Elemente von „TreeNodeID“ („Nachbar“-Elemente haben den gleichen Vorgänger)
smallint3.5.0
DeletedIst „TreeNodeID“ bereits gelöscht ? („0“ : Nein, „1“ : Ja)
bit4.0.15
LevelIDID der Hierarchie der „NodeID“
tinyint5.0.4
CountActiveSuccessorsAnzahl aktiver („Active = 1“) und nicht gelöschter („Deleted = 0“) Nachfolge-Elemente von „TreeNodeID“
integer5.0.4
CountDeletedSuccessorsAnzahl gelöschter („Deleted = 1“) Nachfolge-Elemente von „TreeNodeID“
integer5.0.4

wenn GetAdditionalInformation = 0

Spaltenname Beschreibung SQL-Datentyp5) ab Version
NodeIDID des zur „TreeNodeID“ zugehörigen Artikel-Elementes
integer5.1.10
TreeNodeIDNochmal die übergebene „TreeNodeID“ (Richtig, diese Spalte ist eigentlich überflüssig)
integer5.1.10
PredecessorID des Vorgängers von „TreeNodeID“
integer5.1.10
InheritsFromID eines Elementes im Artikelbaum, VON dem „TreeNodeID“ Eigenschaften erbt
integer5.1.10
NodeDescriptionBezeichnung der „NodeID“
varchar(100)5.1.10
ActiveIst „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja)
bit5.1.10
CountSuccessorsWieviele Nachfolger (egal ob aktiv oder nicht, egal ob gelöscht oder nicht) hat „TreeNodeID“
integer5.1.10
SymbolIDID eines Symbols, das der „NodeID“ zugeordnet ist
smallint5.1.10
LevelNoNummer der Hierarchie der „NodeID“
tinyint5.1.10
SortNoBestimmt die Reihenfolge von „TreeNodeID“ innerhalb aller „Nachbar“-Elemente von „TreeNodeID“ („Nachbar“-Elemente haben den gleichen Vorgänger)
smallint5.1.10
DeletedIst „TreeNodeID“ bereits gelöscht ? („0“ : Nein, „1“ : Ja)
bit5.1.10
LevelIDID der Hierarchie der „NodeID“
tinyint5.1.10

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochendirekt und indirekt
-500Falsche Parameternur indirekt
-120Der 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.2 2013-02-26Fehler : Bei der Überprüfung, ob eine „varchar“-Variable „voll“ ist, muß die Funktion „datalength“ [nicht
„char_length“] verwendet werden
5.5.1 2008-07-291. Berücksichtigung des neuen „Settings“-Eintrags „AssignmentMethodForListVariables“
2. Änderung der Ermittlung falls „TreeNodeID“ angegeben ist, damit die „Count…“-Rückgabespalten auch für ASE 15.0.2 korrekt sind
5.1.10 2007-03-121. Neuer Parameter „GetAdditionalInformation“
2. Neue Möglichkeit, MEHRERE IDs [via „OneID“] übergeben zu können
3. Neue Rückgabespalte „Predecessor“
5.1.0 2006-02-08Rückgabespalte „SortNo“ war fälschlicherweise in 5.0.4 ein „integer“ - jetzt ist es wieder ein „smallint“
5.0.4 2005-09-26Neue Rückgabespaltem „LevelID“, „CountActiveSuccessors“ und „CountDeletedSuccessors“
4.0.15 2004-07-30Neue Rückgabespalte „Deleted“
4.0.11 2004-03-311. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“
2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetTreeNodeInformation_Ad?TreeNodeID=<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_Ad',
		array(
			'TreeNodeID' => <value>,
			// 'LanguageID' => 0,
			// 'GetAdditionalInformation' => 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_Ad">
			<Parameters>
				<Parameter Name="TreeNodeID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="LanguageID">0</Parameter> -->
				<!-- <Parameter Name="GetAdditionalInformation">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/im_gettreenodeinformation_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)