GET /v2/maps/{mapIds}?format={format}&expand={expand}&config={config}/

Get all maps. Optionally filter maps by a list of map ids.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
mapIds

Optional parameter. Comma separated list of map ids to return in the collection. Ex: 1,2,3

string

None.

format

Optional parameter. If its value is 'flat' the resources returned will not be hierarchical. Instead all properties of subresources will be included on the base resource. The default is to return resources in the standard hierarchical format.

string

Default value is hierarchical

expand

Optional parameter. If its value is 'true' and map ids have been provided as a filter, the map's asset view collection will include the asset view resources rather than just a link to them. The default is false.

boolean

Default value is False

config

Optional parameter. If set, this is the name of the map configuration to retrieve along with main map information. The default is null.

string

None.

Body Parameters

None.

Response Information

Resource Description

MapCollection
NameDescriptionTypeAdditional information
Href

string

None.

Items

Collection of Map

None.