engine:procedures:im_getvaluedetails

Inhaltsverzeichnis

im_GetValueDetails_Pu

im_GetValueDetails_Pu

Ermittelt die Eigenschaft (evtl. rekursiv !) eines Elementes des Artikelbaums zu einem Merkmal und gibt diese zusammen mit „Details“ zu dieser Eigenschaft (falls vorhanden) zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Value, Details, Pu]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.1 (2013-08-07)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
TreeNodeID		ID eines Elementes im Artikelbaum, zu dem die Eigenschaft (und die Details dazu) zum Merkmal „NodeCharacteristicID“ ermittelt werden soll	integer	3.5.0
NodeCharacteristicID	19	ID eines Merkmals, zu dem die Eigenschaft (und die Details dazu) des Elementes „TreeNodeID“ ermittelt werden soll. ACHTUNG : Handelt es sich um ein rekursives Merkmal wird die Eigenschaft REKURSIV ermittelt !	smallint	3.5.0
Value	NULL	Eigenschaft zum Merkmal „NodeCharacteristicID“. Wird nur beachtet, wenn „TreeNodeID“ „NULL“ ist. Es wird die Detail-Eigenschaft zu dieser Eigenschaft zurückgegeben, allerdings darf das Merkmal nur vordefinierte Wert haben („PredefinedValues = 1“) !	varchar(1000)	4.0.4

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value	Die aktuelle Eigenschaft des Elementes „TreeNodeID“ zum Merkmal „NodeCharacteristicID“	varchar(1000)	3.5.0
Details	Details zur Eigenschaft „Value“	text	3.5.0
ValueID	ID der aktuellen Eigenschaft („Value“) des Elementes „TreeNodeID“ zum Merkmal „NodeCharacteristicID“	integer	4.0.1

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-550	Fehlender oder falscher Eintrag in Settings	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-500	Falsche Parameter	direkt und indirekt
-283	Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln	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.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 3. Quellcode-Anpassungen an den aktuellen Standard
5.1.5	2006-08-29	Der Aufbau des „LockStatus“ in „LockedNodeCharacteristics“ hat sich geändert ⇒ entsprechende Anpassungen
4.0.6	2003-11-14	Fehler bei rekursiven Merkmalen
4.0.4	2003-08-26	Neuer Parameter „Value“
4.0.1	2003-05-16	Neue Rückgabespalte „ValueID“
3.5.22	2002-08-30
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:

im_GetValueDetails_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetValueDetails_Pu?TreeNodeID=<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_Pu',
		array(
			'TreeNodeID' => <value>,
			// 'NodeCharacteristicID' => 19,
			// '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_Pu">
			<Parameters>
				<Parameter Name="TreeNodeID"><!-- integer value --></Parameter>
				<!-- <Parameter Name="NodeCharacteristicID">19</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