Sign in

v1

latestSwagger 2.0Apache 2.02026-07-1725956.5 KB
Data Dictionary

Create or update field (upsert)

Create a new field or update an existing field. If field exists, it will be updated. If not, it will be created.

post/tables/fields/{dbId}/{tableId}

Path parameters

dbIdstring required

Database ID

tableIdstring required

Table ID

Request body

namestring required

Field name (required)

labelstring

Field label/display name

descriptionstring

Field description

data_type'string' | 'integer' | 'float' | 'double' | 'date' | 'boolean' | 'datetime' | 'array' | 'object' | 'null'

Data type (string, integer, float, double, date, boolean, datetime, array, object, null)

column_type'dimension' | 'time_period' | 'measure' | 'attribute' | 'indicator_id' | 'indicator_name' | 'geography' | 'observation_value' | 'periodicity'

Semantic column type

field_orderinteger

Display order of the field

unit_of_measurementstring

Unit of measurement

formatstring

Format specification

time_period_formatstring

Time period format (e.g., YYYY, YYYY-MM)

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

Response

successful operation

statusstring
action'created' | 'updated'

Whether field was created or updated

Example response

{
  "status": "success"
}