Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getbinarycodeidsforvalue_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getbinarycodeidsforvalue_pu [11.01.2016 ]
engine:procedures:im_getbinarycodeidsforvalue_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetBinaryCodeIDsForValue_Pu =====
 +
 +Liefert zur Eigenschaft "​ValueID"​ die entsprechenden zugewiesenen "​BinaryCodeID"​s. Dabei kann optional nach einer "​BinaryPropertyValueID",​ also einer Eigenschaft der "​Binaries",​ gefiltert werden; z.B. können so nur alle GIFs oder nur alle Detailansichten zurückgegeben werden.\\ ​
 +
 +Ist statt der "​ValueID"​ nur die Eigenschaft und das zugehörige Merkmal bekannt, können die beiden Parameter "​Value"​ und "​NodeCharacteristicID"​ verwendet werden - für "​ValueID"​ ist dann "​NULL"​ zu übergeben.\\ ​
 +
 +Um sich "​BinaryCodeID"​s zu MEHREREN Eigenschaften zu holen, kann man die entsprechenden "​ValueID"​s auch via "​tempdb.dbo.OneID"​ übergeben und setzt "​ValueIDsInOneID"​ auf "​1"​. Sind die IDs nicht bekannt, gibt es auch die Möglichkeit,​ "​NodeCharacteristicID"​-"​Value"​-Paare in "​tempdb.dbo.AnyValues"​ anzugeben, wobei in diesem Fall"​ValuesInAnyValues"​ auf "​1"​ zu setzen ist.\\ ​
 +
 +Sowohl "​ValueIDsInOneID"​ als auch "​ValuesInAnyValues"​ auf "​1"​ zu setzen ist NICHT MÖGLICH !\\ 
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Binary Code Ds For Value Pu]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.8 (2015-08-21)|
 +
 +==== 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 ^
 +|__ValueID__| |ID einer Eigenschaft,​ die Artikel-Elemente haben können, und zu der die zugewiesenen "​Binaries"​ ermittelt werden sollen\\ |integer|3.5.0|
 +|BinaryPropertyValueID|NULL |ID einer Eigenschaft von "​Binaries",​ nach der optional gefiltert werden kann\\ |integer|3.5.0|
 +|Value|NULL |Wird nur beachtet, wenn "​NULL"​ für "​ValueID"​ angegeben UND eine ID in "​NodeCharacteristicID"​ übergeben wurde ! Wert einer Eigenschaft zum Merkmal "​NodeCharacteristicID",​ zu der "​Binaries"​ ermittelt werden sollen.\\ |varchar(1000)|3.5.18|
 +|NodeCharacteristicID|NULL |Wird nur beachtet, wenn "​NULL"​ für "​ValueID"​ angegeben wurde ! ID des Merkmals, zu dem die Eigenschaft "​Value"​ gehört (zu dem die "​Binaries"​ ermittelt werden sollen).\\ |smallint|3.5.18|
 +|ValueIDsInOneID|0 |Wenn auf "​1"​ gesetzt, dann befindet(n) sich eine (mehrere) ValueID(s) in "​tempdb.dbo.OneID",​ zu der (denen) "​Binaries"​ ermittelt werden soll(en)\\ |bit|3.5.22|
 +|ValuesInAnyValues|0 |Wenn auf "​1"​ gesetzt, dann befindet(n) sich eine (mehrere) Eigenschaft(en) in "​tempdb.dbo.AnyValues"​ (ID -> NodeCharacteristicID,​ Value -> Value), zu der (denen) "​Binaries"​ ermittelt werden soll(en)\\ |bit|3.5.22|
 +==== Rückgabe ====
 +
 +=== wenn ValueIDsInOneID = 0 und ValuesInAnyValues = 0 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|BinaryCodeID|ID eines "​Binaries",​ das der Eigenschaft "​ValueID"​ zugeordnet ist\\ |integer|3.5.0 |
 +|ValueID|Hier steht entweder der in "​ValueID"​ übergebene Wert oder die ID der Eigenschaft "​Value"​ zum Merkmal "​NodeCharacteristicID"​\\ |integer|4.0.0 |
 +=== wenn ValueIDsInOneID = 1 und ValuesInAnyValues = 0 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ValueID|ID einer Eigenschaft,​ die in "​tempdb.dbo.OneID"​ übergeben wurde\\ |integer|3.5.22 |
 +|BinaryCodeID|ID eines "​Binaries",​ das der Eigenschaft "​ValueID"​ zugeordnet ist\\ |integer|3.5.22 |
 +=== wenn ValueIDsInOneID = 0 und ValuesInAnyValues = 1 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeCharacteristicID|ID eines Merkmals, das in "​tempdb.dbo.AnyValues"​ übergeben wurde\\ |smallint|3.5.22 |
 +|Value|Eine Eigenschaft (zum Merkmal "​NodeCharacteristicID"​),​ die in "​tempdb.dbo.AnyValues"​ übergeben wurde\\ |varchar(1000)|3.5.22 |
 +|ValueID|Zu "​NodeCharacteristicID"​ und "​Value"​ zugehörige ID\\ |integer|3.5.22 |
 +|BinaryCodeID|ID eines "​Binaries",​ das der Eigenschaft "​ValueID"​ zugeordnet ist\\ |integer|3.5.22 |
 +==== 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"​)) ^
 +|-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|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-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 ====
 +
 +|7.0.8 |2015-08-21|1. "​Subquery returned more than 1 value"​-Fehler behoben, s. Ticket #3696\\ 2. "​Start-/​Finish-Procedure"​-Logik eingebaut\\ ​ |
 +|7.0.1 |2013-08-07|1. Datentyp-Erweiterung des Parameters "​Value"​ [von 100 auf 1000]\\ 2. Datentyp der Rückgabespalte "​Value"​ hat sich erweitert => Auch Anpassung der Doku\\ 3. Anpassungen des Quellcodes an den aktuellen Standard\\ ​ |
 +|4.0.0 |2003-04-03|Neue Rückgabespalte "​ValueID"​ im Fall "​ValueIDsInOneID = 0 AND ValuesInAnyValues = 0"​\\ ​ |
 +|3.5.22 |2002-08-30|\\ ​ |
 +|3.5.18 |2002-05-15|\\ ​ |
 +|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_GetBinaryCodeIDsForValue_Pu|im_GetBinaryCodeIDsForValue_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetBinaryCodeIDsForValue_Pu?​ValueID=<​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_GetBinaryCodeIDsForValue_Pu?​ValueID=<​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_GetBinaryCodeIDsForValue_Pu',​
 + array(
 + '​ValueID'​ => <​value>,​
 + // '​BinaryPropertyValueID'​ => NULL,
 + // '​Value'​ => NULL,
 + // '​NodeCharacteristicID'​ => NULL,
 + // '​ValueIDsInOneID'​ => 0,
 + // '​ValuesInAnyValues'​ => 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_GetBinaryCodeIDsForValue_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​ValueID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​BinaryPropertyValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​Value">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​NodeCharacteristicID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValueIDsInOneID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValuesInAnyValues">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getbinarycodeidsforvalue_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)