FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.0   R E S T   A P I   L O O K U P   U T I L I T Y

Get Available Report Formats Endpoint

Gets the list of all available report formats.

 

Availability: Business Analyst Server.

 

URL Example

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/GetAvailableReportFormats/execute

Parameters

Parameter

Description

ActiveDatasetID (optional)

ID of the active dataset. Type string.

Default: ID of the first available dataset.

f (optional)

Response format. Type string. Available formats: HTML, JSON, PJSON, XML.

Default: HTML.

token

Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of string containing the list of all available formats.

Example Usage

The example below requests a string array of available report output formats. These are string aliases for the available constants in the esriReportFormat type.

 

Request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/GetAvailableReportFormats/execute?
ActiveDatasetID=USA_ESRI&
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"PDF"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"HTML"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"ZIP"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"CSV"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"S.XML"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"XLSX"
    },
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"XML"
    }
  ],
  "messages":
  [
  ]
}

 

See Also

Get Report Templates Endpoint

Business Analyst Server REST API Reference