Newer Version Available

This content describes an older version of this product. View Latest

Charts Geodata List Resource

Returns a collection of geodata definitions and creates a geodata definition.
Resource URL
1/eclair/geodata
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
GeoDataCollectionRepresentation
Property Name Type Description Filter Group and Version Available Version
geoData Geo​Data​Representation[] A list of the geodata. Small, 38.0 38.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
geo​Data​File Binary The geodata JSON file to upload. Required 39.0
geo​Data​Object Object (Geo​Data​Input​Representation) All the relevant information about the geodata, such as {"label": "My GeoData"}. Required 39.0
POST Request Body (GeoDataInputRepresentation)
GeoDataInputRepresentation
Property Name Type Description Required or Optional Available Version
label String The geodata label. Optional 39.0
name String The geodata developer name. Optional 39.0
POST Response Body (GeoDataRepresentation)
Property Name Type Description Filter Group and Version Available Version
id String The ID of the geodata record. Small, 38.0 38.0
label String The geodata label. Small, 38.0 38.0
name String The geodata developer name. Small, 38.0 38.0
namespace String The namespace that qualifies the geodata. Small, 39.0 39.0
type Connect​Eclair​Geo​Data​Type​Enum The type of geodata. Valid values are:
  • GeoJSON
Small, 38.0 38.0
url String The url to retrieve the geodata. Small, 38.0 38.0

The following JSON shows how to create a geodata resource from a GeoJson file.

1{
2  "label": "GeoJsonLabel",
3  "name": "GeoJsonName"
4  }