Charts Maps List Resource

Get the collection of maps, or post a new 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.		38.0
`pageSize`	Int	How many items you want to view on each page, up to 500.		38.0

GET Response Body

MapCollectionRepresentation

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

POST Request Parameters

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

POST Request Body

MapInputRepresentation

Property Name	Type	Description	Available Version
`boundingBox`	MapBoundingBoxInputRepresentation	Sets the Map bounding box.	39.0
`geoData`	AssetReferenceInputRepresentation	Sets the parent GeoData.	39.0
`label`	String	Sets the Map label.	39.0
`name`	String	Sets the Map name	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	Sets the Map projection (AlbersUSA, Equirectangular, or Mercator)	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 user ID	Small, 38.0	38.0
`label`	String	The label of the map	Small, 39.0	39.0
`name`	String	The name of the map	Small, 39.0	39.0
`namespace`	String	The namespace of the map	Small, 39.0	39.0
`projection`	ConnectEclairMapProjectionTypeEnum	The projection used by the map (AlbersUSA, Equirectangular, or 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

Example curl request (without bounding boxes)

1curl -H "X-PrettyPrint: 1" \
2 -d '{"geoData": {"id": "<id_of_geodata_resource>"},"name": "<developer_name_for_map>","label": "<display_label_for_map>","projection": "equirectangular"}' \
3 -F "geoDataFile=@YourGeonJsonFile.json" \
4 -X POST \
5 https://yourinstanceurl/services/data/v39.0/eclair/geodata \
6 -H 'Authorization: OAuth Oauth Token'

Example Response Body

1{
2   "boundingBox": {},
3   "createdBy": {
4      "id": "005G0000004KRG3IAO",
5      "name": "Anand B Narasimhan"
6   },
7   "createdDate": "2017-03-06T13:18:53.000Z",
8   "geoData": {
9      "id": "05oP0000000000BIAQ",
10      "label": "PA_Territories",
11      "name": "PA_Territories",
12      "type": "geojson",
13      "url": "/services/data/v39.0/eclair/geodata/05oP0000000000BIAQ/file"
14   },
15   "id": "05pP0000000000aIAA",
16   "label": "map_lable",
17   "name": "map_name",
18   "projection": "equirectangular",
19   "url": "/services/data/v39.0/eclair/maps/05pP0000000000aIAA"
20}

Example curl request (with bounding boxes)

1curl -H "X-PrettyPrint: 1" \
2 -d '{"boundingBox": {"bottom": 40.5534,"left": -80.251,"right": -79.8211,"top": 40.3287},\
3 "geoData": {"id": "id_of_geodata_resource"},"name": "<developer_name_for_map>",\
4 "label": "<display_label_for_map>","projection": "equirectangular"}' \
5 -F "geoDataFile=@YourGeonJsonFile.json" \
6 -X POST \
7 https://yourinstanceurl/services/data/v39.0/eclair/geodata \
8 -H 'Authorization: OAuth Oauth Token'

Example Response Body

1{
2   "boundingBox": {
3      "bottom": 40.5534,
4      "left": -80.251,
5      "right": -79.8211,
6      "top": 40.3287
7   },
8   "createdBy": {
9      "id": "005G0000004KRG3IAO",
10      "name": "Anand B Narasimhan"
11   },
12   "createdDate": "2017-03-06T13:18:53.000Z",
13   "geoData": {
14      "id": "05oP0000000000BIAQ",
15      "label": "PA_Territories",
16      "name": "PA_Territories",
17      "type": "geojson",
18      "url": "/services/data/v39.0/eclair/geodata/05oP0000000000BIAQ/file"
19   },
20   "id": "05pP0000000000aIAA",
21   "label": "map_label",
22   "name": "map_name",
23   "projection": "equirectangular",
24   "url": "/services/data/v39.0/eclair/maps/05pP0000000000aIAA"
25}

Analytics REST API Developer Guide

Charts Maps List Resource