Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getbinariesforvalues

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getbinariesforvalues [11.01.2016 ]
engine:procedures:im_getbinariesforvalues [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetBinariesForValues =====
 +
 +Prozedur, um sich zu Eigenschaften (für Artikel-Elemente) zugeordnete "​Binaries"​ ausgeben zu lassen.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Binaries For Values]}}|
 +|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 ^
 +|__ValueID__| |ID einer Eigenschaft,​ die Artikel-Elemente haben können, und zu der die zugewiesenen "​Binaries"​ ermittelt werden sollen\\ |integer|5.0.2|
 +|NodeCharacteristicID|NULL |Wird nur beachtet, wenn "​ValueID = NULL" ist ! ID des Merkmals der Eigenschaft "​Value"​. Falls auch hier "​NULL"​ angegeben wird, erwartet die Prozedur Eigenschaften in "​tempdb.dbo.OneID"​ bzw. "​tempdb.dbo.AnyValues"​ (s."​ValuesInAnyValues"​).\\ |smallint|5.0.2|
 +|Value|NULL |Wird nur beachtet, wenn "​ValueID = NULL" ist ! Eigenschaft zum Merkmal "​NodeCharacteristicID",​ zu dem die zugewiesenen "​Binaries"​ ermittelt werden sollen.\\ |varchar(1000)|5.0.2|
 +|ValuesInAnyValues|0 |Wird nur beachtet, wenn für "​ValueID"​ UND für "​NodeCharacteristicID"​ "​NULL"​ angegeben ist. Gibt man hier "​0"​ an, werden "​ValueID"​s in "​tempd.dbo.OneID"​ erwartet, bei "​1"​ sind "​NodeCharacteristicID"​-"​Value"​-Paare in "​tempdb.dbo.AnyValues"​ zu übergeben.\\ |bit|5.0.2|
 +|IncludeBinaryCode|0 |Normalerweise wird nicht der "​Code"​ der "​Binaries"​ selbst ermittelt, sondern nur die IDs. Möchte man aber auch den "​Code"​ und/oder den "​Thumbnail-Code"​ bekommen, übergibt man hier Werte größer "​0"​. Genaueres steht in der Dokumentation der Rückgabemenge.\\ |tinyint|5.0.2|
 +|FilterByBinaryCharacValueID|NULL |Es kann optional nach einer Eigenschaft,​ die die "​Binaries"​ haben müssen, gefiltert werden, in dem man hier die ID einer (Binary-)Eigenschaft angibt. Z.B. können so nur "​Binaries"​ eines bestimmten Bildtyps zurückgegeben werden.\\ |integer|5.0.2|
 +|BinaryCharacteristicID|NULL |ID eines Merkmals für "​Binaries"​. Falls angegeben, wird zu allen ermittelten "​Binaries"​ die jeweilige Eigenschaft zu diesem Merkmal ermittelt.\\ ACHTUNG : Hat ein zugewiesenes "​Binary"​ KEINE Eigenschaft zu diesem Merkmal, ist es auch nicht im Ergebnis !\\ |tinyint|5.0.2|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeCharacteristicID|ID eines Merkmals, zu dem Artikel-Elemente Eigenschaften haben können\\ |smallint|5.0.2 |
 +|Value|Eine Eigenschaft zum Merkmal "​NodeCharacteristicID"​\\ |varchar(1000)|5.0.2 |
 +|ValueID|ID der Eigenschaft "​Value"​\\ |integer|5.0.2 |
 +|BinaryCodeID|ID eines "​Binaries",​ das der Eigenschaft "​ValueID"​ zugeordnet ist\\ |integer|5.0.2 |
 +|BinaryCode|Der zur "​BinaryCodeID"​ zugehörige Code, also quasi das Binärobjekt selbst. Standardmäßig "​NULL",​ es wird hier nur etwas zurückgegeben,​ wenn "​IncludeBinaryCode"​ den Wert "​1"​ oder "​3"​ hat.\\ |longvarbinary|5.0.2 |
 +|ThumbnailCode|Der zur "​BinaryCodeID"​ zugehörige Code des "​Thumbnails"​ (ein kleines Bild, das das eigentliche Binärobjekt symbolisieren soll). Standardmäßig "​NULL",​ es wird hier nur etwas zurückgegeben,​ wenn "​IncludeBinaryCode"​ den Wert "​2"​ oder "​3"​ hat.\\ |longvarbinary|5.0.2 |
 +|BinaryCharacValue|Eine Eigenschaft von "​BinaryCodeID"​ zum Merkmal "​BinaryCharacteristicID"​ (falls dieser Parameter angegeben wurde)\\ |varchar(250)|5.0.2 |
 +|BinaryValueID|ID der Eigenschaft "​BinaryCharacValue"​\\ |integer|5.0.2 |
 +==== 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|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|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|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\\ ​ |
 +|6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard,​ Korrektur der Doku\\ ​ |
 +|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard,​ u.a. wg. UTF8-Unterstützung\\ ​ |
 +|5.0.2 |2005-04-29|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_GetBinariesForValues|im_GetBinariesForValues im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetBinariesForValues?​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_GetBinariesForValues?​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_GetBinariesForValues',​
 + array(
 + '​ValueID'​ => <​value>,​
 + // '​NodeCharacteristicID'​ => NULL,
 + // '​Value'​ => NULL,
 + // '​ValuesInAnyValues'​ => 0,
 + // '​IncludeBinaryCode'​ => 0,
 + // '​FilterByBinaryCharacValueID'​ => NULL,
 + // '​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_GetBinariesForValues">​
 + <​Parameters>​
 + <​Parameter Name="​ValueID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​NodeCharacteristicID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​Value">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValuesInAnyValues">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeBinaryCode">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​FilterByBinaryCharacValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​BinaryCharacteristicID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getbinariesforvalues.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)