Get Data Hierarchies Endpoint

Gets the list of all available hierarchies of data layers.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetDataHierarchies/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.

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 hierarchies of data layers.

Remarks

Business Analyst Server uses demographic data from layers of a data hierarchy to calculate summarization variables for a custom boundary layer. The calculated data are then shown in reports or appended as attribute fields to output boundary layers. A data hierarchy is usually specified with the DataHierarchy parameter of a Business Analyst task. If this parameter is omitted, the default "Standard Business Analyst Data" hierarchy is used in demographic calculations.

Example Usage

The example below requests a string array of available hierarchies of data layers.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetDataHierarchies/execute?f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"OutputString",
      "dataType":"GPString",
      "value":"Standard Business Analyst Data"
    }
  ],
  "messages":
  [
  ]
}