Gibt Bedingungen für eine Prozedur-Rückgabemenge zurück, unter denen diese Rückgabemenge sortiert wird oder sortiert werden kann (s. a. do_GetSortOrderForResultSet_Ad).
Die Rückgabemenge sieht so aus :
„ProcedureResultConditionID“ referenzierte) Rückgabemenge
der Prozedur die Bedingung „Condition“ erfüllen muß, um eine entsprechende
Sortierung der Rückgabemenge zu liefern
beim Aufruf erfüllen muß, damit die Rückgabemenge entsprechend sortiert wird
Sortiert wird aufsteigend nach „ConditionDescription und „ParameterName“.
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | do_GetProcedureResultSortingConditions_Ad |
Tags | |
Engine-Kategorie | documentation |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ProcedureName | Name einer Prozedur, die unter der in „ProcedureResultConditionID“ angegebenen Bedingung eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen | varchar(50) | 7.0.3 | |
ProcedureResultConditionID | ID einer Bedingung (mögliche Werte s. do_GetProcResultConditions_Ad), unter der „ProcedureName“ eine Rückgabemenge liefert, zu der evtl. dokumentierte Sortierungen (dieser Rückgabe) ermittelt werden sollen | integer | 7.0.3 | |
SortConditionID | NULL | ID einer Sortierungs-Bedingung. Falls angegeben, werden nur die genauen Bedingungen dieser Sortierung für die durch „ProcedureName“ und „ProcedureResultConditionID“ angegebene Rückgabemenge ermittelt. | integer | 7.0.3 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
SortConditionID | ID einer Sortierungs-Bedingung für die (durch „ProcedureName“ und „ProcedureResultConditionID“ referenzierte) Rückgabemenge. Falls angegeben, natürlich identisch mit „SortConditionID“. | integer | 7.0.3 |
ConditionDescription | Bezeichnung der Sortierungs-Bedingung „SortConditionID“ | varchar(100) | 7.0.3 |
ParameterName | Name eines Parameters der Prozedur „ProcedureName“, dessen Wert beim Aufruf die Bedingung „Condition“ erfüllen muß, damit die Rückgabemenge wie zu „SortConditionID“ hinterlegt (s. do_GetSortOrderForResultSet_Ad) sortiert wird | varchar(50) | 7.0.3 |
Condition | Bedingung, die der Wert des Parameters „ParameterName“ beim Aufruf der Prozedur erfüllen muß, damit die Rückgabemenge wie zu „SortConditionID“ hinterlegt (s. do_GetSortOrderForResultSet_Ad) sortiert wird | varchar(255) | 7.0.3 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 5) |
---|---|---|
-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 |
-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.4 | 2014-03-19 | Kleiner interner Doku-Fehler behoben |
7.0.3 | 2013-12-13 | 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/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetProcResSortConditions_Ad?ProcedureName=<value>&ProcedureResultConditionID=<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'), 'do_GetProcResSortConditions_Ad', array( 'ProcedureName' => '<value>', 'ProcedureResultConditionID' => <value>, // 'SortConditionID' => NULL ) ); $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="do_GetProcResSortConditions_Ad"> <Parameters> <Parameter Name="ProcedureName"><!-- varchar value --></Parameter> <Parameter Name="ProcedureResultConditionID"><!-- integer value --></Parameter> <!-- <Parameter Name="SortConditionID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>