Erlaubt die Auflistung und Suche von Berichtsvorlagen (Report Templates).
URL
GET /api/v1/report/{TemplateID}/parameters
Optionale Parameter
Übergabe möglich in URL als ?param=value oder Form-Encoded im Request-Body
|
Name |
Werte |
Default |
Funktion |
|
format |
json/xml |
xml |
Legt das Format fest, mit dem das ReportDataParameter-Objekt serialisiert wird. |
Rückgabe
Es wird eine Aufzählung vom Typ ReportDataParameter (siehe unten) zurückgeliefert.
Fehler (zusätzlich zu Allgemeine Fehlercodes)
|
Statuscode |
Statustext |
Erläuterung |
|
403 |
ERR_ACCESS_DENIED |
Keine Zugriffsrechte auf Berichtsvorlage / Datenquelle. |
|
404 |
ERR_INVALID_TEMPLATE |
Berichtsvorlage nicht gefunden. |
|
520 |
- |
Fehler beim Export. Eine lokalisierte Fehlermeldung befindet sich im Request Body (XML/JSON). |
Rückgabe-Typ: IEnumerable<ReportDataParameter>
Es wird eine Aufzählung von ReportDataParametern zurückgegeben.
|
ReportDataParameter | ||
|
Guid |
Die global eindeutige ID des Parameters | |
|
string |
ParentGuid |
Wenn nicht Null, ist es die ID des Parameters, von dem dieser Parameter abhängt. |
|
string |
Name |
Name des Parameters. |
|
string |
HelpText |
Text, der hilft, die Verwendung des Parameters zu verstehen. |
|
bool |
IsVisible |
Sichtbarkeit des Parameters. |
|
object |
Value |
Wert des Parameters. |
|
IEnumerable<Choice> |
Choices |
Wenn der Paramater keine Abhängigkeit hat (ParentGuid == null), sind in 'Choice' alle verfüg-baren Auswahlmöglichkeiten vorhanden. |
|
bool |
SelectMultiple |
Ob Sie mehrere Elemente auswählen können. |
|
bool |
MayBeEmpty |
Ob Sie kein Element auswählen können. |
|
bool |
MayBeNull |
Ob dieser Parameter Null sein darf oder erforderlich ist. |
|
ReportDataParameterSourceMode |
SourceMode |
'SourceMode' dieses Parameters (siehe unten). |
|
ReportDataParameterSourceType |
SourceType |
'SourceType' dieses Parameters (siehe unten). |
|
ReportDataParameterControlType |
ControlType |
'ControlType' dieses Parameters (siehe unten). |
Das Control für einen Parameter
|
ReportDataParameterControlType | |
|
Text |
z. B. Textfeld |
|
Date |
z. B. Datumsauswahl |
|
BoolYesNo |
z. B. Schalter, Radiobutton |
|
BoolTrueFalse |
z. B. Schalter, Radiobutton |
|
bool |
z. B. Datums- oder Uhrzeitauswahl |
Der 'SourceMode' eines ReportDataParameter
|
ReportDataParameterSourceMode | |
|
Database |
Datenbankquelle |
|
Choice |
Auswahlliste |
|
EditableText |
Einfacher Text |
Der 'SourceType' eines ReportDataParameter
|
ReportDataParameterControlType | |
|
Text |
Text |
|
Numeric |
Zahlen |
|
Date |
DatumZeit |
|
Boolean |
Logischer Wert |
Wenn der SourceMode 'Database' oder 'Choice' ist UND der Parameter keine Abhängigkeiten hat (ParentGuid == null), dann sind in der Property 'Choices' alle verfügbaren Auswahlmöglichkeiten vorhanden.
Eine einzelne Auswahlmöglichkeit:
|
Choice | ||
|
string |
Key |
Der Variablenname (z. B. "[LLvar]AvABAAA") von dieser Auswahl. Der Präfix "var://" wird vom Server mit "[LLVar]" ersetzt, um Zeichenprobleme zu vermeiden. |
|
string |
Value |
Der Wert / Name von dieser Auswahl. |
|
bool |
IsSelected |
Ob diese Auswahl bereits ausgewählt ist. |
Besonderheit bei Anhängigkeiten:
1. Über ParentGuid den Key der Auswahl des Eltern Parameters heraus finden: "[LLvar]AvABAAA"
2. [optional] Falls Eltern-Parameter ebenfalls Eltern-Parameter hat; dessen Key der Auswahl herausfinden:"[LLVar]AvACAAA"
3. Abhängende Auswahlmöglichkeiten abfragen (Siehe dazu Kapitel Voneinander abhängige Auswahlmöglichkeiten abfragen).
Hier ein Beispiel von abgerufenen Parametern:
Second hängt von First ab.
Third hängt von Second und damit auch von First ab.
Als XML
<ArrayOfReportDataParameter xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ReportDataParameter>
<Guid>4CC0CF55-24CA-4C49-9ABF-6402996FDB82</Guid>
<Name>First</Name>
<HelpText />
<IsVisible>false</IsVisible>
<Choices>
<Choice>
<Key>[LLVar]AwABAAAA</Key>
<Value>Beverages</Value>
<IsSelected>true</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwACAAAA</Key>
<Value>Condiments</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwADAAAA</Key>
<Value>Confections</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwAEAAAA</Key>
<Value>Dairy Products</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwAFAAAA</Key>
<Value>Grains/Cereals</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwAGAAAA</Key>
<Value>Meat/Poultry</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwAHAAAA</Key>
<Value>Produce</Value>
<IsSelected>false</IsSelected>
</Choice>
<Choice>
<Key>[LLVar]AwAIAAAA</Key>
<Value>Seafood</Value>
<IsSelected>false</IsSelected>
</Choice>
</Choices>
<SelectMultiple>false</SelectMultiple>
<MayBeNull>false</MayBeNull>
<MayBeEmpty>false</MayBeEmpty>
<SourceMode>Database</SourceMode>
<SourceType>Numeric</SourceType>
<ControlType>Text</ControlType>
</ReportDataParameter>
<ReportDataParameter>
<Guid>4EBF075B-CAF6-4961-B0DE-493DEE4CE108</Guid>
<ParentGuid>4CC0CF55-24CA-4C49-9ABF-6402996FDB82</ParentGuid>
<Name>Second</Name>
<HelpText />
<IsVisible>false</IsVisible>
<Choices />
<SelectMultiple>false</SelectMultiple>
<MayBeNull>false</MayBeNull>
<MayBeEmpty>false</MayBeEmpty>
<SourceMode>Database</SourceMode>
<SourceType>Numeric</SourceType>
<ControlType>Text</ControlType>
</ReportDataParameter>
<ReportDataParameter>
<Guid>028703D7-A7C1-4B67-84F5-37437F9CE4B8</Guid>
<ParentGuid>4EBF075B-CAF6-4961-B0DE-493DEE4CE108</ParentGuid>
<Name>Third</Name>
<HelpText />
<IsVisible>false</IsVisible>
<Choices />
<SelectMultiple>false</SelectMultiple>
<MayBeNull>false</MayBeNull>
<MayBeEmpty>false</MayBeEmpty>
<SourceMode>Database</SourceMode>
<SourceType>Numeric</SourceType>
<ControlType>Text</ControlType>
</ReportDataParameter>
</ArrayOfReportDataParameter>
Als JSON
[
{
"Guid": "4CC0CF55-24CA-4C49-9ABF-6402996FDB82",
"Name": "First",
"HelpText": "",
"IsVisible": false,
"Choices": [
{
"Key": "[LLVar]AwABAAAA",
"Value": "Beverages",
"IsSelected": true
},
{
"Key": "[LLVar]AwACAAAA",
"Value": "Condiments",
"IsSelected": false
},
{
"Key": "[LLVar]AwADAAAA",
"Value": "Confections",
"IsSelected": false
},
{
"Key": "[LLVar]AwAEAAAA",
"Value": "Dairy Products",
"IsSelected": false
},
{
"Key": "[LLVar]AwAFAAAA",
"Value": "Grains/Cereals",
"IsSelected": false
},
{
"Key": "[LLVar]AwAGAAAA",
"Value": "Meat/Poultry",
"IsSelected": false
},
{
"Key": "[LLVar]AwAHAAAA",
"Value": "Produce",
"IsSelected": false
},
{
"Key": "[LLVar]AwAIAAAA",
"Value": "Seafood",
"IsSelected": false
}
],
"SelectMultiple": false,
"MayBeNull": false,
"MayBeEmpty": false,
"SourceMode": "Database",
"SourceType": "Numeric",
"ControlType": "Text"
},
{
"Guid": "4EBF075B-CAF6-4961-B0DE-493DEE4CE108",
"ParentGuid": "4CC0CF55-24CA-4C49-9ABF-6402996FDB82",
"Name": "Second",
"HelpText": "",
"IsVisible": false,
"Choices": [],
"SelectMultiple": false,
"MayBeNull": false,
"MayBeEmpty": false,
"SourceMode": "Database",
"SourceType": "Numeric",
"ControlType": "Text"
},
{
"Guid": "028703D7-A7C1-4B67-84F5-37437F9CE4B8",
"ParentGuid": "4EBF075B-CAF6-4961-B0DE-493DEE4CE108",
"Name": "Third",
"HelpText": "",
"IsVisible": false,
"Choices": [],
"SelectMultiple": false,
"MayBeNull": false,
"MayBeEmpty": false,
"SourceMode": "Database",
"SourceType": "Numeric",
"ControlType": "Text"
}
]