FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.0   R E S T   A P I   I N T E R F A C E

Using ArcGIS Data Types in Esri Business Analyst REST API

Because the Business Analyst REST API's feature class geometry formats conform to the geometry schema defined by ArcGIS Server, ArcGIS Server Web APIs and REST geoprocessing tasks and services may be leveraged alongside the Business Analyst Server and Business Analyst Online REST APIs. Polygons and points drawn in mapping API User Interfaces may be used as parameter values to certain Business Analyst REST API requests. The ArcGIS API for JavaScript, Flex, and Microsoft Silverlight/WPF have excellent documented examples of drawing toolbar components. These drawing toolbars create Geometry objects which are compatible with the Business Analyst REST API.

 

Described below are ArcGIS REST API datatypes leveraged alongside the Business Analyst Server and Business Analyst Online REST APIs.

 

Datatype

Description

Geometry

This is an abstract parent type of various geometry sub-types. Geometries are used to provide a spatial description of features and are fundamentally composed of coordinates. In the Business Analyst REST API, the most commonly employed geometry sub-types include Envelope, Point, Polygon, and Polyline.

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation

Envelope

An envelope contains the corner points of an extent along with a spatial reference. This is a sub-type of the Geometry type. In the Business Analyst REST API, it is used in properties of the ExtentData type.

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation

ImageDescription

This type contains properties of an image to be generated. In the Business Analyst Server REST API, it is used in properties of the RenderingParameters type.

 

NOTE: The JSON representation of this type is not published in the ArcGIS Server REST API. For more information on properties of this datatype, please refer to this link

MapDescription

This type contains settings of a map in the current document. In the Business Analyst Server REST API, an object of this type is returned by the GetDefaultMapDescription endpoint.

 

NOTE: The JSON representation of this type is not published in the ArcGIS Server REST API. For more information on properties of this datatype, please refer to this link

MapImage

This type contains information about the generated map image. In the Business Analyst REST API, it is returned by Business Analyst tasks in the properties of the TaskResultOutput type and as a result execution the RenderAnalyses endpoint.

 

NOTE: The JSON representation of this type is not published in the ArcGIS Server REST API. For more information on properties of this datatype, please refer to this link

Point

A point contains point coordinates along with a spatial reference. This is a sub-type of the Geometry type. In the Business Analyst REST API, it is used in parameters of the Return Standard Geography endpoint and in a RecordSet having a point geometry (see PointLayer type example).

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation

Polygon

A polygon contains and array of rings along with a spatial reference. This is a sub-type of the Geometry type. In the Business Analyst REST API, it is used in a RecordSet having a polygon geometry (see DataLayer type example).

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation

Polyline

A polyline contains an array of paths along with a spatial reference. This is a sub-type of the Geometry type. In the Business Analyst REST API, this geometry type is useless now.

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation

RecordSet

This type is a lightweight and serialized representation of a data table or feature class. A data table is a collection of records with the same set of named attributes. A feature class is a collection of geographic features with the same geometry type, the same set of named attributes, and the same SpatialReference. Points, Polygons, and Polylines are frequently represented as Record Sets in the Business Analyst REST API.

 

NOTE: The JSON representation of this type is not published in the ArcGIS Server REST API. For more information on properties of this datatype, please refer to this link

SpatialReference

The ArcGIS Server REST API only supports spatial references that have well-known IDs associated with them. Given this constraint, a spatial reference object only contains one fieldwkid.

 

NOTE: For more information on this datatype, please refer to the ArcGIS Server REST API Geometry documentation. For more information on using this datatype, please refer to this link