Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getbinaryproperties_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:mi_getbinaryproperties_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== mi_GetBinaryProperties_Pu =====
 +
 +Ermittelt zu einer Binärdatei (aus der Tabelle "​Binaries"​) alle Eigenschaften oder nur die Eigenschaften zu einem bestimmten Merkmal.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[mi Get Binary Properties Pu]}}|
 +|Engine-Kategorie|miscellaneous |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|6.0.6 (2012-03-01)|
 +
 +==== 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|6.0.6|
 +|BinaryCharacteristicID|NULL |ID eines Merkmals für "​Binaries"​. Falls angegeben, wird nur die Eigenschaft von "​BinaryCodeID"​ zu diesem Merkmal ermittelt.\\ |tinyint|6.0.6|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|//​SortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//​|Wird nicht zurückgegeben,​ sondern nur zur Sortierung verwendet. Die "​SortNo"​ bestimmt die Reihenfolge der Eigenschaft "​Value"​ innerhalb aller Eigenschaften des Merkmals "​BinaryCharacteristicID"​\\ |smallint|6.0.6 |
 +|ValueID|ID der Eigenschaft "​Value"​\\ |integer|6.0.6 |
 +|Value|Eine Eigenschaft,​ die "​BinaryCodeID"​ besitzt\\ |varchar(250)|6.0.6 |
 +|BinaryCharacteristicID|ID des Merkmals, zu dem die Eigenschaft "​Value"​ gehört\\ |tinyint|6.0.6 |
 +|CharacteristicDescription|Bezeichnung des Merkmals "​BinaryCharacteristicID"​ (in der Standardsprache)\\ |varchar(100)|6.0.6 |
 +|PredefinedValues|Hat das Merkmal "​BinaryCharacteristicID"​ nur vordefinierte Werte ?\\ |bit|6.0.6 |
 +|Modify|Dürfen Eigenschaften zu diesem Merkmal nachträglich noch geändert werden ?\\ |bit|6.0.6 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * SortNo (absteigend)
 +
 +==== 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 ====
 +
 +|6.0.6 |2012-03-01|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=mi_GetBinaryProperties_Pu|mi_GetBinaryProperties_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetBinaryProperties_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/​mi_GetBinaryProperties_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'​),​
 + '​mi_GetBinaryProperties_Pu',​
 + array(
 + '​BinaryCodeID'​ => <​value>,​
 + // '​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="​mi_GetBinaryProperties_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​BinaryCodeID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​BinaryCharacteristicID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/mi_getbinaryproperties_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)