Report from Profile Endpoint

Creates Tapestry Segmentation Report from a segmentation profile.

Availability: Business Analyst Server.

URL Example

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

Specific Parameters

Parameter	Description
Profile (required)	Segmentation profile. Type ProfileData.

Other Parameters

Parameter	Description
OutputType (required)	Array of task output options. Options for this method include creating a report (GetReport). Type array of TaskOutputType.
StandardReportOptions (required)	Report parameters. Type ReportOptions. The TemplateName parameter is ignored.
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, XML. Default: HTML.
IsFullErrorMessage (optional)	Mode for composing error messages. Type boolean. Default: false.
OutputReportItem (optional)	Configuration options for storing the output report in the repository. This will enable viewing and working with the output result in subsequent tasks. Type esriFolderItem.
token	Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type TaskResultOutput

Example Usage

The example below creates a market segmentation profile and then creates a report.

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":"sampleSegProfile_ReportFromProfile"
}&
f=PJSON

STEP 2: Execute the ReportFromProfile request

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

Profile={"Item":{
  "WorkspaceName":"Default Workspace",
  "ProjectName":"Default Project",
  "folderType":"esriFolderSegProfiles",
  "itemName":"sampleSegProfile_ReportFromProfile"
}}&
StandardReportOptions={
  "ReportFormat":"PDF",
  "ReportHeader":[{"key":"subtitle","value":"Custom Report Title"}]
}&
OutputType=GetReport&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"Tapestry Report.PDF",
      "dataType":"GPDataFile",
      "value":
      {
        "url":"http://localhost/arcgisoutput/_ags_TE5D603FE045B79DB8FFF163717E16.pdf"
      }
    }
  ],
  "messages":
  [
  ]
}