Gibt Einstellungen zu „Teilen“ einer registrierten „dStore“-Anwendung aus.
Was sich letztlich hinter einem Anwendungs-Teil verbirgt, ist für den „dStore“ vollkommen bedeutungslos. Es kann sich hierbei um ein „Objekt“ handeln, oder um ein „Frame“, oder um eine Kombination von Fenstern, etc.
Hierdurch gibt es aber für die Anwendung die Möglichkeit, zu bestimmten Teilen Einstellungen hinterlegen zu können (s. mi_ModifyAppPartSettings_Ad).
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | mi_GetApplicationPartSettings_Ad |
Tags | |
Engine-Kategorie | basics |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ApplicationPartID | ID eines Teils einer „dStore“-Anwendung, zu dem Einstellungen ermittelt werden sollen. Bei Angabe von „NULL“ erwartet die Prozedur „ApplicationPartID“s in „tempdb.dbo.OneID“. | integer | 4.0.8 | |
UserID | NULL | ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad). Falls angegeben, werden nur die Einstellungen dieses Benutzers ausgegeben, sonst die des Benutzers, der die Prozedur aufruft. | smallint | 4.0.8 |
KeyVariable | NULL | Name eines Schlüssels, zu dem der für den Benutzer „UserID“ (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegte Wert zurückgegeben werden soll. „NULL“ angeben, um die Werte zu ALLEN hinterlegten Schlüsseln zu bekommen. | varchar(100) | 4.0.8 |
SearchForKeyVariableWithLike | 0 | Wird nur beachtet, wenn „KeyVariable“ nicht „NULL“ ist. Auf „1“ setzen, um die Werte zu allen Schlüsseln ermitteln zu lassen, die WIE „KeyVariable“ aussehen (gesucht wird mit „LIKE“, daher sind die T-SQL üblichen „wildcards“ „%“ und „_“ erlaubt). | bit | 4.0.8 |
IncludeValuesForGlobalUser | 1 | Ist zu einem Schlüssel kein Wert für den Benutzer angegeben, wird automatisch eine evtl. vorhandene Einstellung zur „UserID = -1“ (für „globale“ Einstellungen) ausgegeben, es sei denn, man übergibt hier „0“ | bit | 4.0.8 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ApplicationPartID | ID eines Teils einer „dStore“-Anwendung, zu dem die Einstellung „Value“ hinterlegt ist (entspricht entweder „ApplicationID“ oder einer ID, die via „tempdb.dbo.OneID“ übergeben wurde) | integer | 4.0.8 |
KeyVariable | Ein Schlüssel, zu dem der Wert „Value“ für den Benutzer „UserID“ (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegt ist | varchar(100) | 4.0.8 |
Value | Der Wert, der zum Schlüssel „KeyVariable“ für den Benutzer „UserID“ (bzw. für den die Prozedur aufrufenden Benutzer) hinterlegt ist | varchar(3500) | 4.0.8 |
ValueDerivedFromGlobalUser | „1“, falls „Value“ zur „UserID = -1“ gespeichert ist | bit | 4.0.8 |
(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 | 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] |
7.0.5 | 2014-05-26 | Doku angepasst. Rückgabespalte „Value“ hat nun als Datentyp „varchar[3500]„ |
7.0.0 | 2013-06-04 | Kleiner Doku-Fehler [verwendete Prozeduren] |
6.5.3 | 2013-03-18 | Interne Anpassungen wg. UTF8-Unterstützung |
4.0.9 | 2004-03-03 | 1. Verwendung von „_mi_ChooseParamValueSeperator“ als Vorbereitung von „_mi_StartProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur |
4.0.8 | 2004-02-20 | 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/mi_GetApplicPartSettings_Ad?ApplicationPartID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplicPartSettings_Ad?ApplicationPartID=<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'), 'mi_GetApplicPartSettings_Ad', array( 'ApplicationPartID' => <value>, // 'UserID' => NULL, // 'KeyVariable' => NULL, // 'SearchForKeyVariableWithLike' => 0, // 'IncludeValuesForGlobalUser' => 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="mi_GetApplicPartSettings_Ad"> <Parameters> <Parameter Name="ApplicationPartID"><!-- integer value --></Parameter> <!-- <Parameter Name="UserID">NULL</Parameter> --> <!-- <Parameter Name="KeyVariable">NULL</Parameter> --> <!-- <Parameter Name="SearchForKeyVariableWithLike">0</Parameter> --> <!-- <Parameter Name="IncludeValuesForGlobalUser">1</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>