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 Datasets Endpoint

Gets the list of IDs of all available datasets.

 

Availability: Business Analyst Online, Business Analyst Server.

 

URL Example

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

Parameters

Parameter

Description

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 datasets.

Remarks

To work with REST API you need to specify an active dataset from which Business Analyst Server performs calculations such as customer counts, distances, and other analyses. Since version 9.3.1, the active dataset is optional in parameters of all tasks. If it is omitted, the first dataset from the list of available datasets is used.

Example Usage

The example below requests an array of all available core analysis datasets installed in the current Business Analyst Server instance.

 

Request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/GetDataSets/execute?
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"USA_ESRI"
    }
  ],
  "messages":
  [
  ]
}

 

See Also

Business Analyst Server REST API Reference