Parameter-Beschreibungen eines Templates anzeigen
GET /ws/2.0/reporting/<group>/<template>/parameters.json
Gibt eine Liste der in dem gegebenen Template definierten Parameter mit weiteren Informationen wie Datentyp, Beschreibung oder Standardwertden zurück.
Der Parameter group
gibt den Namen der Template-Gruppe, der Parameter template
den Namen des Templates selbst an.
Datenfelder
Name | Typ | Beschreibung |
---|---|---|
name |
string | Name des Parameters |
type |
string | Datentyp des Parameters (int , real , bool , date , datetime , time , string ) |
required |
boolean | Gibt an, ob der Parameter zur Erstellung der Auswertung angegeben werden muss. |
description |
string | Beschreibung des Parameters |
preference |
mixed | (optional) Vorgabewert des Parameters. Dieser entsteht in der Regel durch die vorherige Auswahl des Benutzers. Beispiel: Wenn der Nutzer bei der letzten Auswertung eine bestimmte Mitarbeiter-Gruppe ausgewählt hat, wird diese als preference gespeichert. |
constraints |
array | (optional) Einschränkungen des Parameter-Wertes, wenn beispielsweise der Nutzer nur bestimmte Gruppen auswerten darf. Es wird ein assoziatives Array angegeben, dass die zulässigen Werte des Parameters als Schlüssel und Beschreibungstexte als Werte enthält (siehe Beispiel oben). |
Beispiel
Anfrage: GET /ws/2.0/reporting/projects/overview/parameters.json
Antwort: 200 OK
{
"parameters:" [
{
"name": "begin_date",
"type": "datetime",
"required": true,
"description": "Beginn der auszuwertenden Zeitraums"
}, {
"name": "end_date",
"type": "datetime",
"required": true,
"description": "Ende der auszuwertenden Zeitraums"
}, {
"name": "group_id",
"type": "int",
"required": true,
"description": "ID der auszuwertenden Mitarbeiter-Gruppe"
"preference": 48,
"constraints": {
48: "Hardware-Entwickler",
102: "Studenten"
}
]
}
HTTP-Statuscodes
Statuscode | Beschreibung |
---|---|
200 OK | Die Anfrage war erfolgreich. |
404 Not Found | Das angefragte Template existiert nicht. |