Back to API references

SOAP API method Database_createField


This method will create a new field into the database. The name of the field is mandatory, you can also give the type, the defaultvalue, the specialcontent, if the field has to be displayed and if ordered by this field.


Name Type Description
id * int Unique identifier (id) of the object Database. The method only applies to the database with this id.
name * string The name of the new field. This must be a valid identifier, and there should not already be a field, interest or collection with the same name.
type string Type of field. Valid types are
value string value
display boolean display
ordered boolean ordered
length integer field length (only for text fields)
textlines integer number of lines (only for text fields)
hidden boolean is this field hidden
index boolean is this field indexed
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
field Structure of type 'field' The field object that is created

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'field'

Name Type Description
id int The ID of the field.
name string The name of the field.
big boolean Is this field a big field?.
pixelwidth int The width of this field.
weight int The weight of this field.
type string The type of this field.
value string The default value of this field.
specialcontent string The special content of this field.
ordered boolean Is this the field that we order by by default?
displayed boolean Is this field displayed?
indatatable boolean Is this field added to the data table?
length integer Get the length of the field
lines integer Get the number of lines in this field
hidden boolean Is this field hidden?
index boolean Is this field indexed?