do_GetProcedureParameters_Ad [dstore]

Inhaltsverzeichnis

do_GetProcedureParameters_Ad

do_GetProcedureParameters_Ad

Gibt die Parameter und zugehörige Beschreibungen einzelner „dStore“-Prozeduren aus.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, Procedure, Parameters, Ad]
Engine-Kategorie	documentation
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ProcedureName		Name einer Prozedur, zu der die Parameter-Dokumentation ausgegeben werden soll	varchar(50)	4.0.0
ParameterName_Like	NULL	Wenn angegeben : Filterung („ProcedureName“ angegeben) bzw. Suche („ProcedureName is NULL“) nach Parametern, deren Name „wie“ („LIKE“-Operator wird verwendet, d.h. entsprechende „wildcards“ sind möglich) der hier angegeben Wert aussieht.	varchar(100)	7.0.0
FilterRowsWithEmptyDescr	0	„1“ angeben, um im Ergebnis nur Parameter zu haben, zu denen auch eine Beschreibung vorhanden (d.h. die Rückgabespalte „Description“ NICHT „NULL“ oder '') ist	bit	7.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ProcedureName	Name einer Prozedur (derzeit gleich „ProcedureName“, aber evtl. ist es in einer späteren Version möglich, die Parameter für mehrere Prozeduren auszugeben…)	varchar(50)	4.0.0
ParameterName	Parameter der Prozedur „ProcedureName“	varchar(50)	4.0.0
SortNo	Bestimmt die Reihenfolge des Parameters „ParameterName“ innerhalb aller Parameter der Prozedur „ProcedureName“. „0“ bedeutet, daß der Parameter nicht verwendet wird, also zwar in einer älteren Version vorhanden war, aber aktuell nicht mehr gültig ist.	tinyint	4.0.0
DataType	Gibt den Daten-Typ des Parameters „ParameterName“ an („varchar“, „tinyint“, etc.)	varchar(20)	4.0.0
Length	Wieviel Byte können Werte, die für den Parameter „ParameterName“ übergeben werden, maximal enthalten. Bei vielen Daten-Typen ist die Speicherbelegung immer so groß wie dieser Wert (bei numerischen Daten-Typen z.B.).	smallint	4.0.0
PrecisionValue	Gilt nur für einige numerische Daten-Typen (z.B. „decimal“) und gibt die maximale Anzahl Stellen an, die ein Wert für den Parameter „ParameterName“ enthalten kann	smallint	4.0.0
Scale	Gilt nur für einige numerische Daten-Typen (z.B. „decimal“) und gibt die Genauigkeit, sprich die maximale Anzahl an Nachkomma-Stellen an, die ein Wert für den Parameter „ParameterName“ enthalten kann	smallint	4.0.0
IsOutputParameter	Handelt es sich bei dem Parameter „ParameterName“ um einen Ausgabeparameter („0“ : Nein, „1“ : Ja) ?	bit	4.0.0
DefaultValue	Der Wert, mit dem der Parameter „ParameterName“ vorbelegt ist	varchar(255)	4.0.0
IntroducedIndStoreVersion	Seit welcher Version gibt es den Parameter „ParameterName“	varchar(20)	4.0.0
Description	Beschreibung der Bedeutung und Funktionsweise des Parameters „ParameterName“	varchar(255)	4.0.0
Description_ValidSinceVersion	Seit welcher dStore-Version die Beschreibung „Description“ gilt	varchar(20)	7.0.0
Description_LastEdited	Wann die Beschreibung „Description“ zuletzt geändert wurde	datetime	7.0.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ProcedureName (aufsteigend)
SortNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema 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	1. Neue Rückgabespalten „Description_ValidSinceVersion“ und „Description_LastEdited“ 2. Neue Parameter „ParameterName_Like“ und „FilterRowsWithEmptyDescr“
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.2	2013-02-26	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10	2004-03-15	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.0	2003-04-03	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:

do_GetProcedureParameters_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureParameters_Ad?ProcedureName=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureParameters_Ad?ProcedureName=<value>' | xmllint --format -

dStore_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'),
	'do_GetProcedureParameters_Ad',
		array(
			'ProcedureName' => '<value>',
			// 'ParameterName_Like' => NULL,
			// 'FilterRowsWithEmptyDescr' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

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_GetProcedureParameters_Ad">
			<Parameters>
				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="ParameterName_Like">NULL</Parameter> -->
				<!-- <Parameter Name="FilterRowsWithEmptyDescr">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis