Skip to main content

Column API

You will be able to manage columns in your tables with this API

API


Add a column

Description:
  • Allows you to add a new column into a table.

POST

/v1/crm/core/table/{tableId}/column

Request URL
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '{"name":"New Column","type":"text","options":[],"required":false,"width":220,"hidden":false,"uiVisible":true}'
Parameters
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
ColumnbodyColumn to addYesColumnRequest
Sample Request
Click to expand/collapse
{
"name": "New Column",
"type": "text",
"options": [],
"required": false,
"width": 220,
"hidden": false,
"uiVisible": true
}
Sample Response
Click to expand/collapse
{
"success": true,
"id": "BXP0"
}
Responses
CodeDescriptionSchema
201OKColumnCUDResponse
401Unauthorized
Security
Security SchemaScopes
ApiKeyAuth

Update Column by ID

Description:
  • Allows you to update a column by its unique id.

PUT

/v1/crm/core/table/{tableId}/column/{columnId}

Request URL
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column/BXP0
Curl
curl -X PUT "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column/BXP0" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '{"name":"New Column Updated","type":"text","options":[],"required":false,"width":200,"hidden":false,"uiVisible":true}'
Parameters
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
columnIdpathid of columnYesstring
ColumnbodyColumn to updateYesColumnRequest
Sample Request
Click to expand/collapse
{
"name": "New Column Updated",
"type": "text",
"options": [],
"required": false,
"width": 200,
"hidden": false,
"uiVisible": true
}
Sample Response
Click to expand/collapse
{
"success": true,
"id": "BXP0"
}
Responses
CodeDescriptionSchema
200OKColumnCUDResponse
401Unauthorized
404Not Found
Security
Security SchemaScopes
ApiKeyAuth

Delete Column by ID

Description:
  • Allows you to delete a column by its unique id.

DELETE

/v1/crm/core/table/{tableId}/column/{columnId}

Request URL
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column/BXP0
Curl
curl -X DELETE "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/column/BXP0" -H "accept: application/json" -H "x-access-token: sampleaccesstoken"
Parameters
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
columnIdpathid of columnYesstring
Sample Response
Click to expand/collapse
{
"success": true,
"id": "BXP0"
}
Responses
CodeDescriptionSchema
200OKColumnCUDResponse
401Unauthorized
404Not Found
Security
Security SchemaScopes
ApiKeyAuth

Update Order of Columns

Description:
  • Allows you to update order of the columns in a table.

POST

/v1/crm/core/table/{tableId}/save-col-order

Request URL
https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/save-col-order
Curl
curl -X POST "https://bifrost-us.deskera.com/v1/crm/core/table/61faa9c1822a71d710f4f6a4/save-col-order" -H "accept: application/json" -H "x-access-token: sampleaccesstoken" -H "Content-Type: application/json" -d '["col_id_1","col_id_2","col_id_3"]'
Parameters
NameLocated inDescriptionRequiredSchema
tableIdpathUnique id of tableYesstring
ColumnbodyColumn to addYesColumnRequest
Sample Request
Click to expand/collapse
[
"col_id_1",
"col_id_2",
"col_id_3"
]
Sample Response
Click to expand/collapse
{
"success": true,
}
Responses
CodeDescriptionSchema
201OKColumnOrderUpdateResponse
401Unauthorized
Security
Security SchemaScopes
ApiKeyAuth

Models


ColumnRequest

NameTypeDescriptionRequired
namestringDisplay nameYes
typestringtext/number/email/date/url/phone/select/multi-select/boolean/ref/ref_array/user/user_arrayYes
indexintegerindex of column in the display orderNo
optionsList of ColumnOptionRequestpossible values of the column. Applicable to select and multi-select type only.No
requiredbooleanWhether the value of column is required in each recordNo
widthintegerwidth of the column in gridNo
editablebooleanWhether the column value is editable in gridNo
hiddenbooleanWhether the column is to be kept hidden in the gridNo
uiVisiblebooleanWhether the column is visible in UINo

ColumnOptionRequest

NameTypeDescriptionRequired
idstringUnique id within the columnYes
namestringDisplay nameYes
colorstringBadge colorNo

ColumnCUDResponse

NameTypeDescriptionRequired
successbooleanSuccess flagYes
idstringUnique id of the column within the tableYes

ColumnOrderUpdateResponse

NameTypeDescriptionRequired
successbooleanSuccess flagYes