Get Custom Layers Endpoint

Gets IDs and names of all available custom data layers.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetCustomLayers/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. In Business Analyst Server, 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. In Business Analyst Server, this parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of IDNamePair.

Remarks

Use this method when you want IDs and names of custom data layers available for use in Business Analyst Server REST endpoints.

Example Usage

The example below requests all custom data layers available in Business Analyst Server core dataset.

Request

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

Response

{
  "results":
  [
    {
      "paramName":"CustomLayers",
      "dataType":"BAIDNamePairs",
      "value":
      [
        {
          "ID":"user_data\\bgcrime.bds",
          "Name":"bgcrime"
        },
        {
          "ID":"user_data\\crimebg\\crimebg\\crimebg.bds",
          "Name":"crimebg"
        },
        {
          "ID":"user_data\\testmycustbds\\testmycustbds.bds",
          "Name":"testmycustbds"
        }
      ]
    }
  ],
  "messages":
  [
  ]
}