Database table fields

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.

patch/api/database/fields/{field_id}/

Path parameters

field_idinteger required

Updates the field related to the provided value.

Headers

ClientSessionIdstring uuid

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.

ClientUndoRedoActionGroupIdstring uuid

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.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

Changed in 3 of the 6 revisions of this API.2493

  • f3396317d932141See the full diff
    • removed the required property oneOf[ButtonFieldFieldSerializerWithRelatedFields]/error from the response with the 200 status

      response-required-property-removed

    • removed the request property oneOf[ButtonFieldUpdateField]/url_formula (media type: application/json)

      request-property-removed

    • removed the request property oneOf[ButtonFieldUpdateField]/url_formula (media type: application/x-www-form-urlencoded)

      request-property-removed

    • removed the request property oneOf[ButtonFieldUpdateField]/url_formula (media type: multipart/form-data)

      request-property-removed

    • removed the optional property oneOf[ButtonFieldFieldSerializerWithRelatedFields]/url_formula from the response with the 200 status

      response-optional-property-removed

    • added the required property oneOf[ButtonFieldFieldSerializerWithRelatedFields]/has_workflow_actions to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0c490e5b0c7f191See the full diff
    • added ButtonFieldFieldSerializerWithRelatedFields to the response body oneOf list for the response status 200

      response-body-one-of-added

    • added button mapping keys to the request discriminator (media type: application/json)

      request-body-discriminator-mapping-added

    • added button mapping keys to the request discriminator (media type: application/x-www-form-urlencoded)

      request-body-discriminator-mapping-added

    • added button mapping keys to the request discriminator (media type: multipart/form-data)

      request-body-discriminator-mapping-added

    • added ButtonFieldUpdateField to the request body oneOf list (media type: application/json)

      request-body-one-of-added

    • added ButtonFieldUpdateField to the request body oneOf list (media type: application/x-www-form-urlencoded)

      request-body-one-of-added

    • added ButtonFieldUpdateField to the request body oneOf list (media type: multipart/form-data)

      request-body-one-of-added

    • added the new button enum value to the request property oneOf[AIFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[AIFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[AIFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[AutonumberFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[AutonumberFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[AutonumberFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[BooleanFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[BooleanFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[BooleanFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CountFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CountFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CountFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedByFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedByFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedByFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedOnFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedOnFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[CreatedOnFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DateFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DateFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DateFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DurationFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DurationFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[DurationFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[EmailFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[EmailFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[EmailFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FileFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FileFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FileFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormViewEditRowFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormViewEditRowFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormViewEditRowFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormulaFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormulaFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[FormulaFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedByFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedByFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedByFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LastModifiedFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LinkRowFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LinkRowFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LinkRowFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LongTextFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LongTextFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LongTextFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LookupFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LookupFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[LookupFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleCollaboratorsFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleCollaboratorsFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleCollaboratorsFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleSelectFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleSelectFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[MultipleSelectFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[NumberFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[NumberFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[NumberFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PasswordFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PasswordFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PasswordFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PhoneNumberFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PhoneNumberFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[PhoneNumberFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RatingFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RatingFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RatingFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RollupFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RollupFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[RollupFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[SingleSelectFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[SingleSelectFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[SingleSelectFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[TextFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[TextFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[TextFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[URLFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[URLFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[URLFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[UUIDFieldUpdateField]/type (media type: application/json)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[UUIDFieldUpdateField]/type (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new button enum value to the request property oneOf[UUIDFieldUpdateField]/type (media type: multipart/form-data)

      request-property-enum-value-added

    • added button mapping keys to the response discriminator for the response status 200

      response-body-discriminator-mapping-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property oneOf[AIFieldFieldSerializerWithRelatedFields]/error to the response with the 200 status

      response-required-property-added