Describe Named Map

Description

Returns the metadata of a specified named map for the Mapping Service. This operation returns a map JSON that can be passed to a render map or render legend request in the Mapping service.

ACL Authorization Flow

To list the metadata of a specified named map for the Mapping Service, the user (or the role they belong to) needs EXECUTE permission on the Named table.

HTTP GET URL Format

The following format is used for HTTP GET requests:

HTTP GET /maps/mapname.rep

Parameters

For information on the parameter types listed below, see Request URL Data Types.

Parameter Type Required Description
mapname String yes The name of the named map to return the metadata for. The map is specified by a regex for the named map based on the location of the named map in the repository. The name of the named map is defined between the /maps portion of the URL and the .rep portion of the URL. For example, to get the metadata for a named map located in the /Samples/NamedMaps directory in the repository, the following URL would be used: http://.../maps/Samples/NamedMaps/mapname.json;...
rep String yes The representation to be returned. Supported representation is JSON.

Returns

Returns metadata for a named map in the repository.

Example

Returns the metadata for the map WorldMap located in the /Samples/NamedMaps directory in the repository.

http://<server>:<port>/rest/Spatial/MappingService/maps/Samples/NamedMaps/WorldMap.json

The following example returns the JSON object in the response:

{
   "MapDescription":{
      "version":"1.0",
      "name":"/Samples/NamedMaps/WorldMap",
      "layers":[
         {
            "type":"NamedLayer",
            "description":"World Capitals",
            "renderable":true,
            "namedTableRef":"/Samples/NamedTables/WorldcapTable",
            "name":"/Samples/NamedLayers/WorldcapFeatureLayer"
         },
         {
            "type":"NamedLayer",
            "description":"Grid",
            "renderable":true,
            "namedTableRef":"/Samples/NamedTables/Grid15Table",
            "name":"/Samples/NamedLayers/Grid15FeatureLayer"
         },
         {
            "type":"NamedLayer",
            "description":"World Countries",
            "renderable":true,
            "namedTableRef":"/Samples/NamedTables/WorldTable",
            "name":"/Samples/NamedLayers/WorldFeatureLayer"
         },
         {
            "type":"NamedLayer",
            "description":"Ocean (Robinson)",
            "renderable":true,
            "namedTableRef":"/Samples/NamedTables/OceanTable",
            "name":"/Samples/NamedLayers/OceanFeatureLayer"
         }
      ]
   }
}