engine:procedures:im_getbinary_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:im_getbinary_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_GetBinary_Pu ===== | ||
| + | |||
| + | Liest den Code zu einer "BinaryCodeID", d.h. das Binärobjekt selbst, aus der Datenbank aus (z.B. ein Bild). Alternativ kann man sich zu diesem Objekt auch das sogenannte "Thumbnail" ausgeben lassen.\\ | ||
| + | |||
| + | |||
| + | |||
| + | Anmerkung zur Rückgabespalte "BinaryType" :\\ | ||
| + | |||
| + | Hier wird eine spezielle Eigenschaft (zum Merkmal mit der ID "1") des "Binaries" ausgegeben - nämlich die, die man auch durch folgenden Aufruf erhalten kann : exec im_GetBinaryProperties_Pu <BinaryCodeID>, BinaryCharacteristicID = 1. Das Merkmal mit der ID "1" dient dazu, den "MIME-Type" hinterlegen zu können (daher auch die entsprechende Bezeichnung, s. [[dstoreproc>im_GetBinaryCharacteristics_Ad]]). Die Engine stellt aber nicht sicher (und kann dies auch nicht), daß dort tatsächlich der richtige MIME-Type hinterlegt ist.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[im Get Binary Pu]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|3.5.0 (2000-11-23)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |__BinaryCodeID__| |ID eines Binärobjektes\\ |integer|3.5.0| | ||
| + | |ReturnThumbnailCode|0 |"0" : Originalobjekt ausgeben\\ "1" : Thumbnailobjekt ausgeben\\ |bit|3.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |BinaryType|Eigenschaft von "BinaryCodeID" zum Merkmal mit der ID "1" (aktuelle Bezeichnung : "MIME-Type"). Hinweis : Die Engine kann nicht SICHERSTELLEN, daß der Wert wirklich den Typ des "Binaries" darstellt (s. Beschreibung) !\\ |varchar(250)|3.5.0 | | ||
| + | |BinaryCode|Der zur "BinaryCodeID" zugehörige Code, also quasi das Binärobjekt selbst - oder das zugehörige "Thumbnail"\\ |longvarbinary|3.5.0 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | Die Prozedur hat keine Fehlercodes. | ||
| + | ==== 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 ==== | ||
| + | |||
| + | |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_GetBinary_Pu|im_GetBinary_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetBinary_Pu?BinaryCodeID=<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_GetBinary_Pu?BinaryCodeID=<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_GetBinary_Pu', | ||
| + | array( | ||
| + | 'BinaryCodeID' => <value>, | ||
| + | // 'ReturnThumbnailCode' => 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_GetBinary_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="BinaryCodeID"><!-- integer value --></Parameter> | ||
| + | <!-- <Parameter Name="ReturnThumbnailCode">0</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_getbinary_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)