Colormap API

Version: 1.0

Preview

Create colormap

POST

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

Preview API

This endpoint is marked as a preview API. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this endpoint.

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

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

CategoryColormapResponseobject

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

iduuid

mapstring[]

String array mapping arbitrary strings to colors

modified_atdate-time

modified_byuuid

namestring

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

self_linkuri

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

422

Validation Error

Response schema

detailobject[]

loc(string | integer)[]

msgstring

typestring