Render Analyses Endpoint

Renders repository layer items and returns a map image.

Availability: Business Analyst Server.

URL Example

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

Parameters

Parameter	Description
AnalysesDescription (required)	Layer items in the repository that will be rendered as an image. Type array of esriLayerItem.
ImageDescription (optional)	Image configuration options for rendering output. Type ImageDescription. The type of this parameter is changed since Business Analyst Server.
MapDescription (optional)	Map configuration options for rendering output. 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 MapImage. This return type is supported for XML output format only. For JSON or PJSON output formats, the response object is compatible with the ArcGIS Execute GP Task response syntax.

Remarks

The MapDescription parameter contains string-serialized XML description of a map. If it is absent, the analyses are rendered on the default map.

If the ImageDescription parameter is absent, the default values for rendered image will be used.

Example Usage

The example below generates a downloadable image file from an existing feature layer stored in Business Analyst Server Repository.

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.

Request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/RenderAnalyses/execute?
AnalysesDescription=[
  {
    "LayerItem":{
      "WorkspaceName":"Default Workspace",
      "ProjectName":"San Francisco Tutorial Project",
      "folderType":"esriFolderTradeAreas",
      "itemName":"Drive Time Polygons 1"
    },
    "LayerTransparency":50
  }
]&
ImageDescription={
  "ImageDisplay":{"ImageDPI":1000,"ImageHeight":100,"ImageWidth":100},
  "ImageType":{"ImageFormat":"esriImageJPG","ImageReturnType":"esriImageReturnURL"}
}&
f=PJSON

Response

{
  "results":
  [
    {
      "paramName":"OutputMapImage",
      "dataType":"GPRasterData",
      "value":
      {
        "url":"http://localhost/arcgisoutput/_ags_mapea4b407deae84baf94ad9d2b1ef40766.jpg",
        "format":"jpg"
      }
    }
  ],
  "messages":
  [
  ]
}