PATCH /api/database/fields/{field_id}/
Updates the existing field if the authorized user has access to the related database's workspace. The type can also be changed and depending on that type, different additional properties can optionally be set. If you change the field type it could happen that the data conversion fails, in that case the ERROR_CANNOT_CHANGE_FIELD_TYPE is returned, but this rarely happens. If a data value cannot be converted it is set to null so data might go lost.If updated the field causes other fields to change then the specificinstances of those fields will be included in the related fields response key.
Servers
- /
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
field_id |
Integer | Yes |
Updates the field related to the provided value. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
ClientSessionId |
String | No |
An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone. |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
ClientUndoRedoActionGroupId |
String | No |
An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.