engine:procedures:im_getvaluedetails

Inhaltsverzeichnis

im_GetValueDetails_Ad

im_GetValueDetails_Ad

Ermittelt zu einer Eigenschaft die hinterlegten „Details“ (aus „ValueDetails“).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Value, Details, Ad]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ValueID		ID einer Eigenschaft, zu der die „Details“ ermittelt werden sollen. Alternativ kann die Eigenschaft auch durch „NodeCharacteristicID“ und „Value“ angegeben werden - dann ist hierfür aber „NULL“ anzugeben !	integer	4.0.6
NodeCharacteristicID	NULL	Wird nur beachtet, falls „NULL“ für „ValueID“ angegeben wird ! ID eines Merkmals, auf das sich „Value“ bezieht.	smallint	4.0.6
Value	NULL	Wird nur beachtet, falls „NULL“ für „ValueID“ angegeben wird ! Eigenschaft zum Merkmal „NodeCharacteristicID“, zu der die „Details“ ausgegeben werden sollen.	varchar(1000)	4.0.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ValueID	ID einer Eigenschaft. Entspricht entweder „ValueID“ oder es ist die zugehörige ID der durch „NodeCharacteristicID“ und „Value“ angegebenen Eigenschaft.	integer	4.0.6
NodeCharacteristicID	ID eines Merkmals. Entspricht entweder „NodeCharacteristicID“ oder es ist die ID des zur „ValueID“ zugehörigen Merkmals.	smallint	4.0.6
Value	Eigenschaft zum Merkmal „NodeCharacteristicID“. Entspricht entweder „Value“ oder ist der „Klartext“ für die durch „ValueID“ angegebene Eigenschaft.	varchar(1000)	4.0.6
Details	Details zur Eigenschaft „Value“	text	4.0.6

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.1	2013-08-07	1. Datentyp-Erweiterung des Parameters „Value“ [von 100 auf 1000] 2. Datentyp der Rückgabespalte „Value“ hat sich erweitert ⇒ Anpassung der Doku
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.11	2004-03-31	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.6	2003-11-14	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:

im_GetValueDetails_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetValueDetails_Ad?ValueID=<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'),
	'im_GetValueDetails_Ad',
		array(
			'ValueID' => <value>,
			// 'NodeCharacteristicID' => NULL,
			// 'Value' => 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="im_GetValueDetails_Ad">
			<Parameters>
				<Parameter Name="ValueID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="NodeCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="Value">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

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