Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:ac_getcommandsettingentry

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. ac_GetCommands_Ad) zurück.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieactions
Engine-TypDaten-Ermittlung
Letzte Aktualisierung5.5.0 (2008-01-07)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CommandID ID eines Kommandos (bzw. Programms) mit dem „Actions“ abgearbeitet werden können (mögliche Werte : s. ac_GetCommands_Ad)
smallint5.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
SelectResult0 „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
bit5.5.0

Rückgabe

wenn SelectResult = 1

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ValueDer für „CommandID“ zum Schlüssel „KeyVariable“ konfigurierte Wert
varchar(255)5.5.0

Output-Parameter

ValueAusgabeparameter für den zum Schlüssel „KeyVariable“ hinterlegten Wert

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-556Fehlender oder falscher Eintrag in CommandSettingsnur direkt
-500Falsche Parameternur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

5.5.0 2008-01-07Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/ac_GetCommandSettingEntry?CommandID=<value>&KeyVariable=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/ac_GetCommandSettingEntry?CommandID=<value>&KeyVariable=<value>' | 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'),
	'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();
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="ac_GetCommandSettingEntry">
			<Parameters>
				<Parameter Name="CommandID"><!-- smallint value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="SelectResult">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/ac_getcommandsettingentry.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)