do_GetdStoreVersions_Ad [dstore]

Inhaltsverzeichnis

do_GetdStoreVersions_Ad

do_GetdStoreVersions_Ad

Liefert die verschiedenen dStore-Versionen, die bereits veröffentlicht wurden. Optional kann man sich alle Versionen ausgeben lassen, zu der es für eine bestimmte Prozedur eine Dokumentation gibt, und es gibt die Möglichkeit zu sehen, in welchen Versionen eine Prozedur geändert wurde (unabhängig davon, ob die Dokumentation geändert wurde oder nicht).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Getd, Store, Versions, 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	NULL	Name einer Prozedur, zu der man wissen möchte, in welchen Versionen es Dokumentationen gibt	varchar(50)	3.5.0
GetAllVersionsForProcedure	0	Wird nur beachtet, wenn „ProcedureName“ angegeben ist ! „0“ : Alle Versionen der Prozedur „ProcedureName“ ausgegeben, zu denen es eine Dokumentation gibt „1“ : Alle Versionen ausgeben, in denen die Prozedur „ProcedureName“ geändert wurde	bit	4.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht ausgegeben - war nur bis Version 6.5.4 relevant (wurde zur Sortierung verwendet - entspricht seit Version 7.0.0 „VersionSortNo“)	smallint	4.0.0
dStoreVersion	Eine „dStore“-Versionsnummer (von der Form „3.5.17“), die bereits veröffentlicht wurde bzw. zu der es für „ProcedureName“ eine Dokumentation gibt	varchar(20)	3.5.0
ReleaseDateAndTime	Release-Datum der Version	datetime	4.0.0
VersionSortNo	Bestimmt die Reihenfolge von „dStoreVersion“ innerhalb aller dStore-Versionen	smallint	7.0.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

VersionSortNo (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	nur 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	Neue Rückgabespalte „VersionSortNo“
6.5.3	2013-03-18	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	1. Berücksichtigung der neuen Tabelle „dStoreVersions“ 2. Neue Rückgabespalte 3. Neuer Parameter „GetAllVersionsForProcedure“
3.5.0	2000-11-23	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_GetdStoreVersions_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetdStoreVersions_Ad'

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetdStoreVersions_Ad' | 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_GetdStoreVersions_Ad',
		array(
			// 'ProcedureName' => NULL,
			// 'GetAllVersionsForProcedure' => 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_GetdStoreVersions_Ad">
			<Parameters>
				<!-- <Parameter Name="ProcedureName">NULL</Parameter> -->
				<!-- <Parameter Name="GetAllVersionsForProcedure">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

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