engine:procedures:if_im_sorttreenodes
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:if_im_sorttreenodes [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== if_im_SortTreeNodes ===== | ||
| + | |||
| + | Fügt eine Menge von TreeNodeIDs in die Input-Schnittstelle von [[dstoreproc>im_SortTreeNodes_Pu]] ein.\\ | ||
| + | |||
| + | Die Parameter korrespondieren in wesentlichen mit den Spalten dieser Input-Tabelle :\\ | ||
| + | |||
| + | * TreeNodeID integer | ||
| + | -> ID eines Elementes im Artikelbaum, das innerhalb aller übergebenen IDs sortiert werden soll\\ | ||
| + | |||
| + | Wenn man erneut sortieren will, sollten evtl. von einem vorherigen Aufruf vorhandene IDs vorher\\ entfernt werden. Dazu ist "Delete" mit "1" zu belegen. Können nicht alle IDs (wg. der "varchar(255)"-Begrenzung)\\ eingefügt werden, ruft man diese Prozedur einfach erneut auf, dann aber logischerweise mit "Delete = 0" !\\ | ||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[if Sort Tree Nodes]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Änderung | | ||
| + | |Letzte Aktualisierung|6.5.4 (2013-04-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 ^ | ||
| + | |__TreeNodeIDList__| |Eine Liste von IDs (durch das in "Separator" übergebene Zeichen getrennt) von Elementen im Artikelbaum, die in die Spalte "TreeNodeID" (s. Beschreibung) der Input-Schnittstelle eingefügt werden\\ |varchar(255)|6.0.1| | ||
| + | |Delete|0 |Möchte man zuvor die Input-Schnittstelle leeren, setzt man "Delete" auf "1".\\ |bit|6.0.1| | ||
| + | |Separator|'¶' |Gibt an, durch welche Zeichen die Werte in den "Listen-"Parametern ("...List") getrennt sind\\ |varchar(4)|6.0.1| | ||
| + | |IgnoreInvalidIDs|0 |"1" angeben, um einen Fehler zu vermeiden, falls NICHT-existierende oder gelöschte (oder inaktive wenn der "publicuser" der Aufrufer ist) IDs in "TreeNodeIDList" übergeben werden (stattdessen werden solche IDs dann ignoriert)\\ |bit|6.5.4| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | Die Prozedur hat keine Rückgaben. | ||
| + | ==== 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")) ^ | ||
| + | |-500|Falsche Parameter|direkt und 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 ==== | ||
| + | |||
| + | |6.5.4 |2013-04-29|1. Neuer Parameter "IgnoreInvalidIDs"\\ 2. Ab jetzt gibt es auch einen Fehler, wenn INAKTIVE IDs übergeben werden falls der "publicuser" diese Prozedur\\ aufruft\\ | | ||
| + | |6.5.3 |2013-03-18|1. "Separator" wurde erweitert [von "1" auf "4"]\\ 2. Überflüssigen internen "_mi_GetUserInfo"-Aufruf entfernt\\ | | ||
| + | |6.0.2 |2011-06-08|"grant execute"-Statement ergänzt\\ | | ||
| + | |6.0.1 |2010-07-20|Erstmalig in dieser Version erstellt\\ | | ||
| + | |||
| + | ==== Code-Snippets ==== | ||
| + | |||
| + | Es handelt sich um eine Methode zum Füllen von Schnittstellentabelle wie in [[:engine:procedures-background#input_-tabellen|Hintergrundinformationen zu Engine-Prozeduren]] erläutert. Die Methode kann ausschließlich per engine/execute in einem gemeinsamen Batch mit komplementären Prozeduren verwendet werden.== 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="if_im_SortTreeNodes"> | ||
| + | <Parameters/> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/if_im_sorttreenodes.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)