engine:procedures:ac_modifycommandsettings_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:ac_modifycommandsettings_ad [11.01.2016 ] |
engine:procedures:ac_modifycommandsettings_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== ac_ModifyCommandSettings_Ad ===== | ||
| + | |||
| + | Prozedur zur Verwaltung von Einstellungen zu einem "Kommando" - das sind Programme, mit denen eine "Action" (s.a. [[dstoreproc>ac_GetActions_Ad]]) abgearbeitet werden kann.\\ | ||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[ac Modify Command Settings Ad]}}| | ||
| + | |Engine-Kategorie|actions | | ||
| + | |Engine-Typ|Daten-Änderung | | ||
| + | |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 ^ | ||
| + | |__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 (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| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | Die Prozedur hat keine Rückgaben. | ||
| + | ==== 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| | ||
| + | |-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| | ||
| + | ==== 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.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\\ | | ||
| + | |||
| + | ==== 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_ModifyCommandSettings_Ad|ac_ModifyCommandSettings_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/ac_ModifyCommandSettings_Ad?CommandID=<value>&KeyVariable=<value>&Value=<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 POST 'http://<partner>-<project>.dstore.de/default/engine/ac_ModifyCommandSettings_Ad?CommandID=<value>&KeyVariable=<value>&Value=<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_ModifyCommandSettings_Ad', | ||
| + | array( | ||
| + | 'CommandID' => <value>, | ||
| + | 'KeyVariable' => '<value>', | ||
| + | 'Value' => '<value>' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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="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></code> | ||
engine/procedures/ac_modifycommandsettings_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)