GET /maps/{mapId}?format={format}&expand={expand}&config={config}
Get a map by its id. Optionally expand asset view resources in the response. Optionally flatten out resources in the response.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| mapId |
id of the map |
integer |
Required |
| 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' 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
Map| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Name of the map. |
string |
None. |
| Description |
Description of the map. |
string |
None. |
| MapType |
Type of the map. |
MapType |
None. |
| MapConfig |
Gets or sets the map configuration. |
MapConfig |
None. |
| Directory |
Directory the map is associated with. |
Directory |
None. |
| FileResources |
File resources associated with the map. One or more of the file resources will be a graphical file format depicting the map. |
Collection of FileResource |
None. |
| AssetViews |
Instances of the assets associated with the directory as they are placed on the map. |
AssetViewCollection |
None. |
| AssetTypes |
Collection of asset types of all the asset views in this directory. |
AssetTypeCollection |
None. |
| Href |
URL of the resource. |
string |
None. |
| Id |
Identifier of the resource. |
integer |
None. |
| CreatedDate |
Creation date/time. ISO 8601 formatted date/time string using UTC time zone. |
date |
None. |
| ModifiedDate |
Modification date/time. ISO 8601 formatted date/time string using UTC time zone. |
date |
None. |