Prozedur zur Ausgabe von sogenannten „Teilen“ registrierter „dStore-Anwendungen“, die für den Benutzer, der diese Prozedur aufruft, definiert sind.
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. Hintergrund hierfür ist die Möglichkeit für die Anwendung, zu diesen Teilen bestimmte Einstellungen hinterlegen zu können - siehe dazu mi_ModifyAppPartSettings_Ad.
Anmerkung zum Parameter „GetPartsForGlobalUser“ :
Anwendungs-Teile können sowohl „global“ (zur „UserID = -1“) als auch speziell für einen Benutzer definiert sein.
Ist „GetPartsForGlobalUser = 1“, werden sowohl die Anwendungs-Teile zur „UserID = -1“ als auch zu dem Benutzer, der diese Prozedur aufruft, berücksichtigt. Setzt man diesen Parameter auf „2“, bekommt man NUR Anwendungs-Teile, die global definiert sind.
Anmerkung zum Parameter „SearchForAppPartWithLike“ :
Ist „1“ angegeben, d.h. soll mit dem „LIKE“-Operator gesucht werden, kann „ApplicationPart“ die in T-SQL erlaubten „wildcards“ („%“ für eine beliebige Zeichenkette, „_“ für ein beliebiges Zeichen) enthalten. „ApplicationPart“ darf aber NICHT mit einem „wildcard“ (also mit „%“ oder „_“) BEGINNEN !
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | miscellaneous |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ApplicationID | ID einer registrierten „dStore“-Anwendung, zu der ein oder mehrere Teil(e) ermittelt werden sollen. | smallint | 4.0.12 | |
ApplicationPart | Je nach „SearchForAppPartWithLike“ wird der Teil ausgegeben (der durch „ApplicationID“ angegebenen Anwendung), der genauso heißt („=“-Operator) oder aber die Teile, die so „ähnlich“ heißen („LIKE“-Operator) | varchar(250) | 4.0.12 | |
SearchForAppPartWithLike | 0 | „0“ : Den Datensatz ausgeben, für den „ApplicationPart = ApplicationPart“ gilt „1“ : Die Datensätze ausgeben, für die „ApplicationPart LIKE ApplicationPart“ gilt (s. a. Beschreibung !) | bit | 4.0.12 |
GetPartsForGlobalUser | 0 | „0“ : Nur Teile des Benutzers, der diese Prozedur aufruft, beachten „1“ : Auch „global“ definierte Teile berücksichtigen „2“ : NUR „global“ definierte Teile beachten (s. a. Beschreibung !) | tinyint | 4.0.12 |
OutputIntoOneID | 0 | Soll eine Ergebnismenge geliefert werden oder sollen die ermittelten „ApplicationPartID“ in „tempdb.dbo.OneID“ gespeichert werden ? „0“ : NUR eine Ergebnismenge „1“ : SOWOHL eine Ergebnismenge ALS AUCH Speicherung der IDs „2“ : NUR Speicherung der IDs | tinyint | 4.0.12 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ApplicationPartID | ID eines Teils der Anwendung „ApplicationID“ | integer | 4.0.12 |
UserID | ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist und zu dem „ApplicationPartID“ gehört („-1“ bedeutet, daß es sich um einen globalen Anwendungs-Teil handelt) | smallint | 4.0.12 |
ApplicationPart | Bezeichnung des Anwendung-Teils „ApplicationPartID“ | varchar(250) | 4.0.12 |
(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] |
6.5.3 | 2013-03-18 | Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung |
4.0.12 | 2004-04-30 | 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_GetApplicationParts_Pu?ApplicationID=<value>&ApplicationPart=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplicationParts_Pu?ApplicationID=<value>&ApplicationPart=<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_GetApplicationParts_Pu', array( 'ApplicationID' => <value>, 'ApplicationPart' => '<value>', // 'SearchForAppPartWithLike' => 0, // 'GetPartsForGlobalUser' => 0, // 'OutputIntoOneID' => 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="mi_GetApplicationParts_Pu"> <Parameters> <Parameter Name="ApplicationID"><!-- smallint value --></Parameter> <Parameter Name="ApplicationPart"><!-- varchar value --></Parameter> <!-- <Parameter Name="SearchForAppPartWithLike">0</Parameter> --> <!-- <Parameter Name="GetPartsForGlobalUser">0</Parameter> --> <!-- <Parameter Name="OutputIntoOneID">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>