Charts Maps List Resource

Returns a list of maps or creates a map.

Resource URL

1/eclair/maps

Formats

JSON

Available Version

38.0

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`page`	Int	The page number you want to view.	Optional	38.0
`pageSize`	Int	The number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25.	Optional	38.0

GET Response Body (MapCollectionRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`maps`	MapRepresentation[]	The list of the maps.	Small, 38.0	38.0

POST Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`geoMapObject`	Object (MapInputRepresentation)	All the relevant information about the map, such as `{"label": "My Map"}`.	Required	39.0

POST Request Body (MapInputRepresentation)

Property Name	Type	Description	Required or Optional	Available Version
`boundingBox`	MapBoundingBoxInputRepresentation	The map bounding box.	Optional	39.0
`geoData`	AssetReferenceInputRepresentation	The parent geodata asset.	Required	39.0
`label`	String	The map label.	Required	39.0
`name`	String	The map developer name.	Optional	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The map projection. Valid values are: `AlbersUSA` `Equirectangular` `Mercator`	Required	39.0

POST Response Body (MapRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`boundingBox`	BoundingBoxRepresentation	The bounding box of the geo map	Small, 38.0	39.0
`createdBy`	UserRepresentation	The creator of the map	Small, 38.0	38.0
`createdDate`	Date	The date when this map was created	Small, 38.0	38.0
`geoData`	GeoDataRepresentation	The geo data of the map	Small, 38.0	38.0
`id`	String	The 18 character map ID	Small, 38.0	38.0
`label`	String	The map label	Small, 39.0	39.0
`name`	String	The map developer name.	Small, 39.0	39.0
`namespace`	String	The namespace that qualifies the map	Small, 39.0	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The map projection. Valid values are: `AlbersUSA` `Equirectangular` `Mercator`	Small, 38.0	38.0
`url`	String	The url to the map representation	Small, 38.0	38.0

MapBoundingBoxInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`bottom`	Double	The bottom boundary of the geo map	Required	39.0
`left`	Double	The left boundary of the geo map	Required	39.0
`right`	Double	The right boundary of the geo map	Required	39.0
`top`	Double	The top boundary of the geo map	Required	39.0

BoundingBoxRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`bottom`	Double	The bottom boundary of the geo map	Small, 39.0	39.0
`left`	Double	The left boundary of the geo map	Small, 39.0	39.0
`right`	Double	The right boundary of the geo map	Small, 39.0	39.0
`top`	Double	The top boundary of the geo map	Small, 39.0	39.0

UserRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The 18 character user ID	Small, 38.0	38.0
`name`	String	The name of the user	Small, 38.0	38.0

The following JSON shows how to create a map resource from a GeoJson file with the optional bounding box.

1{
2  "boundingBox": {
3    "bottom": 40.5534,
4    "left": -80.251,
5    "right": -79.8211
6    "top": 40.3287
7  },
8  "geoData": {
9    "id": "<id_of_geodata_resource>"
10  },
11  "name":"developer_name_for_map",
12  "label": "display_label_for_map",
13  "projection" : "equirectangular"
14}

Analytics REST API Developer Guide

Charts Maps List Resource