mi_GetBinaryProperties_Ad [dstore]

Inhaltsverzeichnis

mi_GetBinaryProperties_Ad

mi_GetBinaryProperties_Ad

Ermittelt zu einer Binärdatei (aus der Tabelle „Binaries“) alle Eigenschaften oder nur die Eigenschaften zu bestimmten Merkmalen.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Binary, Properties, Ad]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
BinaryCodeID		ID eines Binärobjektes	integer	6.0.6
BinaryCharacteristicIDs	NULL	Optionale Angabe einer Liste von IDs (durch '¶' getrennt) von Merkmalen, zu denen man sich die Eigenschaften von „BinaryCodeID“ ausgeben lassen möchte. (Sonst werden alle Eigenschaften ermittelt)	varchar(255)	6.0.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht zurückgegeben, sondern nur zur Sortierung verwendet. Die „SortNo“ bestimmt die Reihenfolge der Eigenschaft „Value“ innerhalb aller Eigenschaften des Merkmals „CharacteristicDescription“	smallint	6.0.6
CharacteristicDescription	Bezeichnung des Merkmals (in der Standardsprache) für „Binaries“, zu dem die Eigenschaft „Value“ gehört	varchar(100)	6.0.6
Value	Eigenschaft des Binärobjektes „BinaryCodeID“	varchar(250)	6.0.6
ValueID	ID der Eigenschaft „Value“	integer	6.0.6

Sortierung der Rückgabe

(parameterunabängige Sortierung)

SortNo (absteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁶⁾
-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 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.0	2013-06-04	Parametername einer intern aufgerufenen Prozedur hat sich geändert ⇒ Anpassung
6.5.3	2013-03-18	Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
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:

mi_GetBinaryProperties_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetBinaryProperties_Ad?BinaryCodeID=<value>'

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetBinaryProperties_Ad?BinaryCodeID=<value>' | xmllint --format -

dStore_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_Ad',
		array(
			'BinaryCodeID' => <value>,
			// 'BinaryCharacteristicIDs' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="mi_GetBinaryProperties_Ad">
			<Parameters>
				<Parameter Name="BinaryCodeID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="BinaryCharacteristicIDs">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁷⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis