--- title: "Describe named maps" method: POST path: "/v1/spatial/maps" tags: ["Mapping Service: List & Get Maps"] --- # Describe named maps `POST /v1/spatial/maps` ## Request - Base URL: `https://api.cloud.precisely.com` - URL: `https://api.cloud.precisely.com/v1/spatial/maps` - Auth: API key in header `Authorization` and HTTP bearer Returns descriptions for the specified named maps. Each entry in the response contains the map name and either the map description or an error message if the map could not be found. **Resource dependencies:** A named map references one or more named layers in its `layers` list (each entry includes `name` and `namedTableRef`). Each referenced named layer — and the named table it points to — must already exist in the repository before the map can be resolved. **Authorization:** Requires EXECUTE permission on each requested map. For any map where the caller lacks EXECUTE permission (or which does not exist), the corresponding entry contains an `errorMessage` instead of a map description; the overall response is still `200 OK`. ## Request body - NamedMapsList: Request payload containing a list of named map paths to describe - `names` string[]: List of fully-qualified named map paths ## Response `200` Successfully retrieved map descriptions - DescribeMapsResponse: Response payload containing descriptions for multiple named maps - `maps` MapEntry[]: List of map description entries, one per requested map name - `name` string: The fully-qualified name of the map - `map` MapDescription: Description of a named map, including its name, version and layers - `name` string: The fully-qualified name of the map - `version` string: Version of the map description - `layers` union[]: List of layers contained in the map - union - BarLayer: A layer rendering a bar chart per feature of a table. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `graduation` Graduation: Graduation settings controlling how symbol sizes scale with value. - … - `border` union - … - `categories` Category[], required: Categories charted by each bar chart. - … - `chartWidth` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - … - `chartHeight` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - … - `opacity` number, double: Opacity of the chart, from 0.0 to 1.0. - `spatialExpression` string: Expression producing the location the chart is drawn at. - `barBaseSize` BaseSize: Reference map scale at which chart or symbol sizes are defined. - … - `chartType` 'MULTIPLE' | 'STACKED': Rendering style of a bar chart layer. - `chartEffectType` 'FLAT' | 'AS3D': Visual effect applied to a chart layer. - `horizontalAlignment` 'LEFT' | 'CENTER' | 'RIGHT': Horizontal alignment of a chart, symbol, or label relative to its anchor point. - `verticalAlignment` 'TOP' | 'MIDDLE' | 'BOTTOM' | 'BASELINE': Vertical alignment of a chart, symbol, or label relative to its anchor point. - `independentScale` boolean: Whether each bar is scaled independently. - `graduated` boolean: Whether the bars are graduated by value. - `xoffset` number, double - `yoffset` number, double - FeatureLayer: A layer rendering the features of a table, optionally themed and labelled. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `themes` union[]: Themes applied to the features of this layer. - … - `labelProperties` LabelProperties: Full set of properties controlling how labels are generated and drawn for a layer or label theme. - … - `showLineDirection` boolean: Whether line direction arrows are drawn. - `namedLabelSourceRef` string: Reference to a named label source used to label this layer. - GraduatedSymbolLayer: A layer drawing a symbol per feature, sized proportionally to a computed value. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `positiveSymbol` union - … - `negativeSymbol` union - … - `symbolBaseSize` BaseSize: Reference map scale at which chart or symbol sizes are defined. - … - `graduationMethod` 'SQUARE_ROOT' | 'LOGARITHM' | 'CONSTANT': Method used to graduate symbol sizes by value. - `valueExpression` string: Expression producing the value the symbols are sized by. - `spatialExpression` string: Expression producing the location the symbols are drawn at. - `valueAtSize` number, double: Data value corresponding to the configured symbol size. - `ignoredValue` number, double: Value for which no symbol is drawn. - `showPositiveSymbol` boolean: Whether symbols are drawn for positive values. - `showNegativeSymbol` boolean: Whether symbols are drawn for negative values. - GridLayer: A layer rendering a continuous grid surface interpolated from the points of a table. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `style` union, required - … - `cellWidth` Distance, required: A ground distance: a magnitude plus its unit of measure. - … - `valueExpression` string, required: Expression producing the value interpolated into the grid. - `spatialExpression` string, required: Expression producing the location of the interpolated points. - `interpolator` IDWInterpolator, required: An inverse distance weighted (IDW) interpolator. - … - `inflectionCollection` union - … - `gridEnvelope` Envelope: A rectangular bounding envelope: a coordinate reference system and its extent coordinates. - … - GroupLayer: A layer that groups a list of child layers so they can be controlled together. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `layer` Layer[], required: Child layers of this group, in drawing order. - … - LabelLayer: A layer that draws labels obtained from one or more label sources. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `labelSource` union[], required: Label sources this layer draws labels from. - … - LineChartLayer: A layer rendering a line chart per feature of a table. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `line` union - … - `categories` Category[]: Categories charted by each line chart. - … - `chartWidth` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - … - `chartHeight` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - … - `opacity` number, double: Opacity of the chart, from 0.0 to 1.0. - `spatialExpression` string: Expression producing the location the chart is drawn at. - `chartBaseSize` BaseSize: Reference map scale at which chart or symbol sizes are defined. - … - `domainAxis` ChartAxis: Rendering options for one axis of a chart layer. - … - `rangeAxis` ChartAxis: Rendering options for one axis of a chart layer. - … - `chart` ChartPlot: Rendering options for the plot area of a chart layer. - … - `horizontalAlignment` 'LEFT' | 'CENTER' | 'RIGHT': Horizontal alignment of a chart, symbol, or label relative to its anchor point. - `verticalAlignment` 'TOP' | 'MIDDLE' | 'BOTTOM' | 'BASELINE': Vertical alignment of a chart, symbol, or label relative to its anchor point. - LineLinkageLayer: A layer drawing linkage lines between source and destination features of two tables. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `geometryTable` union, required - … - `linkageTable` union, required - … - `sourceExpression` string, required: Expression producing the source key of a linkage. - `destinationExpression` string, required: Expression producing the destination key of a linkage. - `metricExpression` string, required: Expression producing the metric value of a linkage. - `relationshipExpression` string, required: Expression producing the relationship of a linkage. - `themes` union[]: Themes applied to the linkage lines. - … - `sourcePointStyle` union - … - `destinationPointStyle` union - … - `directionArrowEnabled` boolean: Whether direction arrows are drawn on the linkage lines. - NamedLayer: A layer that references a pre-configured named layer resource. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `namedTableRef` string: Optional reference to a named table overriding the one of the named layer. - `name` string, required: Name (resource path) of the named layer. - PieLayer: A layer rendering a pie chart per feature of a table. - `type` 'NamedLayer' | 'FeatureLayer' | 'GroupLayer' | 'LabelLayer' | 'BarLayer' | 'PieLayer' | 'LineChartLayer' | 'LineLinkageLayer' | 'GraduatedSymbolLayer' | 'GridLayer', required: Type discriminator of this Layer (NamedLayer, FeatureLayer, GroupLayer, LabelLayer, BarLayer, PieLayer, LineChartLayer, LineLinkageLayer, GraduatedSymbolLayer, GridLayer). - `description` string: Human readable description of the layer. - `renderable` boolean: Whether the layer is rendered. - `visibilityConstraints` union[]: Constraints controlling at which scales/zooms the layer is visible. - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - … - `table` union, required - … - `categories` Category[], required: Categories charted by each pie chart. - … - `border` union - … - `diameter` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - … - `opacity` number, double: Opacity of the chart, from 0.0 to 1.0. - `graduation` Graduation: Graduation settings controlling how symbol sizes scale with value. - … - `spatialExpression` string: Expression producing the location the chart is drawn at. - `pieBaseSize` BaseSize: Reference map scale at which chart or symbol sizes are defined. - … - `wedgeRenderDirection` 'CLOCKWISE' | 'COUNTER_CLOCKWISE': Direction in which pie chart wedges are rendered. - `startAngle` number, double: Angle, in degrees, at which the first wedge starts. - `chartType` 'FULL' | 'HALF': Rendering style of a pie chart layer. - `chartEffectType` 'FLAT' | 'AS3D': Visual effect applied to a chart layer. - `horizontalAlignment` 'LEFT' | 'CENTER' | 'RIGHT': Horizontal alignment of a chart, symbol, or label relative to its anchor point. - `verticalAlignment` 'TOP' | 'MIDDLE' | 'BOTTOM' | 'BASELINE': Vertical alignment of a chart, symbol, or label relative to its anchor point. - `depthFactor` number, double: Depth factor applied when the chart is drawn with a 3D effect. - `graduated` boolean: Whether the pies are graduated by value. - `errorMessage` string: Error message, present when the map could not be retrieved --- [API](https://skmtc.dev/precisely/apis/mapping-api.md) · [All operations](https://skmtc.dev/precisely/apis/mapping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/mapping-api/revisions/cea0ad9440c5?raw)