--- title: "Describe a named map" method: GET path: "/v1/spatial/maps/{mapName}" tags: ["Mapping Service: List & Get Maps"] --- # Describe a named map `GET /v1/spatial/maps/{mapName}` ## Request - Base URL: `https://api.cloud.precisely.com` - URL: `https://api.cloud.precisely.com/v1/spatial/maps/{mapName}` - Auth: API key in header `Authorization` and HTTP bearer Returns the description of a named map in JSON format. The map name should be provided as part of the URL path after `/maps/`. Hierarchical names with slashes are supported (e.g., `Samples/NamedMaps/WorldMap`). **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 the requested map. If the caller lacks permission, the API returns `403 Forbidden`; if the map does not exist, it returns `404 Not Found`. Both share the same error code (`DIS-MS-1016`), but the distinct HTTP status and message text make the two cases distinguishable to the caller. ## Path parameters - `mapName` string, required ## Response `200` Map description retrieved successfully - DescribeMapResponse: Response payload containing the description of a named map - `mapDescription` 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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `graduation` Graduation: Graduation settings controlling how symbol sizes scale with value. - `valueAtSize` number, double: Data value that corresponds to the configured symbol size. - `graduationMethod` 'SQUARE_ROOT' | 'LOGARITHM' | 'CONSTANT': Method used to graduate symbol sizes by value. - `border` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `categories` Category[], required: Categories charted by each bar chart. - `style` union - … - `expression` string: Expression producing this category's value. - `description` string: Human readable description of this category. - `applyStyle` boolean: Whether the configured style should be applied to this category. - `chartWidth` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - `value` number, double: Length magnitude. - `uom` 'Centimeter' | 'Inch' | 'Millimeter' | 'Pica' | 'Point' | 'Pixel' | 'Twip' | 'Meter': Unit of measure for a paper (page space) length. - `chartHeight` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - `value` number, double: Length magnitude. - `uom` 'Centimeter' | 'Inch' | 'Millimeter' | 'Pica' | 'Point' | 'Pixel' | 'Twip' | 'Meter': Unit of measure for a paper (page space) length. - `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. - `mapScale` number, double: Map scale at which the configured sizes apply. - `useScale` boolean: Whether sizes should be scaled relative to the base map scale. - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `themes` union[]: Themes applied to the features of this layer. - union - … - `labelProperties` LabelProperties: Full set of properties controlling how labels are generated and drawn for a layer or label theme. - `style` union - … - `angle` Angle: An angle: a magnitude plus its unit of measure. - … - `expression` string: Expression producing the label text. - `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. - `allowOverlap` boolean: Whether the label may overlap other labels. - `allowOutOfView` boolean: Whether the label may be drawn partially outside the view. - `allowDuplicate` 'INTERLAYER' | 'INTRALAYER' | 'ALL': Scope in which duplicate labels are allowed to be drawn. - `recalculationType` 'ALWAYS' | 'OUT_OF_VIEW' | 'NEVER': When label positions are recalculated. - `labelRelativeOrientation` 'PARALLEL' | 'FOLLOW_PATH': Orientation of a label relative to the geometry it labels. - `justification` 'LEFT' | 'CENTER' | 'RIGHT': Justification of multi-line label text. - `referenceGeometry` union - … - `xOffset` number, double: Horizontal offset of the label from its anchor point. - `yOffset` number, double: Vertical offset of the label from its anchor point. - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `positiveSymbol` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `negativeSymbol` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `symbolBaseSize` BaseSize: Reference map scale at which chart or symbol sizes are defined. - `mapScale` number, double: Map scale at which the configured sizes apply. - `useScale` boolean: Whether sizes should be scaled relative to the base map scale. - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `style` union, required - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `cellWidth` Distance, required: A ground distance: a magnitude plus its unit of measure. - `value` number, double: Distance magnitude. - `uom` 'Centimeter' | 'cm' | 'Chain' | 'Foot' | 'ft' | 'Inch' | 'in' | 'Kilometer' | 'km' | 'Link' | 'Meter' | 'm' | 'Mile' | 'mi' | 'Millimeter' | 'mm' | 'NauticalMile' | 'Pica' | 'Point' | 'Rod' | 'SurveyFoot' | 'Twip' | 'Yard' | 'yd', required: Unit of measure for a ground distance. - `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. - `type` 'IDWInterpolator', required: Type discriminator of this Interpolator (IDWInterpolator). - `clipGeometry` union - … - `searchRadius` integer: Number of cells searched around each cell for contributing points. - `maxPoints` integer: Maximum number of points contributing to a single cell. - `exponent` integer: Exponent applied to the inverse distance weighting. - `aggregationMethod` 'AVERAGE' | 'COUNT' | 'MAXIMUM' | 'MINIMUM' | 'SUM', required: Aggregation method used when several source values fall into the same computed cell. - `inflectionCollection` union - ComputedInflectionCollection: An inflection collection whose band colors are computed by interpolating between a start and end color. - … - CustomInflectionCollection: An inflection collection with explicitly listed band colors. - … - `gridEnvelope` Envelope: A rectangular bounding envelope: a coordinate reference system and its extent coordinates. - `crs` Crs: GeoJSON Coordinate Reference System (CRS) object. - … - `bbox` Coordinate[]: Coordinates describing the envelope's extent, e.g. min/max corners. - … - 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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `layer` Layer[], required: Child layers of this group, in drawing order. - `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. - … - 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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `labelSource` union[], required: Label sources this layer draws labels from. - union - … - 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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `line` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `categories` Category[]: Categories charted by each line chart. - `style` union - … - `expression` string: Expression producing this category's value. - `description` string: Human readable description of this category. - `applyStyle` boolean: Whether the configured style should be applied to this category. - `chartWidth` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - `value` number, double: Length magnitude. - `uom` 'Centimeter' | 'Inch' | 'Millimeter' | 'Pica' | 'Point' | 'Pixel' | 'Twip' | 'Meter': Unit of measure for a paper (page space) length. - `chartHeight` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - `value` number, double: Length magnitude. - `uom` 'Centimeter' | 'Inch' | 'Millimeter' | 'Pica' | 'Point' | 'Pixel' | 'Twip' | 'Meter': Unit of measure for a paper (page space) length. - `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. - `mapScale` number, double: Map scale at which the configured sizes apply. - `useScale` boolean: Whether sizes should be scaled relative to the base map scale. - `domainAxis` ChartAxis: Rendering options for one axis of a chart layer. - `style` union - … - `visible` boolean: Whether the axis is drawn. - `label` boolean: Whether the axis labels are drawn. - `rangeAxis` ChartAxis: Rendering options for one axis of a chart layer. - `style` union - … - `visible` boolean: Whether the axis is drawn. - `label` boolean: Whether the axis labels are drawn. - `chart` ChartPlot: Rendering options for the plot area of a chart layer. - `style` union - … - `domainGrid` Grid: Rendering options for the grid lines of one chart axis. - … - `rangeGrid` Grid: Rendering options for the grid lines of one chart axis. - … - `visibleOutline` boolean: Whether the plot area outline is drawn. - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `geometryTable` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `linkageTable` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `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. - union - … - `sourcePointStyle` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `destinationPointStyle` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `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. - union - … - `parameters` BoundParameter[]: Named parameters bound into this layer's expressions, e.g. bind variables. - `name` string, required: Name of the bound parameter. - `description` string: Human readable description of this parameter. - `value` union, required - … - `table` union, required - MemoryTable: Table backed by an in-memory feature collection. - … - NamedTable: Polymorphic table definition (NamedTable, ViewTable, or MemoryTable). - … - ViewTable: Table backed by a SQL view definition. - … - `categories` Category[], required: Categories charted by each pie chart. - `style` union - … - `expression` string: Expression producing this category's value. - `description` string: Human readable description of this category. - `applyStyle` boolean: Whether the configured style should be applied to this category. - `border` union - GridStyle: A style that classifies grid/raster values into color bands via inflection breaks. - … - MapBasicAreaStyle: MapBasic area style: border pen and fill brush. - … - MapBasicCompositeStyle: MapBasic composite style combining point, line, and area styles. - … - MapBasicFontStyle: MapBasic font style: name, style flags, size, and foreground/background colors. - … - MapBasicLineStyle: MapBasic line style: the pen used to draw the line. - … - MapBasicPointStyle: MapBasic point style: the symbol used to render the point. - … - MapBasicTextStyle: MapBasic text style: the font style used to render the text. - … - NamedStyle: A style that references a pre-configured named style. - … - `diameter` PaperLength: A page-space (paper) length: a magnitude plus its unit of measure. - `value` number, double: Length magnitude. - `uom` 'Centimeter' | 'Inch' | 'Millimeter' | 'Pica' | 'Point' | 'Pixel' | 'Twip' | 'Meter': Unit of measure for a paper (page space) length. - `opacity` number, double: Opacity of the chart, from 0.0 to 1.0. - `graduation` Graduation: Graduation settings controlling how symbol sizes scale with value. - `valueAtSize` number, double: Data value that corresponds to the configured symbol size. - `graduationMethod` 'SQUARE_ROOT' | 'LOGARITHM' | 'CONSTANT': Method used to graduate symbol sizes by 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. - `mapScale` number, double: Map scale at which the configured sizes apply. - `useScale` boolean: Whether sizes should be scaled relative to the base map scale. - `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. ## Other responses - `403`: Caller does not have EXECUTE permission on the requested map - `404`: Map not found --- [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)