Tables

Adds a field into the table

post/v3/tables/{tableName}/fields

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v3/tables/{tableName}/fields
  • Auth: API key in header Authorization

Path parameters

tableNamestring required

Table name

Request body

Namestring required

Field name

Typestring required

Field type

Uniqueboolean nullable

Indicates whether the field value must be unique (possible values = {true, false}, default value = false)

UniqueAllowNullsboolean nullable

Indicates whether the null value is allowed in the unique field (use only if Unique = true, possible values = {true, false}, default value = false)

Labelstring nullable

Field label (default value = "")

Descriptionstring nullable

Field description (default value = "")

DisplayOrderinteger nullable

Display order (default value = 0 which means last)

OnInsertboolean nullable

Used only for TIMESTAMP field type. Indicates whether the date and time will be recorded when record is submitted (possible values = {true, false}, default value = false)

OnUpdateboolean nullable

Used only for TIMESTAMP field type. Indicates whether the date and time will be recorded when record is updated (possible values = {true, false}, default value = false)

TimeZonestring nullable

Used only for TIMESTAMP field type. Indicates the time zone used to record date and time (default value = "")

Formatstring nullable

Field format which is used only for RANDOM ID (possible values {"0", "U", "0U"}) and PREFIXED AUTONUMBER (possible values {"1", "01", "001", "0001", "00001", "000001", "0000001"}) field type (default value = "")

Prefixstring nullable

Prefix of the field value which is used only for RANDOM ID and PREFIXED AUTONUMBER field type (string length must be less than 50, default value = "")

Lengthinteger nullable

Length of the random part value which is used only for RANDOM ID field type (if Format = "0" then Length must be from 8 to 12, if Format = {"U", "0U"} then Length must be from 6 to 12, default value = 12)

IsFormulaboolean nullable

Indicates whether the field is the formula field (possible values = {true, false}, default value = false)

ListFieldstring[] nullable

List of values which is used only for LIST-STRING, LIST-NUMBER, LIST-DATE/TIME (example: ["value1", "value2", "value3"])

AttachmentPermittedFileTypesstring[] nullable

List of values (permitted file extensions) which is used only for ATTACHMENT field type (if null or empty all file types are allowed)

AttachmentMinFileSizeinteger nullable

Minimum file size which is used only for ATTACHMENT field type

AttachmentMaxFileSizeinteger nullable

Maximum file size which is used only for ATTACHMENT field type

AttachmentSmartResizerboolean nullable

Smart resizer option which is used only for ATTACHMENT field type

AttachmentSmartResizerForRetinaboolean nullable

Optimize for Retina displays option which is used only for ATTACHMENT field type (only if AttachmentSmartResizer = true)

AttachmentAltTextstring nullable

Alt text which is used only for ATTACHMENT field type

AttachmentTitlestring nullable

Title which is used only for ATTACHMENT field type

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.