Get Summarizations Endpoint

Gets the list of all summarization variables available for the given data hierarchy.

Availability: Business Analyst web app, Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/GetSummarizations/execute

Parameters

Parameter	Description
Query (optional)	A query string filtering requested variables. Type string. Available with Business Analyst Online and Business Analyst Server 10.0 SP2.
Length (optional)	The maximum number of requested variables. Negative value means requesting all remaining variables. Type int. Available with Business Analyst Online and Business Analyst Server 10.0 SP2. Default: -1.
Start (optional)	Zero-based index of the first requested variable. Type int. Available with Business Analyst Online and Business Analyst Server 10.0 SP2. Default: 0.
Visibility (optional)	Array of names of attributes of summarization variables to be requested. Type array of string. Available with Business Analyst Online and Business Analyst Server 10.0 SP2.
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.
DataHierarchy (optional)	Name of a hierarchy of data layers whose summarization variables are requested. Type string. Use the Get Data Hierarchies lookup operation to query available data hierarchies. Default: Standard Business Analyst Data.
token	Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Array of SummarizationInfo containing the list of summarization variables available for the given hiearchy of data layers. In the case of JSON and PJSON response types, the response format depends on the compatibility parameter value.

The HTML output of the Get Summarizations REST service will return all attributes of each Summarization variable record.

Remarks

To execute some analysis, you need to select summarization variables of data hierarchy on which analysis is going to run. This method is used to get summarization variables list from a hierarchy of data layers.

The Query is specified using the Lucene syntax. In the simple case, the string contains a search filter of the form "field-name:search-string" where field-name is the name of the field to search in and search-string is a string to search in the given field. For example, "category:CEX" query will select variables whose category property contains the "CEX" string (ignore case).

The following attributes of summarization variables are searchable: "Name", "Alias", "Category", "LongDescription", “Groups” and “Vintage.

Using the Visibility parameter you can request only those attributes of summarization variables which are necessary in your application. You can also requiest a group of attributes using special group names:

Group name	Description
$all	All attributes.
$id	The "Name" attribute.
$min	The "Name" and "Alias" attributes.
$default	The "Name", "Alias", "Category", and "LongDescription" attributes.
$thematic	Attributes required for thematic mapping.

If the Visibility parameter is missing, all attributes of summarization variables are requested in compatibility with version 10.0.

The Start and Length parameters allow you to request summarization variables with paging—the starting index and the maximum number of requested variables could be specified with these parameters.

NOTE: Since Business Analyst Server 10.0, the LayerID parameter is replaced with an optional DataHierarchy parameter.

Example Usage

The example below requests all summarization variables which are available in Business Analyst Server core dataset.

Request

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

Response

{
  "results":
  [
    {
      "paramName":"Summarization",
      "dataType":"BASummarizationInfos",
      "value":
      [
        {
          "Name":"TOTPOP_CY",
          "Alias":"2010 Total Population",
          "Category":"2010 Key Demographic Indicators",
          "LongDescription":"2010 Total Population",
          "Decimals":0,
          "Units":"count",
          "Vintage":"2010",
          "Groups":
          [
            "2010/2015 Demographics"
          ]
        },
        ...
        {
          "Name":"M33076a_I",
          "Alias":"Index:Spent $100+ on luggage/yr",
          "Category":"2010 Sports, Leisure & Travel (MPI)",
          "LongDescription":"",
          "Decimals":0,
          "IndexBase":0.03922,
          "Units":"count",
          "Vintage":"2010",
          "Groups":
          [
            "Market Potential"
          ]
        },
        {
          "Name":"TAPSEGNAM",
          "Alias":"Dominant Tapestry Segment",
          "Category":"Other",
          "LongDescription":"",
          "Units":"other"
        }
      ]
    }
  ],
  "messages":
  [
  ]
}

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