im_GetNodeCharacteristics_Ad [dstore]

Inhaltsverzeichnis

im_GetNodeCharacteristics_Ad

im_GetNodeCharacteristics_Ad

Gibt Artikel-Merkmale (Merkmale zu denen Artikel-Elemente Eigenschaften besitzen können) zurück.

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

Parameter

OnlyIDsInTable_OneID	0	„0“ : Alle im „dStore“ definierten Merkmale ausgeben „1“ : Nur die Merkmale ausgeben, deren ID in der Tabelle „tempdb.dbo.OneID“ steht	bit	3.5.0
NodeCharacCategoryID	NULL	ID einer Kategorie für Artikel-Merkmale. Falls angegeben, wird „OnlyIDsInTable_OneID“ IGNORIERT (!) und es werden nur die Merkmale ermittelt, die dieser Kategorie zugeordnet sind.	smallint	5.1.9
SortOrder	0	Bestimmt die Sortierung der Rückgabemenge (s. Doku der Rückgabemenge)	tinyint	5.1.9
GetCategoryInformation	0	Falls „1“ angegeben ist, erhält man zusätzliche Rückgabespalten, denen man die Zuordnung des jeweiligen Merkmals in Kategorien entnehmen kann	bit	5.1.9

Rückgabe

wenn GetCategoryInformation = 0

Spaltenname	Beschreibung	SQL-Datentyp¹⁾	ab Version
NodeCharacteristicID	ID eines Merkmals, zu dem Artikel-Elemente Eigenschaften haben können	smallint	3.5.0
CharacteristicDescription	Bezeichnung des Merkmals „NodeCharacteristicID“ (in der Standardsprache)	varchar(100)	3.5.0
ValueLanguageID	ID einer Sprache, in der alle Eigenschaften des Merkmals „NodeCharacteristicID“ angegeben sind	tinyint	3.5.0
ValueLanguage	Bezeichnung der Sprache „ValueLanguageID“	varchar(50)	5.1.9
UnitID	ID einer Einheit, in der alle Eigenschaften des Merkmals „NodeCharacteristicID“ sind	tinyint	3.5.0
PredefinedValues	Hat das Merkmal „NodeCharacteristicID“ nur vordefinierte Werte („0“ : Nein, „1“ : Ja) ?	bit	3.5.0
SortNo	Bestimmt die Reihenfolge des Merkmals „NodeCharacteristicID“ innerhalb aller Merkmale	smallint	3.5.0
FieldTypeID	ID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „NodeCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)	tinyint	3.5.0
Deleteable	Darf das Merkmal „NodeCharacteristicID“ gelöscht werden ? (Falls nicht, ist es ein Merkmal, das vom „dStore“ vorgegeben ist und intern verwendet wird)	bit	3.5.0
Recursive	Handelt es sich um ein rekursives Merkmal ? Rekursive Merkmale sind immer vordefiniert und haben als Eigenschaften „NodeCharacteristicID“s. (Beispiel ist der „Verkaufspreis“)	bit	3.5.0
IsUnique	DERZEIT NOCH NICHT UMGESETZT ! (Sind die Eigenschaften eindeutig, d.h. wird eine Eigenschaft nur von maximal EINER „NodeID“ verwendet ?)	bit	3.5.0
KeepPropertiesHistoryInHours	Zeit in Stunden, über die die Historie der Eigenschaften zu diesem Merkmal für jedes Artikel-Element („NodeID“) gespeichert bleiben soll. „-1“ bedeutet, daß die gesamte Historie erhalten bleibt.	integer	3.5.21
InNetto	NICHT MEHR BENUTZEN !!! Stattdessen auf „HasCurrencyUnit_ValsAreNetVals“ zugreifen !	tinyint	3.5.21
HasCurrencyUnit_ValsAreNetVals	Handelt es sich um ein „Preis-Merkmal“ (d.h. ist die „UnitID“ aus der Kategorie „Währung“) und falls ja, sind alle Werte Netto-Preise ? „0“ : Werte sind Brutto-Preise „1“ : Werte sind Netto-Preise „2“ : Werte sind KEINE Preis-Angaben	tinyint	5.1.9

Sortierungen der Rückgabe

wenn SortOrder = 0

ValueLanguage (aufsteigend)
SortNo (absteigend)

wenn SortOrder = 1

SortNo (absteigend)

wenn SortOrder = 2

CharacteristicDescription (aufsteigend)

wenn GetCategoryInformation = 1

Spaltenname	Beschreibung	SQL-Datentyp²⁾	ab Version
NodeCharacteristicID	ID eines Merkmals, zu dem Artikel-Elemente Eigenschaften haben können	smallint	3.5.0
CharacteristicDescription	Bezeichnung des Merkmals „NodeCharacteristicID“ (in der Standardsprache)	varchar(100)	3.5.0
ValueLanguageID	ID einer Sprache, in der alle Eigenschaften des Merkmals „NodeCharacteristicID“ angegeben sind	integer	3.5.0
ValueLanguage	Bezeichnung der Sprache „ValueLanguageID“	varchar(50)	5.1.9
UnitID	ID einer Einheit, in der alle Eigenschaften des Merkmals „NodeCharacteristicID“ sind	tinyint	3.5.0
PredefinedValues	Hat das Merkmal „NodeCharacteristicID“ nur vordefinierte Werte („0“ : Nein, „1“ : Ja) ?	bit	3.5.0
SortNo	Bestimmt die Reihenfolge des Merkmals „NodeCharacteristicID“ innerhalb aller Merkmale	smallint	3.5.0
FieldTypeID	ID eines „Feld-Typs“, von dem alle Eigenschaften des Merkmals „NodeCharacteristicID“ sein müssen (z.B. „Text mit maximal 20 Zeichen“)	tinyint	3.5.0
Deleteable	Darf das Merkmal „NodeCharacteristicID“ gelöscht werden ? (Falls nicht, ist es ein Merkmal, das vom „dStore“ vorgegeben ist und intern verwendet wird)	bit	3.5.0
Recursive	Handelt es sich um ein rekursives Merkmal ? Rekursive Merkmale sind immer vordefiniert und haben als Eigenschaften „NodeCharacteristicID“s. (Beispiel ist der „Verkaufspreis“)	bit	3.5.0
IsUnique	DERZEIT NOCH NICHT UMGESETZT ! (Sind die Eigenschaften eindeutig, d.h. wird eine Eigenschaft nur von maximal EINER „NodeID“ verwendet ?)	bit	3.5.0
KeepPropertiesHistoryInHours	Zeit in Stunden, über die die Historie der Eigenschaften zu diesem Merkmal für jedes Artikel-Element („NodeID“) gespeichert bleiben soll. „-1“ bedeutet, daß die gesamte Historie erhalten bleibt.	integer	3.5.21
InNetto	NICHT MEHR BENUTZEN !!! Stattdessen auf „HasCurrencyUnit_ValsAreNetVals“ zugreifen !	tinyint	3.5.21
HasCurrencyUnit_ValsAreNetVals	Handelt es sich um ein „Preis-Merkmal“ (d.h. ist die „UnitID“ aus der Kategorie „Währung“) und falls ja, sind alle Werte Netto-Preise ? „0“ : Werte sind Brutto-Preise „1“ : Werte sind Netto-Preise „2“ : Werte sind KEINE Preis-Angaben	tinyint	5.1.9
PredecessorCategoryID	ID einer Merkmal-Kategorie, die „NodeCharacCategoryID“ übergeordnet ist. Entspricht der Wert dem in „NodeCharacCategoryID“, handelt es sich um eine sogenannte „Hauptkategorie“ (der keine Kategorie übergeordnet ist).	smallint	5.1.9
NodeCharacCategoryID	ID einer Kategorie, der „NodeCharacteristicID“ zugeordnet ist. „NULL“, falls „NodeCharacteristicID“ in keiner Kategorie ist. Wurde „NodeCharacCategoryID“ angegeben, steht hier natürlich die übergebene ID.	smallint	5.1.9
CategorySortNo	Bestimmt die Reihenfolge von „NodeCharacteristicID“ innerhalb aller der Kategorie „NodeCharacCategoryID“ zugeordneten Merkmale	tinyint	5.1.9
CategoryDescription	Bezeichnung der Kategorie „NodeCharacCategoryID“	varchar(100)	5.1.9

Sortierungen der Rückgabe

wenn SortOrder = 0

ValueLanguage (aufsteigend)
SortNo (absteigend)

wenn SortOrder = 1

SortNo (absteigend)

wenn SortOrder = 2

CharacteristicDescription (aufsteigend)

wenn SortOrder = 3

PredecessorCategoryID (aufsteigend)
CategorySortNo (aufsteigend)

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
-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.4	2014-03-19	Verhalten von „KeepPropertiesHistoryInHours“ hat sich leicht geändert, s. Ticket #3560
7.0.1	2013-08-07	Tabelle „CurrencyCharacteristicsInNetto“ wurde durch die allgemeinere Tabelle „NodeCharacteristicSettings“ ersetzt ⇒ Entsprechende Anpassungen hier
5.1.9	2007-01-26	1. Wegfall des Parameters „IncludeCurrencyInformation“ 2. Neue Parameter und Rückgabespalten 3. Überarbeitung der Doku
4.0.11	2004-03-31	1. Aufruf von „_mi_StartProcedure“ u. „_mi_FinishProcedure“ 2. „set transaction isolation level 1“ u. „set rowcount 0“ zu Beginn 3. Der Index auf „NodeCharacteristics“ konnte nicht genutzt werden, da die Konvertierung „convert(smallint, o.ID1)“ fehlte !
4.0.4	2003-08-26	Umbenennung des Parameters „IncludeCurrencyInformations“ in „IncludeCurrencyInformation“
3.5.21	2002-08-06
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_GetNodeCharacteristics_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeCharacteristics_Ad'

Mit xmllint ⁴⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeCharacteristics_Ad' | 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_GetNodeCharacteristics_Ad',
		array(
			// 'OnlyIDsInTable_OneID' => 0,
			// 'NodeCharacCategoryID' => NULL,
			// 'SortOrder' => 0,
			// 'GetCategoryInformation' => 0
		)
);
 
$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_GetNodeCharacteristics_Ad">
			<Parameters>
				<!-- <Parameter Name="OnlyIDsInTable_OneID">0</Parameter> -->
				<!-- <Parameter Name="NodeCharacCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="SortOrder">0</Parameter> -->
				<!-- <Parameter Name="GetCategoryInformation">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾ , ²⁾

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