Colormap API

Version: 1.0

Create colormap

POST

/colormap/orgs/{org_id}/workspaces/{workspace_id}/colormaps

Create a new colormap for a specified workspace and organization. You may choose from either a continuous, discrete, or category colormap.

Request

Path parameters

org_iduuid

Required

workspace_iduuid

Required

Example body

{
  "attribute_controls": [
    0
  ],
  "colors": [
    [
      0
    ]
  ],
  "dtype": "continuous",
  "gradient_controls": [
    0
  ],
  "name": "string"
}

Responses

201

Successful Response

Response schema

Any of:

ContinuousColormapResponseobject

attribute_controlsnumber[]

List of ordered attribute values for gradient curve

colorsarray[]

An ordered list of RGB colors, containing between 2 and 1024 colors. Each color is represented by three integer values (for Red, Green, and Blue) ranging from 0 to 255.

created_atdate-time

created_byuuid

gradient_controlsnumber[]

List of gradient positions for gradient curve, floats between 0 and 1

iduuid

modified_atdate-time

modified_byuuid

namestring

schema"continuous" | "category" | "discrete"

self_linkuri

>= 1 char

CategoryColormapResponseobject

colorsarray[]

An ordered list of RGB colors, containing between 1 and 16384 colors. Each color is represented by three integer values (for Red, Green, and Blue) ranging from 0 to 255.

created_atdate-time

created_byuuid

iduuid

mapstring[]

String array mapping arbitrary strings to colors

modified_atdate-time

modified_byuuid

namestring

schema"continuous" | "category" | "discrete"

self_linkuri

>= 1 char

DiscreteColormapResponseobject

colorsarray[]

An ordered list of RGB colors, containing between 1 and 1024 colors. Each color is represented by three integer values (for Red, Green, and Blue) ranging from 0 to 255.

created_atdate-time

created_byuuid

end_inclusiveboolean[]

Boolean array indicating whether to include the endpoint in the bucket or not

end_pointsnumber[]

List of colormap bucket endpoints, must be one fewer than the number of colors

iduuid

modified_atdate-time

modified_byuuid

namestring

schema"continuous" | "category" | "discrete"

self_linkuri

>= 1 char

Example response

{
  "attribute_controls": [
    0
  ],
  "colors": [
    [
      0
    ]
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "gradient_controls": [
    0
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "modified_at": "2024-07-29T15:51:28.071Z",
  "modified_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "schema": "continuous",
  "self_link": "string"
}

422

Validation Error

Response schema

detailobject[]

loc(string | integer)[]

Any of:

string

integer

msgstring

typestring

Example response

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}