Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getbinarycodeidsfornode_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getbinarycodeidsfornode_pu [11.01.2016 ]
engine:procedures:im_getbinarycodeidsfornode_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetBinaryCodeIDsForNode_Pu =====
 +
 +Liefert zu einem oder mehreren Artikel-Element(en) bzw. Element(en) des Artikelbaums die zugewiesenen "​BinaryCodeID"​s (IDs für "​Binaries"​).\\ ​
 +
 +Optional kann man sich nur "​BinaryCodeID"​s mit einer bestimmten bzw. mit irgendeiner Eigenschaft zu einem "​Binary"​-Merkmal ausgeben lassen. Daher ist es z.B. möglich, nur GIF-Dateien oder "​Detailansichten"​ eines Artikel-Elementes zu ermitteln.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Binary Code Ds For Node Pu]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|5.1.4 (2006-08-14)|
 +
 +==== 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 Artikel-Elementes ("​NodeID"​ aus "​dStore"​) bzw. eines Elementes im Artikelbaum ("​TreeNodeID"​ aus "​TreeView"​) - je nach "​IsNodeID"​. Wird "​NULL"​ angegeben erwartet die Prozedur IDs in "​tempdb.dbo.OneID"​.\\ |integer|3.5.0|
 +|BinaryPropertyValueID|NULL |Optionale Angabe einer Eigenschaft,​ die das Binärobjekt besitzen soll\\ |integer|3.5.0|
 +|IsNodeID|0 |Bei dem durch "​TreeNodeID"​ angegebenen Element bzw. den in "​tempdb.dbo.OneID"​ angegebenen Elementen handelt es sich um...\\ "​0"​ : ... eine "​TreeNodeID"​ bzw. "​TreeNodeID"​s aus "​TreeView"​\\ "​1"​ : ... eine "​NodeID"​ bzw. "​NodeID"​s aus "​dStore"​\\ |bit|3.5.0|
 +|BinaryCharacteristicID|NULL |ID eines Merkmals für "​Binaries"​. Falls angegeben, werden nur die "​BinaryCodeID"​s berücksichtigt,​ die (irgend)eine Eigenschaft zu diesem Merkmal besitzen - diese Eigenschaft wird dann auch jeweils im Ergebnis ausgegeben.\\ |tinyint|3.5.17|
 +==== Rückgabe ====
 +
 +=== wenn BinaryCharacteristicID = NULL ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|BinaryCodeID|ID eines "​Binaries",​ das dem Element "​TreeNodeID"​ zugeordnet ist\\ |integer|3.5.0 |
 +|TreeNodeID|ID des zum übergebenen Element zugehörigen Elementes im Artikelbaum (da es prinzipiell möglich ist, daß es zu einer "​NodeID"​ MEHRERE "​TreeNodeID"​s gibt, steht hier im Fall "​IsNodeID = 1" die KLEINSTE zur "​NodeID"​ gehörige "​TreeNodeID"​)\\ |integer|3.5.3 |
 +|NodeID|ID des zum übergebenen Element zugehörigen Artikel-Elementes (falls "​IsNodeID = 1" ist, steht hier natürlich immer die übergebene "​TreeNodeID"​)\\ |integer|3.5.3 |
 +
 +== Sortierungen der Rückgabe ==
 +
 +wenn IsNodeID = 0
 +  * TreeNodeID (aufsteigend)
 +wenn IsNodeID = 1
 +  * NodeID (aufsteigend)
 +
 +=== wenn BinaryCharacteristicID <> NULL ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|//​BinaryCharacteristicID((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|In Version 4.0.5 entfernt\\ |tinyint|3.5.17 |
 +|BinaryCodeID|ID eines "​Binaries",​ das dem Element "​TreeNodeID"​ zugeordnet ist\\ |integer|3.5.0 |
 +|TreeNodeID|ID des zum übergebenen Element zugehörigen Elementes im Artikelbaum (da es prinzipiell möglich ist, daß es zu einer "​NodeID"​ MEHRERE "​TreeNodeID"​s gibt, steht hier im Fall "​IsNodeID = 1" die KLEINSTE zur "​NodeID"​ gehörige "​TreeNodeID"​)\\ |integer|3.5.3 |
 +|NodeID|ID des zum übergebenen Element zugehörigen Artikel-Elementes (falls "​IsNodeID = 1" ist, steht hier natürlich immer die übergebene "​TreeNodeID"​)\\ |integer|3.5.3 |
 +|BinaryPropertyValueID|ID der Eigenschaft der "​BinaryCodeID"​ zum Merkmal "​BinaryCharacteristicID"​. Sofern auch "​BinaryPropertyValueID"​ angegeben wurde, steht hier der Wert dieses Parameters.\\ |integer|3.5.17 |
 +|BinaryPropertyValue|Die Eigenschaft der "​BinaryCodeID"​ zum Merkmal "​BinaryCharacteristicID"​\\ |varchar(250)|4.0.5 |
 +
 +== Sortierungen der Rückgabe ==
 +
 +wenn IsNodeID = 0
 +  * TreeNodeID (aufsteigend)
 +wenn IsNodeID = 1
 +  * NodeID (aufsteigend)
 +
 +==== 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|nur direkt|
 +==== 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 ====
 +
 +|5.1.4 |2006-08-14|Explizites "ORDER BY" eingefügt, um die Sortierung der Rückgabemenge zu garantieren\\ ​ |
 +|4.0.5 |2003-10-04|1. Fehler falls "​TreeNodeID"​ nicht "​NULL",​ "​IsNodeID = 1" und sowohl "​BinaryPropertyValueID"​ als auch "​BinaryCharacteristicID"​ "​NULL"​ waren\\ 2. Rückgabespalte "​BinaryCharacteristicID"​ entfernt\\ 3. Neue Rückgabespalte : "​BinaryPropertyValue"​\\ ​ |
 +|3.5.17 |2002-05-02|\\ ​ |
 +|3.5.16 |2002-04-25|\\ ​ |
 +|3.5.3 |2001-02-11|\\ ​ |
 +|3.5.0 |2000-11-23|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:
 +  * [[http://​playground.dstore.de/​index.php?​proc=im_GetBinaryCodeIDsForNode_Pu|im_GetBinaryCodeIDsForNode_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetBinaryCodeIDsForNode_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_GetBinaryCodeIDsForNode_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_GetBinaryCodeIDsForNode_Pu',​
 + array(
 + '​TreeNodeID'​ => <​value>,​
 + // '​BinaryPropertyValueID'​ => NULL,
 + // '​IsNodeID'​ => 0,
 + // '​BinaryCharacteristicID'​ => NULL
 + )
 +);
 +
 +$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_GetBinaryCodeIDsForNode_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​TreeNodeID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​BinaryPropertyValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​IsNodeID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​BinaryCharacteristicID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getbinarycodeidsfornode_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)