Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getnodemetainformation_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getnodemetainformation_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetNodeMetaInformation_Ad =====
 +
 +Gibt zu einem Artikel-Element die sogenannten Meta-Informationen (wie letzte Änderung an Eigenschaften etc.) aus.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Node Meta Information 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 des Artikel-Elementes,​ zu dem die "​Meta-Informationen"​ ermittelt werden sollen. Falls "​NULL"​ angegeben wird, erwartet die Prozedur IDs in "​tempdb.dbo.OneID"​.\\ |integer|6.0.4|
 +|MetaInformationTypeIDList|NULL |Liste (durch "​¶"​ getrennt) von "​MetaInformationTypeID"​s. Wenn angegeben, werden nur bestimmte Meta-Informationen ermittelt - mögliche Werte (sprich "​MetaInformationTypeID"​s) : siehe [[dstoreproc>​mi_GetMetaInformationTypes_Ad TableID = 17]]\\ |varchar(100)|6.0.4|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeID|ID eines Artikel-Elementes,​ das in "​NodeID"​ bzw. "​tempdb.dbo.OneID"​ übergeben wurde\\ |integer|6.0.4 |
 +|MetaInformationType|Art der "​Meta-Information"​ (z.B. "​LastPropertyEdited",​ also wann die letzte Änderung an Eigenschaften stattfand)\\ |varchar(50)|6.0.4 |
 +|TranslatedMetaInformation|Die gespeicherte Information (zu "​NodeID"​) zur Art "​MetaInformationType"​ im "​Klartext"​. Je nach Art der Information steht hier ein Datum im Format "Apr 15 2001 17:​55:​23:​283PM"​ oder ein "​UserName"​ (aus "​UserInfo"​)\\ |varchar(255)|6.0.4 |
 +|MetaInformationTypeID|ID der Informations-Art "​MetaInformationType"​\\ |tinyint|6.0.4 |
 +|MetaInformation|Die gespeicherte Information (zu "​NodeID"​) zur Art "​MetaInformationType"​ wie sie intern gespeichert ist (als Zahl nämlich)\\ |decimal(19,​4)|6.0.4 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * NodeID (aufsteigend)
 +  * MetaInformationType (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|nur indirekt|
 +|-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt|
 +|-500|Falsche Parameter|nur 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]\\ ​ |
 +|6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard,​ u.a. wg. UTF8-Unterstützung\\ ​ |
 +|6.5.0 |2012-09-17|Anpassungen zur Rückgabe der "​TranslatedMetaInformation"​ für die MetaInformationTypes "​LastDetailEdited"​ und\\ "​LastDetailEditedFromUserID"​\\ ​ |
 +|6.0.4 |2011-10-21|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_GetNodeMetaInformation_Ad|im_GetNodeMetaInformation_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetNodeMetaInformation_Ad?​NodeID=<​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_GetNodeMetaInformation_Ad?​NodeID=<​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_GetNodeMetaInformation_Ad',​
 + array(
 + '​NodeID'​ => <​value>,​
 + // '​MetaInformationTypeIDList'​ => 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_GetNodeMetaInformation_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​NodeID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​MetaInformationTypeIDList">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getnodemetainformation_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)