REST API v4: POST database field
Method to add a new field to an existing database. This is an HTTP POST call to the following address:
https://api.copernica.com/v4/database/$id/fields
In this, $id
should be replaced by the numerical identifier, the ID, of the database you want to add a selection to.
The name of the field and other variables need to be added to the message
body of the HTTP request. After a successful call the ID of the created
request is returned.
Available parameters
The following variables can be put into the message body of the HTTP POST call:
- name: the name of the new field (mandatory)
- description: the description of the new field
- type: type of the new field
- value: default value of the new field
- displayed: boolean value to determine whether or not the field should be placed into lists and grids in the user interface
- ordered: boolean value to determine whether or not profiles should be ordered by the value in this field.
- length: maximum text length
- textlines: number of lines in webforms to edit the field
- hidden: boolean value to make sure a field is never shown in the interface
- index: boolean value, sets whether or not the field should be indexed
- lock: boolean value to indicate that the field can only be modified or deleted via the API
The following types are available for fields:
- integer: numerical value
- float: numerical floating point value
- date: mandatory date field
- empty_date: non-mandatory date field
- datetime: mandatory field with date and time
- empty_datetime: non-mandatory field with date and time
- text: regular text field
- email: field with email address used for mailings (1 per database allowed)
- phone_gsm: phone field with phone number that can be used for text messages (1 per database allowed)
- select: multiple choice field
- big: large text field
- foreign_key: numerical value that directs to another profile
JSON example
The following JSON demonstrates how to use the API method:
{
"name": "text_field",
"type": "text",
"value": "this is a text field",
"displayed": true,
"ordered": false,
"length": 50,
"textlines": 1,
"hidden": false,
"index": false
}
PHP example
The following PHP example demonstrates how to use the API method:
// dependencies
require_once('CopernicaRestAPI.php');
// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// data to pass to the call
$data = array(
'name' => 'extra_field',
'type' => 'select',
'value' => 'A\nB\nC*'
);
// do the call
$api->post("database/{$databaseID}/fields", $data);
// return id of created request if successful
The example above requires the CopernicaRestApi class.