> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /insert/symbol

```
URL: http://<db.host>:<db.port>/insert/symbol
```

Adds a symbol or icon (i.e. an image) to represent data points when data is
rendered visually. Users must provide the symbol identifier (string), a format
(currently supported: 'svg' and 'svg\_path'), the data for the symbol, and any
additional optional parameter (e.g. color). To have a symbol used for rendering
create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y'
for example). Then when the table is rendered (via
[WMS](../../api/rest/wms_rest/)) if the 'dosymbology' parameter is 'true'
then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed
for each point.

## Input Parameter Description

<ParamField body="symbol_id" type="string">
  The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol.
</ParamField>

<ParamField body="symbol_format" type="string">
  Specifies the symbol format. Must be either 'svg' or 'svg\_path'.

  The supported values are:

  * svg
  * svg\_path
</ParamField>

<ParamField body="symbol_data" type="bytes">
  The actual symbol data. If input parameter *symbol\_format* is 'svg' then this should be the raw bytes representing an svg file. If input parameter *symbol\_format* is svg path then this should be an svg path string; for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="color">
      If input parameter *symbol\_format* is 'svg' this is ignored. If input parameter *symbol\_format* is 'svg\_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'insert\_symbol\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /insert/symbol endpoint:

  <Expandable title="data_str">
    <ResponseField name="symbol_id" type="string">
      Value of input parameter *symbol\_id*.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>