Prozedur zur Verwaltung von Einstellungen zu einem „Kommando“ - das sind Programme, mit denen eine „Action“ (s.a. ac_GetActions_Ad) abgearbeitet werden kann.
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | actions |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
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) | smallint | 5.5.0 | |
KeyVariable | Ein Schlüssel (z.B. „ForumIDForActionLog“), zu dem der (zu „CommandID“) hinterlegte Wert konfiguriert werden soll. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'CommandSettings' “. | varchar(100) | 5.5.0 | |
Value | Wert, der zum Schlüssel „KeyVariable“ zum Kommando „CommandID“ gesetzt werden soll. „NULL“ bedeutet, daß der Wert gelöscht werden soll. | varchar(255) | 5.5.0 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-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 |
-555 | Der CommandSettings-Eintrag darf nicht mehr geändert werden | nur direkt |
-554 | Der CommandSettings-Eintrag darf nicht gelöscht werden | nur direkt |
-540 | Falsches Format | nur direkt |
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
7.0.0 | 2013-06-04 | Kleiner Doku-Fehler [verwendete Prozeduren] |
6.5.3 | 2013-03-18 | Interne Anpassungen wg. UTF8-Unterstützung |
5.5.0 | 2008-01-07 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/ac_ModifyCommandSettings_Ad?CommandID=<value>&KeyVariable=<value>&Value=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/ac_ModifyCommandSettings_Ad?CommandID=<value>&KeyVariable=<value>&Value=<value>' | xmllint --format -
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_ModifyCommandSettings_Ad', array( 'CommandID' => <value>, 'KeyVariable' => '<value>', 'Value' => '<value>' ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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_ModifyCommandSettings_Ad"> <Parameters> <Parameter Name="CommandID"><!-- smallint value --></Parameter> <Parameter Name="KeyVariable"><!-- varchar value --></Parameter> <Parameter Name="Value"><!-- varchar value --></Parameter> </Parameters> </Procedure> </Batch> </ListOfBatches>