Open Segmentation Profile Endpoint

Returns XML serialized segmentation profile.

Availability: Business Analyst Server.

URL Example

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

Parameters

Parameter	Description
Item (required)	Folder item containing a segmentation profile. Type esriFolderItem.
compatibility (optional)	Business Analyst Server version the JSON output is compatible with. Type string.
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

Variable of type string containing XML serialized segmentation profile.

Example Usage

The example below retrieves an existing segmentation profile item from Business Analyst Server Repository. In order to demonstrate this endpoint, a market segmentation profile is created and saved to the repository. The OpenSegProfile endpoint is then used to retrieve the profile.

NOTE: The example uses the "Drive Time Polygons 1" polygon layer already created in the Trade Areas folder of the San Francisco Tutorial Project of the Default Workspace.

STEP 1: Create a profile

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/ProfileByAreaSummation/execute?
Boundaries={"Item":{
  "WorkspaceName":"Default Workspace",
  "ProjectName":"San Francisco Tutorial Project",
  "folderType":"esriFolderTradeAreas",
  "itemName":"Drive Time Polygons 1"
}}&
SegmentationBase=Total Households&AreaIDField=RING&
OutputItem={
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleBaseSegProfile_OpenSegProfile"
}&
f=PJSON

STEP 2: Execute the OpenSegProfile request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/OpenSegProfile/execute?
Item={
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleBaseSegProfile_OpenSegProfile"
}&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"ProfileData",
      "dataType":"GPString",
      "value":"<ProfileData ... Base=\"Total Households\"><Cluster ID=\"1\" Name=\"Top Rung\".../>...</ProfileData>"
    }
  ],
  "messages":
  [
  ]
}

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