Workbench

Add Workbench Column

Add a column.

name is the machine name rows are keyed by and is constrained to ^[a-z][a-z0-9_]*$; display_name is free text. Getting those the wrong way round produces a column nothing can address.

post/workbench/tables/{table_id}/columns

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/columns
  • Auth: HTTP bearer

Path parameters

table_idstring required

Table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required

Machine name: lowercase, starting with a letter. This is the key row data is addressed by, which is why it is constrained while display_name is not.

display_namestring required
data_type'text' | 'number' | 'boolean' | 'json'
column_type'data' | 'formula' | 'raw_json'
field_pathstring nullable

Path into a raw_json source column.

sourcestring
source_column_idinteger nullable
formulastring nullable

Required for a formula column.

Response

Successful Response

dataobject required

Changes

No recorded changes to this operation across all 3 revisions of this API.