Get Segments Endpoint

Gets the list of all available segments.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetSegments/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, XML. Default: HTML.
token	Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of SegmentInfo containing the list of all available segments. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

Example Usage

The example below requests Tapestry segments which are available in Business Analyst Server core dataset.

Request

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

Response

{
  "results":
  [
    {
      "paramName":"Segments",
      "dataType":"BASegmentInfos",
      "value":
      [
        {
          "ID":"1",
          "Name":"Top Rung",
          "Alias":"Top Rung"
        },
        ...
        {
          "ID":"66",
          "Name":"Unclassified",
          "Alias":"Unclassified"
        }
      ]
    }
  ],
  "messages":
  [
  ]
}

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