Erlaubt die Auflistung und Suche von Berichtsvorlagen (Report Templates).
URL
GET /api/v1/templates
Optionale Parameter
Übergabe möglich in URL als ?param=value oder Form-Encoded im Request-Body
|
Name |
Werte |
Default |
Funktion |
|
query |
string |
- |
Wenn nicht angegeben, werden alle Berichtsvorlagen, auf die der Client Zugriffsrechte hat, zurückgeliefert. Wenn angegeben, werden nur Berichtsvorlagen geliefert, die in ihrem Namen und ihrer Beschreibung alle angegebenen Wörter (mit Leerzeichen getrennt) enthalten (UND-Verknüpfung der Suchbegriffe) query kann maximal 256 Zeichen lang sein und insgesamt höchstens 10 Suchbegriffe umfassen. |
|
format |
json/xml |
xml |
Bestimmt das Datenformat der gelieferten Liste (JSON oder XML). |
Rückgabe
Es wird ein Array vom Typ ReportTemplateEntry (siehe unten) zurückgeliefert.
Fehler (zusätzlich zu Allgemeine Fehlercodes)
|
Statuscode |
Statustext |
Erläuterung |
|
400 |
ERR_INVALID_PARAM |
Der query-Parameter ist zu lang oder umfasst zu viele Suchbegriffe. |
Beispiele
▪ http://combitreportserver/api/v1/templates
Liefert eine Liste aller Berichtsvorlagen, auf die der Client Zugriffsrechte hat. (Rückgabe als XML)
▪ http://combitreportserver/api/v1/templates?query=Sales%202015&format=json
Liefert eine Liste aller Berichtsvorlagen, die die Wörter "Sales" und "2015" enthalten (hier die URL-Kodierung von Leerzeichen als %20 beachten!) (Rückgabe als JSON).
Rückgabe-Typ: ReportTemplateEntry
Als XML
<?xml version="1.0" encoding="utf-16"?>
<ArrayOfReportTemplateEntry xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ReportTemplateEntry>
<ID>F92699D8-FA81-4C92-9AE5-A5EA2E5F8E61</ID>
<Name>Sales Charts 2015</Name>
<Description>This is the description.</Description>
<ExportLink>http://combitreportserver/api/v1/report/F92699D8-FA81-4C92-9A
E5-A5EA2E5F8E61/export</ExportLink>
<CreatedBy>Jon Doe</CreatedBy>
<CreatedOnUTC>2014-10-16T12:02:52</CreatedOnUTC>
<ModifiedBy>Foo Bar</ModifiedBy>
<ModifiedOnUTC>2014-10-21T07:42:25</ModifiedOnUTC>
</ReportTemplateEntry>
[...]
</ArrayOfReportTemplateEntry
Als JSON
[
{
"ID": "F92699D8-FA81-4C92-9AE5-A5EA2E5F8E61",
"Name": "Sales Charts 2015",
"Description": "This is the description.",
"ExportLink": "http://<servername>/rs31/api/v1/report/F92699D8-FA81-4C92-9AE5-
A5EA2E5F8E61/export",
"CreatedBy": "Jon Doe",
"CreatedOnUTC": "2014-10-16T12:02:52",
"ModifiedBy": "Foo Bar",
"ModifiedOnUTC": "2014-10-21T07:42:25"
},
...
}