Sign in

v1

latestOpenAPI 3.0.12026-07-265879107.5 KB
Tables

Updates Field for Table

Update a specific field in a given table.

put/workspace/{ws_id}/table/{table}/fields/{field}

Path parameters

ws_idstring required

Workspace ID

field_namestring required

Field name

table_namestring required

Table name

Request body

display_namestring
type'text' | 'long-text' | 'number' | 'risk-level' | 'checkbox' | 'single-select' | 'multi-select' | 'list' | 'reference' | 'date'

Example request

{
  "attributes": {
    "default_value": "Default",
    "options": [
      "Option 1",
      "Option 2",
      "Option 3"
    ],
    "table_reference": {
      "display_name_field": "Name",
      "table_name": "Table 1"
    }
  },
  "display_name": "Test",
  "type": "single-select"
}

Response

OK

attributesModelsTableFieldAttributes
created_atinteger
created_bystring
descriptionstring
display_namestring
idstring
indexesobject
namestring
table_idstring
tenant_idstring
typestring
updated_atinteger
updated_bystring
workspace_idstring