Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:im_getnodepropertieshistory_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== im_GetNodePropertiesHistory_Ad ===== | ||
+ | |||
+ | Gibt die Historie der Eigenschaften eines Artikel-Elementes zu einem bestimmten Merkmal aus.\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[im Get Node Properties History 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 ^ | ||
+ | |__NodeID__| |ID eines Artikel-Elementes, zu dem die Historie der Eigenschaften ermittelt werden soll. Falls "NULL" angegeben wird, erwarten wir, daß "NodeID"s via "tempdb.dbo.OneID" übergeben werden.\\ |integer|4.0.5| | ||
+ | |__NodeCharacteristicID__| |ID eines Merkmal, zu dem die Historie der Eigenschaften ermittelt werden soll. Falls "NULL" angegeben, wird, können via "CharacteristicIDList" MEHRERE Merkmale angegeben werden.\\ |smallint|4.0.5| | ||
+ | |FromDate|NULL |Optionale Einschränkung der Ausgabe der Eigenschaften-Historie. Falls angegeben, werden nur Eigenschaften von "NodeID" zum Merkmal "NodeCharacteristicID" ausgegeben, die AB diesem Zeitpunkt gültig waren / sein werden.\\ |datetime|4.0.5| | ||
+ | |ToDate|NULL |Optionale Einschränkung der Ausgabe der Eigenschaften-Historie. Falls angegeben, werden nur Eigenschaften von "NodeID" zum Merkmal "NodeCharacteristicID" ausgegeben, die BIS zu diesem Zeitpunkt gültig waren / sein werden.\\ |datetime|4.0.5| | ||
+ | |CharacteristicIDList|NULL |Wird nur beachtet, wenn "NodeCharacteristicID" "NULL" ist ! Liste von Merkmal-IDs (durch '¶' getrennt), zu denen die Historie der Eigenschaften ermittelt werden soll. Ist auch hier "NULL" angegeben, erhält man die Historie ALLER Eigenschaften.\\ |varchar(250)|5.1.3| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |NodeID|ID eines (übergebenen) Artikel-Elementes, das im Zeitraum "ValidFrom" bis "ValidTo" die Eigenschaft "Value" zum Merkmal "NodeCharacteristicID" besaß/besitzt\\ |integer|5.1.3 | | ||
+ | |NodeCharacteristicID|ID des Merkmals, zu dem "NodeID" im Zeitraum "ValidFrom" bis "ValidTo" die Eigenschaft "Value" besaß/besitzt\\ |smallint|5.1.3 | | ||
+ | |ValidFrom|Beginn des Gültigkeits-Zeitraums der Eigenschaft "Value" für "NodeID"\\ |datetime|4.0.5 | | ||
+ | |ValidFrom_char|"ValidFrom" als "String" im Format "01.04.2001 15:20:55:115"\\ |varchar(23)|4.0.5 | | ||
+ | |ValidTo|Ende des Gültigkeits-Zeitraums der Eigenschaft "Value" für "NodeID"\\ |datetime|4.0.5 | | ||
+ | |ValidTo_char|"ValidTo" als "String" im Format "01.04.2001 15:20:55:115"\\ |varchar(23)|4.0.5 | | ||
+ | |Value|Eine Eigenschaft zum Merkmal "NodeCharacteristicID", die dem Element "NodeID" im Zeitraum "ValidFrom" bis "ValidTo" zugewiesen ist / war\\ |varchar(1000)|4.0.5 | | ||
+ | |ValueID|ID der Eigenschaft "Value"\\ |integer|4.0.5 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * NodeID (aufsteigend) | ||
+ | * NodeCharacteristicID (aufsteigend) | ||
+ | * ValidFrom (aufsteigend) | ||
+ | |||
+ | ==== 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|direkt und 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.1 |2013-08-07|1. Datentyp der Rückgabespalte "Value" hat sich erweitert => Auch Anpassung der Doku\\ 2. Anpassungen des Quellcodes an den aktuellen Standard\\ | | ||
+ | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |5.1.6 |2006-09-14|Workaround für einen BUG im ASE bzgl. "isnull"-Funktion in einer WHERE-clause\\ | | ||
+ | |5.1.5 |2006-08-29|Fehler : "LockedNodeCharacteristics" wurde bisher GAR NICHT beachtet !\\ | | ||
+ | |5.1.3 |2006-07-27|1. Neue Möglichkeit "NodeID"s via "tempdb.dbo.OneID" zu übergeben\\ 2. Neuer Parameter "CharacteristicIDList"\\ => 3. Neue Rückgabespalten "NodeID" und "NodeCharacteristicID" sowie eine entsprechende Sortierung\\ | | ||
+ | |5.1.1 |2006-04-05|Optimierung des Zugriffs auf "NodeProperties" (bedingt durch die Änderung dieser Tabelle in 5.1.0)\\ | | ||
+ | |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.5 |2003-10-04|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_GetNodePropertiesHistory_Ad|im_GetNodePropertiesHistory_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/im_GetNodePropertiesHistory_Ad?NodeID=<value>&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_GetNodePropertiesHistory_Ad?NodeID=<value>&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_GetNodePropertiesHistory_Ad', | ||
+ | array( | ||
+ | 'NodeID' => <value>, | ||
+ | 'NodeCharacteristicID' => <value>, | ||
+ | // 'FromDate' => NULL, | ||
+ | // 'ToDate' => NULL, | ||
+ | // 'CharacteristicIDList' => 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_GetNodePropertiesHistory_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="NodeID"><!-- integer value --></Parameter> | ||
+ | <Parameter Name="NodeCharacteristicID"><!-- smallint value --></Parameter> | ||
+ | <!-- <Parameter Name="FromDate">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="ToDate">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="CharacteristicIDList">NULL</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||