Gibt sogenannte „Actions“ zurück. Darunter sind letztlich Aufrufe anderer „Programme“ zu verstehen, die irgendwelche Aktionen (wie z.B. das Versenden einer Bestell-Bestätigung per Mail oder das Generieren eines Rechnungs-Dokumentes) durchführen, die nicht aus dem ASE heraus initiiert werden können.
Um den Fortschritt der Abarbeitung einer „Action“ sehen zu können, gibt es ein „Status“-Feld. Die Interpretation eines „Status“ ist vom „dStore“ bis auf eine Ausnahme nicht vorgeschrieben. Bei der Ausnahme handelt es sich um den Wert „-1“, der bedeutet, daß die „Action“ noch offen, d.h. nicht abgearbeitet ist.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | actions |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
Status | -1 | Angabe eines Status, in dem sich die ermittelten „Actions“ befinden sollen | integer | 3.5.0 |
FromDate | NULL | Einschränkung der Ausgabe bzgl. des Datums, an dem die „Action“ eingetragen wurde | datetime | 3.5.0 |
ToDate | NULL | Einschränkung der Ausgabe bzgl. des Datums, an dem die „Action“ eingetragen wurde | datetime | 3.5.0 |
ActionID | NULL | Um sich eine bestimmte „Action“ anzeigen zu lassen, kann hier die entsprechende ID übergeben werden - alle anderen Filter-Parameter werden dann ignoriert ! | integer | 5.5.0 |
CommandID | NULL | ID eines Kommandos (bzw. Programms) mit dem „Actions“ abgearbeitet werden können (mögliche Werte : s. ac_GetCommands_Ad). Falls angegeben, werden nur „Actions“ ermittelt, zu denen diese ID hinterlegt ist. | smallint | 5.5.0 |
IncludeParameterValues | 1 | Gibt an, ob zu jeder ermittelten „Action“ in der Rückgabemenge auch die Parameter enthalten sein sollen („1“) oder nicht („0“) | bit | 5.5.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ActionID | ID einer „Action“ | integer | 3.5.0 |
CommandID | ID des Kommandos (bzw. Programms), mit dem die „Action“ abgearbeitet werden soll | smallint | 3.5.0 |
Command | Aufruf (Kommando) des Programms, mit dem die „Action“ abgearbeitet werden soll (z.B. „/usr/bin/mail“) | varchar(255) | 3.5.0 |
DateAndTime | Zeitpunkt der Erstellung der „Action“ | datetime | 3.5.0 |
ParameterName | Name eines Parameters, der zur Abarbeitung benötigt wird (z.B. „OrderID“ bei einer Bestell-Bestätigung per Mail) | varchar(50) | 3.5.0 |
ParameterValue | Wert zum „ParameterName“ | varchar(255) | 3.5.0 |
Status | Status der „Action“ | integer | 3.5.0 |
(parameterunabängige Sortierung)
Spaltenname | Beschreibung | SQL-Datentyp5) | ab Version |
---|---|---|---|
ActionID | ID einer „Action“ | integer | 5.5.0 |
CommandID | ID des Kommandos (bzw. Programms), mit dem die „Action“ abgearbeitet werden soll | smallint | 5.5.0 |
Command | Aufruf (Kommando) des Programms, mit dem die „Action“ abgearbeitet werden soll (z.B. „/usr/bin/mail“) | varchar(255) | 5.5.0 |
DateAndTime | Zeitpunkt der Erstellung der „Action“ | datetime | 5.5.0 |
Status | Status der „Action“ | integer | 5.5.0 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-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 |
-500 | Falsche Parameter | nur 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] |
6.0.2 | 2011-06-08 | Holger Wies : Der Rückgabemenge im Fall von IncludeParameterValues bit = 0 fehlte die Spalte „DateAndTime“. |
6.0.0 | 2010-03-26 | Fehler im Fall „IncludeParameterValues = 0“ und gegebenem Status sowie „FromDate“ und „ToDate“ : es wurde ein kartesisches Produkt der eigentlichen Ergebnismenge mit ALLEN Datensätzen aus „ActionParameters“ zurückgegeben ! |
5.5.0 | 2008-01-07 | Neue Parameter „ActionID“, „CommandID“, „IncludeParameterValues“ |
4.0.9 | 2004-03-03 | 1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Doku der Rückgabemenge fehlte 3. Fehlende „optimizer“-Angaben 4. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur |
3.5.0 | 2000-11-23 | 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 GET 'http://<partner>-<project>.dstore.de/default/engine/ac_GetActions_Ad'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/ac_GetActions_Ad' | 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_GetActions_Ad', array( // 'Status' => -1, // 'FromDate' => NULL, // 'ToDate' => NULL, // 'ActionID' => NULL, // 'CommandID' => NULL, // 'IncludeParameterValues' => 1 ) ); $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_GetActions_Ad"> <Parameters> <!-- <Parameter Name="Status">-1</Parameter> --> <!-- <Parameter Name="FromDate">NULL</Parameter> --> <!-- <Parameter Name="ToDate">NULL</Parameter> --> <!-- <Parameter Name="ActionID">NULL</Parameter> --> <!-- <Parameter Name="CommandID">NULL</Parameter> --> <!-- <Parameter Name="IncludeParameterValues">1</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>