Get Report Templates Endpoint

Gets the list of all available report templates for summary reports.

Availability: Business Analyst Online, Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetReportTemplates/execute

Parameters

Parameter	Description
ActiveDatasetID (optional)	ID of the active dataset. Type string. Default: ID of the first available dataset.
compatibility (optional)	Business Analyst Server version the JSON output is compatible with. Type string.
f (optional)	Response format. Type string. Available formats: HTML, JSON, PJSON, XML. Default: HTML.
token	Authentication token. In Business Analyst Server, this parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of ReportTemplateInfo. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Remarks

Business Analyst Server REST comes with a number of standard demographic report templates which can be used by summary reports to see what your customers look like demographically.

This method is used to get all available report templates for Summary Reports endpoint and for Trade Area tasks.

Example Usage

The example below requests an array of descriptions of all report templates available in the current instance of Business Analyst Server.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetReportTemplates/execute?
ActiveDatasetID=USA_ESRI_2011&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"ReportTemplates",
      "dataType":"BAReportTemplateInfos",
      "value":
      [
        {
          "name":"Age by Income Profile",
          "category":"Summary Reports",
          "title":"Age by Income Profile",
          "formats":
          [
            "PDF",
            "HTML",
            "ZIP",
            "CSV",
            "S.XML",
            "XLSX",
            "XML"
          ],
          "headers":
          [
            "locationname",
            "address",
            "latitude",
            "areadesc2",
            "longitude",
            "reportstyle",
            "binarylogo",
            "logo"
          ]
        },
        ...
        {
          "name":"Example Custom Report",
          "category":"Custom Reports",
          "title":"Example Custom Report",
          "formats":
          [
            "PDF",
            "HTML",
            "ZIP",
            "CSV",
            "S.XML",
            "XLSX",
            "XML"
          ],
          "headers":
          [
            "reportstyle",
            "binarylogo",
            "logo"
          ]
        }
      ]
    }
  ],
  "messages":
  [
  ]
}

NOTE: The response has been abbreviated where "..." is noted.