Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:ac_getcommandsettingentry

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:ac_getcommandsettingentry [11.01.2016 ]
engine:procedures:ac_getcommandsettingentry [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== ac_GetCommandSettingEntry =====
 +
 +Liefert den konfigurierten Wert zu einem bestimmten Schlüssel eines bestimmten Kommandos (bzw. "​Programms"​),​ mit dem "​Actions"​ abgearbeitet werden können (s.a. [[dstoreproc>​ac_GetCommands_Ad]]) zurück.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[ac Get Command Setting Entry]}}|
 +|Engine-Kategorie|actions |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|5.5.0 (2008-01-07)|
 +
 +==== 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 ^
 +|__CommandID__| |ID eines Kommandos (bzw. Programms) mit dem "​Actions"​ abgearbeitet werden können (mögliche Werte : s. [[dstoreproc>​ac_GetCommands_Ad]])\\ |smallint|5.5.0|
 +|__KeyVariable__| |Ein Schlüssel (z.B. "​ForumIDForActionLog"​),​ zu dem der hinterlegte Wert ausgegeben werden soll. Mögliche Werte : siehe Rückgabemenge von " do_GetSettingsDescriptions_Ad '​CommandSettings'​ ".\\ |varchar(100)|5.5.0|
 +|SelectResult|0 |"​0"​ : Der zum Schlüsel "​KeyVariable"​ hinterlegte Wert wird NUR über den Ausgabeparameter "​Value"​ zurückgegeben\\ "​1"​ : Es wird ZUSÄTZLICH eine Rückgabemenge bereitgestellt\\ |bit|5.5.0|
 +==== Rückgabe ====
 +
 +=== wenn SelectResult = 1 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|Value|Der für "​CommandID"​ zum Schlüssel "​KeyVariable"​ konfigurierte Wert\\ |varchar(255)|5.5.0 |
 +==== Output-Parameter ====
 +
 +|Value|Ausgabeparameter für den zum Schlüssel "​KeyVariable"​ hinterlegten Wert|
 +==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-556|Fehlender oder falscher Eintrag in CommandSettings|nur direkt|
 +|-500|Falsche Parameter|nur direkt|
 +==== 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 ====
 +
 +|5.5.0 |2008-01-07|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=ac_GetCommandSettingEntry|ac_GetCommandSettingEntry im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​ac_GetCommandSettingEntry?​CommandID=<​value>&​KeyVariable=<​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/​ac_GetCommandSettingEntry?​CommandID=<​value>&​KeyVariable=<​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'​),​
 + '​ac_GetCommandSettingEntry',​
 + array(
 + '​CommandID'​ => <​value>,​
 + '​KeyVariable'​ => '<​value>',​
 + // '​SelectResult'​ => 0
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +$OutputParams = $xml_result->​getOutputParametersAsArray();</​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="​ac_GetCommandSettingEntry">​
 + <​Parameters>​
 + <​Parameter Name="​CommandID"><​!-- smallint value --></​Parameter>​
 + <​Parameter Name="​KeyVariable"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​SelectResult">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/ac_getcommandsettingentry.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)