Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Generic Symbol

GET/api/v2/mapRendering/symbols/{symbolId}/generic
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:map-read.

Path parameters

symbolId
string

Unique identifier for a symbol that can be used to fetch the symbol as a PNG using loadGenericSymbol endpoint. The ID is opaque and not meant to be parsed in any way.

Query parameters

size
integer
preview
boolean
optional

Enables the use of preview functionality.

Response body

body
string

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/mapRendering/symbols/temp/generic?size=1&preview=true"

Error responses

Error Name
GenericSymbolPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not generic the Symbol.
ParameterssymbolId