im_GetValueCategories [dstore]

Inhaltsverzeichnis

im_GetValueCategories

im_GetValueCategories

Gibt Kategorien, in die Eigenschaften eingeordnet werden können, aus.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[im, Get, Value, Categories]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	4.0.0 (2003-04-03)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
NodeCharacteristicID		ID eines Merkmals. Falls angegeben, werden nur die Kategorien für Eigenschaften zu diesem Merkmal berücksichtigt.	smallint	4.0.0
ValueCategoryID	NULL	ID einer Kategorie von Eigenschaften. Falls angegeben, wird nur der Datensatz zu dieser Kategorie ausgegeben.	smallint	4.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ValueCategoryID	ID einer Kategorie von Eigenschaften	smallint	4.0.0
ValueCategoryDescription	Bezeichnung der Kategorie „ValueCategoryID“	varchar(100)	4.0.0
NodeCharacteristicID	ID eines Merkmals. Besagt, daß nur Eigenschaften zu diesem Merkmal in die Kategorie „ValueCategoryID“ eingeordnet werden können.	smallint	4.0.0
CharacteristicDescription	Bezeichnung des Merkmals „NodeCharacteristicID“ (in der Standardsprache)	varchar(100)	4.0.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-500	Falsche Parameter	nur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

4.0.0

2003-04-03

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_GetValueCategories im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetValueCategories?NodeCharacteristicID=<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_GetValueCategories',
		array(
			'NodeCharacteristicID' => <value>,
			// 'ValueCategoryID' => 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_GetValueCategories">
			<Parameters>
				<Parameter Name="NodeCharacteristicID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="ValueCategoryID">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

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis