Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getnodecharacvalues_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getnodecharacvalues_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetNodeCharacValues_Ad =====
 +
 +Ermittelt alle eingetragenen Eigenschaften zu einem bestimmten Merkmal. Optional können auch nur Eigenschaften einer bestimmten Kategorie von Werten ("​ValueCategoryID"​) ausgegeben werden.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Alias|im_GetNodeCharacteristicValues_Ad |
 +|Tags|{{tag>​[im Get Node Characteristic Values Ad]}}|
 +|Engine-Kategorie|item management |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|__NodeCharacteristicID__| |ID eines Merkmal, zu dem alle Eigenschaften ausgegeben werden sollen\\ |smallint|3.5.0|
 +|ValueCategoryID|-1 |Wird nur beachtet, wenn "​NodeCharacteristicID"​ oder "​GetValuesLike"​ "​NULL"​ ist ! ID einer Kategorie von Eigenschaften. Ist ein Wert ">= 0" angegeben, werden alle anderen Parameter ignoriert und nur Eigenschaften aus dieser Kategorie zurückgeliefert.\\ |smallint|3.5.0|
 +|RecursiveEvaluation|1 |Wird nur beachtet, wenn "​NodeCharacteristicID"​ o. "​GetValuesLike"​ "​NULL"​ und "​ValueCategoryID < 0" ist ! Ist "​1"​ angeben, ist "​Value"​ bei rekursiven Merkmalen eigentl. die ID eines Merkmals - wir geben aber die Bezeichn. des referenz. Merkmals zurück.\\ |bit|3.5.0|
 +|Value|NULL |Wird nur beachtet, wenn "​NodeCharacteristicID"​ NICHT "​NULL",​ "​GetValuesLike"​ "​NULL"​ UND "​ValueCategoryID < 0" ist ! Wenn angegeben, wird ein Datensatz zu "​NodeCharacterisicID"​ gesucht, bei dem "​Value"​ diesem angegebenen Wert entspricht.\\ |varchar(1000)|5.1.7|
 +|ValueID|NULL |Wird nur beachtet (und muß angegeben sein), wenn "​NodeCharacteristicID"​ und "​GetValuesLike"​ "​NULL"​ sind und "​ValueCategoryID < 0" ist ! ID einer Eigenschaft,​ die Artikel-Elemente haben können. Wenn angegeben, kommt nur der entspr. Datensatz zurück.\\ |integer|5.1.7|
 +|GetValuesLike|NULL |Wird nur beachtet, wenn "​NodeCharacteristicID"​ angegeben ist ! Falls angegeben, werden alle anderen Parameter ignoriert und die Datensätze zu "​NodeCharacteristicID"​ mit "​Value"​s ermittelt, die bei Verwendung von "​LIKE"​ diesem Ausdruck entsprechen.\\ |varchar(1500)|6.0.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ValueID|ID einer Eigenschaft zum Merkmal "​NodeCharacteristicID"​\\ |integer|3.5.0 |
 +|NodeCharacteristicID|ID des Merkmals, zu dem die Eigenschaft "​ValueID"​ gehört\\ |smallint|3.5.0 |
 +|Value|Eine Eigenschaft zum Merkmal "​NodeCharacteristicID"​\\ |varchar(1000)|3.5.0 |
 +|SortNo|Bestimmt die Reihenfolge der Eigenschaft "​ValueID"​ innerhalb aller Eigenschaften zum Merkmal "​NodeCharacteristicID"​\\ |smallint|3.5.0 |
 +|HasDetails|Sind zur "​ValueID"​ sogenannte "​ValueDetails"​ hinterlegt ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|5.0.2 |
 +|HasBinaries|Sind zur "​ValueID"​ "​Binaries"​ gespeichert ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|5.5.0 |
 +|IsUsed|Wird "​ValueID"​ (evtl. auch/nur in der Historie) verwendet ? ("​0"​ : Nein, "​1"​ : Ja)\\ |bit|7.0.3 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * SortNo (absteigend)
 +
 +==== Output-Parameter ====
 +
 +Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-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 [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|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.3 |2013-12-13|Neue Rückgabespalte "​IsUsed"​\\ ​ |
 +|7.0.1 |2013-08-07|1. Datentyp-Erweiterung der Parameters "​Value"​ und "​GetValuesLike"​\\ 2. Datentyp der Rückgabespalte "​Value"​ hat sich erweitert => Auch Anpassung der Doku\\ ​ |
 +|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard,​ u.a. wg. UTF8-Unterstützung\\ ​ |
 +|6.0.0 |2010-03-26|Neuer Parameter "​GetValuesLike"​\\ ​ |
 +|5.5.0 |2008-01-07|Neue Rückgabespalte "​HasBinaries"​\\ ​ |
 +|5.1.7 |2006-10-31|1. Neue Parameter "​Value"​ und "​ValueID"​\\ 2. Ausgabe an die Standard-Ausgabe [via "​print"​] im Fehler-Fall "​-500",​ die nähere Informationen über die Ursache enthält.\\ ​ |
 +|5.0.2 |2005-04-29|Neue Rückgabespalte "​HasDetails"​\\ ​ |
 +|4.0.11 |2004-03-31|1. Aufruf der Prozeduren "​_mi_StartProcedure"​ und "​_mi_FinishProcedure"​\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ ​ |
 +|4.0.0 |2003-04-03|1. Performance-Optimierung durch "set forceplan"​ (für den "​optimizer"​)\\ 2. "​SELECT *" ersetzt durch konkrete Rückgabespalten : "​SELECT ValueID, ..."\\ 3. Fehlerhafte Doku der verwendeten Tabellen\\ 4. Fehlende Angabe in der Doku der GENAUEN Rückgabemenge\\ ​ |
 +|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:
 +  * [[http://​playground.dstore.de/​index.php?​proc=im_GetNodeCharacValues_Ad|im_GetNodeCharacValues_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetNodeCharacValues_Ad?​NodeCharacteristicID=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetNodeCharacValues_Ad?​NodeCharacteristicID=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code 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_GetNodeCharacValues_Ad',​
 + array(
 + '​NodeCharacteristicID'​ => <​value>,​
 + // '​ValueCategoryID'​ => -1,
 + // '​RecursiveEvaluation'​ => 1,
 + // '​Value'​ => NULL,
 + // '​ValueID'​ => NULL,
 + // '​GetValuesLike'​ => NULL
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​im_GetNodeCharacValues_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​NodeCharacteristicID"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​ValueCategoryID">​-1</​Parameter>​ -->
 + <!-- <​Parameter Name="​RecursiveEvaluation">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​Value">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​ValueID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetValuesLike">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getnodecharacvalues_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)