Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:mi_gettabsrefinothertabs_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== mi_GetTabsRefInOtherTabs_Ad ===== | ||
+ | |||
+ | Gibt einfach den Inhalt aus "TablesReferencedInOtherTables" aus. Dort sind alle Tabellen definiert, die in diversen anderen Tabellen (immer über eine Spalte "TableID") referenziert werden. In welchen Tabellen, ist über die "UsedIn"-Spalten zu ersehen.\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Alias|mi_GetTablesReferencedInOtherTables_Ad | | ||
+ | |Tags|{{tag>[mi Get Tables Referenced In Other Tables Ad]}}| | ||
+ | |Engine-Kategorie|basics | | ||
+ | |Engine-Typ|Daten-Ermittlung | | ||
+ | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |TableID|NULL |ID einer Tabelle. Falls angegeben, wird nur der Datensatz zu dieser ID zurückgegeben.\\ |tinyint|4.0.6| | ||
+ | |UsedInSearchItems|NULL |Wert "0" oder "1" angeben, um nach "UsedInSearchItems" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|4.0.6| | ||
+ | |UsedInSearchItemLacks|NULL |Wert "0" oder "1" angeben, um nach "UsedInSearchItemLacks" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|4.0.6| | ||
+ | |UsedInRatingValues|NULL |Wert "0" oder "1" angeben, um nach "UsedInRatingValues" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|4.0.6| | ||
+ | |UsedInRatingSubjects|NULL |Wert "0" oder "1" angeben, um nach "UsedInRatingSubjects" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|4.0.6| | ||
+ | |UsedInMetaInformationTypes|NULL |Wert "0" oder "1" angeben, um nach "UsedInMetaInformationTypes" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|4.0.6| | ||
+ | |UsedInPersonCharacValueRefs|NULL |Wert "0" oder "1" angeben, um nach "UsedInPersonCharacValueRefs" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|5.1.7| | ||
+ | |UsedInPredefinedBillContent|NULL |Wert "0" oder "1" angeben, um nach "UsedInPredefinedBillContent" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|5.5.0| | ||
+ | |UsedInCashAccTransactions|NULL |Wert "0" oder "1" angeben, um nach "UsedInCashAccTransactions" zu filtern (siehe Dokumentation dieser Rückgabespalte)\\ |tinyint|6.0.2| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |TableID|ID der Tabelle "TableName"\\ |tinyint|4.0.4 | | ||
+ | |TableName|Name der (dStore-)Tabelle\\ |varchar(50)|4.0.4 | | ||
+ | |PrimaryKeyColumnName|Spaltenname(n) aus denen der Primärschlüssel der Tabelle besteht\\ |varchar(50)|4.0.4 | | ||
+ | |UsedInSearchItems|"1" falls die "TableID" in der Spalte "TableID" von "SearchItems" referenziert werden kann\\ |bit|4.0.4 | | ||
+ | |UsedInSearchItemLacks|"1" falls die "TableID" in der Spalte "TableID" von "SearchItemLacks" referenziert werden kann\\ |bit|4.0.4 | | ||
+ | |UsedInRatingValues|"1" falls die "TableID" in der Spalte "TableID" von "RatingValues" referenziert werden kann\\ |bit|4.0.4 | | ||
+ | |UsedInRatingSubjects|"1" falls die "TableID" in der Spalte "TableID" von "RatingSubjects" referenziert werden kann\\ |bit|4.0.4 | | ||
+ | |UsedInMetaInformationTypes|"1" falls die "TableID" in der Spalte "TableID" von "MetaInformationTypes" referenziert werden kann\\ |bit|4.0.4 | | ||
+ | |UsedInPersonCharacValueRefs|"1" falls die "TableID" in der Spalte "TableID" von "PersonCharacValueReferences" referenziert werden kann\\ |bit|5.1.7 | | ||
+ | |UsedInPredefinedBillContent|"1" falls die "TableID" in der Spalte "TableID" von "PredefinedBillContent" referenziert werden kann\\ |bit|5.5.0 | | ||
+ | |UsedInCashAccTransactions|"1" falls die "TableID" in der Spalte "TableID" von "CashAccountTransactions" referenziert werden kann\\ |bit|6.0.2 | | ||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
+ | |||
+ | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-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| | ||
+ | |-500|Falsche Parameter|direkt und indirekt| | ||
+ | ==== XML-Schema ==== | ||
+ | |||
+ | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
+ | ==== Historie ==== | ||
+ | |||
+ | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
+ | |6.0.2 |2011-06-08|Neue Spalte in "TablesReferencedInOtherTables" =>\\ 1. Neue Rückgabespalte "UsedInCashAccTransactions"\\ 2. Neuer Parameter "UsedInCashAccTransactions"\\ | | ||
+ | |5.5.0 |2008-01-07|1. Neuer Parameter "UsedInPredefinedBillContent"\\ 2. Neue Rückgabespalte "UsedInPredefinedBillContent"\\ 3. Ab jetzt gibt es "-500", wenn für einen der "Used..."-Parameter ein Wert größer als "1" angegeben wird\\ | | ||
+ | |5.1.7 |2006-10-31|1. Neuer Parameter "UsedInPersonCharacValueRefs"\\ 2. Neue Rückgabespalte "UsedInPersonCharacValueRefs"\\ | | ||
+ | |4.0.14 |2004-06-03|1. Aufruf der Prozeduren "_mi_StartProcedure" und "_mi_FinishProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
+ | |4.0.6 |2003-11-14|In Sachen Parameter von 0 auf 6...\\ | | ||
+ | |4.0.4 |2003-08-26|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: | ||
+ | * [[http://playground.dstore.de/index.php?proc=mi_GetTabsRefInOtherTabs_Ad|mi_GetTabsRefInOtherTabs_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetTabsRefInOtherTabs_Ad'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetTabsRefInOtherTabs_Ad' | xmllint --format -</code>== dStore_php == | ||
+ | <code 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'), | ||
+ | 'mi_GetTabsRefInOtherTabs_Ad', | ||
+ | array( | ||
+ | // 'TableID' => NULL, | ||
+ | // 'UsedInSearchItems' => NULL, | ||
+ | // 'UsedInSearchItemLacks' => NULL, | ||
+ | // 'UsedInRatingValues' => NULL, | ||
+ | // 'UsedInRatingSubjects' => NULL, | ||
+ | // 'UsedInMetaInformationTypes' => NULL, | ||
+ | // 'UsedInPersonCharacValueRefs' => NULL, | ||
+ | // 'UsedInPredefinedBillContent' => NULL, | ||
+ | // 'UsedInCashAccTransactions' => NULL | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $service->execute($request); | ||
+ | |||
+ | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
+ | $ResultSet = $xml_result->getRowsAsArray(); | ||
+ | |||
+ | </code> | ||
+ | == engine/execute == | ||
+ | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
+ | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <ListOfBatches> | ||
+ | <Batch No="0"> | ||
+ | <Procedure Name="mi_GetTabsRefInOtherTabs_Ad"> | ||
+ | <Parameters> | ||
+ | <!-- <Parameter Name="TableID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInSearchItems">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInSearchItemLacks">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInRatingValues">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInRatingSubjects">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInMetaInformationTypes">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInPersonCharacValueRefs">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInPredefinedBillContent">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="UsedInCashAccTransactions">NULL</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||