engine:procedures:im_getdirectsuccessors_tree_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:im_getdirectsuccessors_tree_pu [11.01.2016 ] |
engine:procedures:im_getdirectsuccessors_tree_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_GetDirectSuccessors_Tree_Pu ===== | ||
| + | |||
| + | Prozedur für eine einfache Darstellung eines Teilbereichs des Artikelbaums. Im Gegensatz zu [[dstoreproc>im_GetDirectSuccessors_Pu]] werden nicht nur die direkten Nachfolger eines Elementes ("TreeNodeID") ausgegeben, sondern auch die "Nachbar"-Elemente sowie die Vorgänger und deren "Nachbar"-Elemente.\\ | ||
| + | |||
| + | Die Ergebnismenge enthält die Elemente des Teilbereichs in der Reihenfolge, wie sie bei einer Traversierung des Artikelbaums entsteht.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[im Get Direct Successors Tree Pu]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
| + | |||
| + | ==== Parameter ==== | ||
| + | |||
| + | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |__TreeNodeID__| |ID eines Elementes im Artikelbaum, für den der zugehörige Teilbereich des Artikelbaums angezeigt werden soll\\ |integer|3.5.0| | ||
| + | |LanguageID|0 |ID einer Sprache, in der die Bezeichnungen der Artikelelemente erscheinen sollen\\ |tinyint|3.5.0| | ||
| + | |FilterByCharacteristicID|NULL |Nur Elemente, die "FilterByCharacValue" als Eigenschaft zum Merkmal "FilterByCharacteristicID" haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)\\ |smallint|3.5.11| | ||
| + | |FilterByCharacValue|NULL |Nur Elemente, die "FilterByCharacValue" als Eigenschaft zum Merkmal "FilterByCharacteristicID" haben. (Achtung: Hierbei wird keine Vererbung berücksichtigt)\\ |varchar(1000)|3.5.11| | ||
| + | |ApplyFilterForAllNodes|1 |Bezieht sich auf die Parameter "FilterBy..."\\ "0" : Gefiltert werden nur die DIREKTEN Nachfolger von "TreeNodeID"\\ "1" : Der Filter soll auf ALLE Elemente angewendet werden, also inklusive der Geschwisterknoten der Vorgänger\\ |bit|3.5.11| | ||
| + | |NegateFilterByParams|0 |Wird nur berücksichtigt, falls die "FilterBy..."-Parameter angegeben sind ! Bei Angabe von "1" für diesen Parameter sind nur Elemente in der Rückgabemenge, die die Eigenschaft "FilterByCharacValue" zum Merkmal "FilterByCharacteristicID" NICHT haben.\\ |bit|4.0.2| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |NodeDescription|Bezeichnung der "NodeID"\\ |varchar(100)|3.5.0 | | ||
| + | |TreeNodeID|ID eines Elementes im Artikelbaum\\ |integer|3.5.0 | | ||
| + | |Predecessor|ID des Vorgängers von "TreeNodeID"\\ |integer|3.5.0 | | ||
| + | |LevelNo|Nummer der Hierarchie der "NodeID"\\ |tinyint|3.5.0 | | ||
| + | |TreeLevel|Anzahl Vorgänger von "TreeNodeID" plus 1\\ |tinyint|3.5.0 | | ||
| + | |HasSuccessors|Hat "TreeNodeID" selbst Nachfolger ?\\ |bit|3.5.0 | | ||
| + | |HasNextSibling|Gibt es ein nächstes "Geschwister-Element", also ein anderes Element des Artikelbaums, das ebenfalls "Predecessor" als Vorgänger hat und dessen "SortNo" um 1 niedriger ist als die "SortNo" von "TreeNodeID" ?\\ |bit|3.5.0 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt| | ||
| + | |-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| | ||
| + | |-550|Fehlender oder falscher Eintrag in Settings|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| | ||
| + | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
| + | |-500|Falsche Parameter|direkt und indirekt| | ||
| + | |-283|Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln|nur direkt| | ||
| + | |-120|Der Benutzer hat keine Berechtigung für das (die) Element(e)|nur direkt| | ||
| + | |-110|Das (die) Element(e) ist (sind) nicht vorhanden|nur indirekt| | ||
| + | ==== XML-Schema ==== | ||
| + | |||
| + | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
| + | ==== Historie ==== | ||
| + | |||
| + | |7.0.7 |2015-01-29|"Start-/Finish-Procedure"-Logik eingebaut, s. Ticket #3670\\ | | ||
| + | |7.0.1 |2013-08-07|1. Datentyp-Erweiterung des Parameters "FilterByCharacValue" [von 100 auf 1000]\\ 2. Anpassungen des Quellcodes an den aktuellen Standard\\ | | ||
| + | |5.1.5 |2006-08-29|Fehler : "LockedNodeCharacteristics" wurde bisher GAR NICHT beachtet !\\ | | ||
| + | |5.1.2 |2006-06-26|1. Optimierung des Zugriffs auf "NodeProperties"\\ 2. Konsequente Fehlerbehandlung\\ 3. Die Sortierung der Rückgabemenge ist im ASE 15 ohne explizites "ORDER BY" nicht gewährleistet => entspr. Änderungen\\ | | ||
| + | |5.1.1 |2006-04-05|1. Optimierung des Zugriffs auf "NodeProperties" (bedingt durch die Änderung dieser Tabelle in 5.1.0)\\ 2. Konsequente Fehlerbehandlung\\ | | ||
| + | |4.0.2 |2003-06-11|1. Neuer Parameter "NegateFilterByParams"\\ 2. Kleiner Fehler beim Parameter-Check bzgl. der "FilterBy..."-Parameter\\ | | ||
| + | |4.0.1 |2003-05-16|Ab jetzt wird berücksichtigt, daß in "NodeProperties" auch Gültigkeitszeiträume in der Zukunft vorhanden sein können !\\ | | ||
| + | |3.5.19 |2002-06-17|\\ | | ||
| + | |3.5.11 |2001-09-06|\\ | | ||
| + | |3.5.6 |2001-04-17|\\ | | ||
| + | |3.5.0 |2000-11-23|\\ | | ||
| + | |||
| + | ==== Code-Snippets ==== | ||
| + | |||
| + | == Engine Playground == | ||
| + | Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist: | ||
| + | * [[http://playground.dstore.de/index.php?proc=im_GetDirectSuccessors_Tree_Pu|im_GetDirectSuccessors_Tree_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetDirectSuccessors_Tree_Pu?TreeNodeID=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetDirectSuccessors_Tree_Pu?TreeNodeID=<value>' | xmllint --format -</code>== dStore_php == | ||
| + | <code 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_GetDirectSuccessors_Tree_Pu', | ||
| + | array( | ||
| + | 'TreeNodeID' => <value>, | ||
| + | // 'LanguageID' => 0, | ||
| + | // 'FilterByCharacteristicID' => NULL, | ||
| + | // 'FilterByCharacValue' => NULL, | ||
| + | // 'ApplyFilterForAllNodes' => 1, | ||
| + | // 'NegateFilterByParams' => 0 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | </code> | ||
| + | == engine/execute == | ||
| + | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
| + | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <ListOfBatches> | ||
| + | <Batch No="0"> | ||
| + | <Procedure Name="im_GetDirectSuccessors_Tree_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="TreeNodeID"><!-- integer value --></Parameter> | ||
| + | <!-- <Parameter Name="LanguageID">0</Parameter> --> | ||
| + | <!-- <Parameter Name="FilterByCharacteristicID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="FilterByCharacValue">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ApplyFilterForAllNodes">1</Parameter> --> | ||
| + | <!-- <Parameter Name="NegateFilterByParams">0</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_getdirectsuccessors_tree_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)