Gibt die Dokumentation, d.h. die Beschreibung, einer Prozedur in einer bestimmten dStore-Version zurück.
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | do_GetProcedureDocumentation_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, zu der die Dokumentation / Beschreibung ermittelt werden soll | varchar(50) | 3.5.0 | |
Version | NULL | Wird nur im Fall „GetProcedureHeader = 0“ beachtet ! Nur die Dokumentation ermitteln, die für diese Version gültig ist (es kann somit auch eine frühere Version als die angegebene sein !). Bei „NULL“ werden alle vorhandenen Dokumentationen ermittelt. | varchar(20) | 3.5.0 |
GetProcedureHeader | 0 | Ist „1“ angegeben, wird die „interne Beschreibung“ zurückgegeben. Diese besteht aus dem kompletten „Prozedur-Kopf“ des Quelltextes (Deklaration der Prozedur inkl. Parameter und jeglichem Kommentar bis zum Implementations-Beginn). | bit | 6.0.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
SortNo5) | Wird nicht ausgegeben, sondern nur zur Sortierung verwendet. Bestimmt die Reihenfolge der „dStoreVersion“ innerhalb aller Versionen (spätere, sprich aktuellere, Version bedeutet : höhere „SortNo“) | smallint | 4.0.0 |
Documentation | Beschreibung, wozu die Prozedur „ProcedureName“ dient, sowie evtl. einige Hinweise und Anmerkungen. Im Fall „GetProcedureHeader = 1“ steht hier die „interne Beschreibung“ (kompletter „Prozedur-Kopf“ des Quelltextes) | text | 3.5.0 |
dStoreVersion | Version, auf die sich die Dokumentation „Documentation“ bezieht. Die Dokumentation ist natürlich im Regelfall noch für spätere Versionen gültig - solange jedenfalls bis es eine separate Dokumentation für eine höhere Version gibt… | varchar(20) | 4.0.0 |
LastEdited | Wann „Documentation“ (in der Version „dStoreVersion“) zuletzt geändert wurde | datetime | 7.0.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 |
-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 | Neue Rückgabespalte „LastEdited“ |
6.5.3 | 2013-03-18 | „StartProcedure“-Call wg. UTF-8-Unterstützung angepasst |
6.0.0 | 2010-03-26 | 1. Neuer Parameter „GetProcedureHeader“ 2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält. 3. Ab jetzt wird geprüft, ob „ProcedureName“ gültig ist |
4.0.10 | 2004-03-15 | 1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. „set transaction isolation level 1“, „set rowcount 0“ zu Beginn d. Prozedur 3. Fehlende „optimizer“- und Index-Angabe in einem Fall |
4.0.0 | 2003-04-03 | Neue Rückgabespalte „dStoreVersion“, Sortierung jetzt nach „SortNo“ von „dstore..dStoreVersions“ |
3.5.5 | 2001-03-30 | |
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/do_GetProcedureDocu_Ad?ProcedureName=<value>'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureDocu_Ad?ProcedureName=<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_GetProcedureDocu_Ad', array( 'ProcedureName' => '<value>', // 'Version' => NULL, // 'GetProcedureHeader' => 0 ) ); $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_GetProcedureDocu_Ad"> <Parameters> <Parameter Name="ProcedureName"><!-- varchar value --></Parameter> <!-- <Parameter Name="Version">NULL</Parameter> --> <!-- <Parameter Name="GetProcedureHeader">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>