Update an existing table
PATCH {{baseUrl}}/cms/v3/hubdb/tables/:tableIdOrName/draft?includeForeignIds=<boolean>&archived=<boolean>&isGetLocalizedSchema=<boolean>
Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft
verion of the table. Use publish
endpoint to push all the changes to the published
version. To restore a table, include the query parameter archived=true
and "archived": false
in the json body.
Note: You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
includeForeignIds | string | Set this to true to populate foreign ID values in the result. | |
archived | string | Specifies whether to return archived tables. Defaults to false . | |
isGetLocalizedSchema | string |
Request Body
{"label"=>"<string>", "name"=>"<string>", "useForPages"=>"<boolean>", "allowPublicApiAccess"=>"<boolean>", "allowChildTables"=>"<boolean>", "enableChildTablePages"=>"<boolean>", "columns"=>[{"id"=>"<integer>", "label"=>"<string>", "name"=>"<string>", "options"=>[{"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}, {"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}], "type"=>"NUMBER", "foreignTableId"=>"<long>", "foreignColumnId"=>"<integer>"}, {"id"=>"<integer>", "label"=>"<string>", "name"=>"<string>", "options"=>[{"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}, {"id"=>"<string>", "name"=>"<string>", "order"=>"<integer>", "type"=>"<string>", "label"=>"<string>", "createdAt"=>"<dateTime>", "updatedAt"=>"<dateTime>"}], "type"=>"NULL", "foreignTableId"=>"<long>", "foreignColumnId"=>"<integer>"}], "dynamicMetaTags"=>{"dolore487"=>"<integer>", "voluptate_0"=>"<integer>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"label":"\u003cstring\u003e","name":"\u003cstring\u003e","id":"\u003cstring\u003e","columns":[{"label":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"DATE","id":"\u003cstring\u003e","deleted":"\u003cboolean\u003e","options":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","order":"\u003cinteger\u003e","type":"\u003cstring\u003e","label":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","order":"\u003cinteger\u003e","type":"\u003cstring\u003e","label":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"}],"width":"\u003cinteger\u003e","foreignTableId":"\u003clong\u003e","foreignColumnId":"\u003cinteger\u003e","description":"\u003cstring\u003e","foreignIds":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"foreignIdsByName":{"irure1":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"laboris0":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}},"foreignIdsById":{"sint5":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"sed0":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"et_1":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}},"optionCount":"\u003cinteger\u003e"},{"label":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"URL","id":"\u003cstring\u003e","deleted":"\u003cboolean\u003e","options":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","order":"\u003cinteger\u003e","type":"\u003cstring\u003e","label":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","order":"\u003cinteger\u003e","type":"\u003cstring\u003e","label":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"}],"width":"\u003cinteger\u003e","foreignTableId":"\u003clong\u003e","foreignColumnId":"\u003cinteger\u003e","description":"\u003cstring\u003e","foreignIds":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"foreignIdsByName":{"non_d":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"magna___6":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}},"foreignIdsById":{"fugiat0":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","type":"\u003cstring\u003e"}},"optionCount":"\u003cinteger\u003e"}],"published":"\u003cboolean\u003e","deleted":"\u003cboolean\u003e","columnCount":"\u003cinteger\u003e","rowCount":"\u003cinteger\u003e","createdBy":{"email":"\u003cstring\u003e","firstName":"\u003cstring\u003e","id":"\u003cstring\u003e","lastName":"\u003cstring\u003e"},"updatedBy":{"email":"\u003cstring\u003e","firstName":"\u003cstring\u003e","id":"\u003cstring\u003e","lastName":"\u003cstring\u003e"},"useForPages":"\u003cboolean\u003e","allowChildTables":"\u003cboolean\u003e","enableChildTablePages":"\u003cboolean\u003e","isOrderedManually":"\u003cboolean\u003e","dynamicMetaTags":{"est6c3":"\u003cinteger\u003e"},"allowPublicApiAccess":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","publishedAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"}