REST API: GET database fields

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

This method is used to request all fields in a database. It is an HTTP GET call to the following address:$id/fields?access_token=xxxx

In this, $id should be replaced by the numerical identifier or the name of the database of which you want to request the fields.

Available parameters

The following parameters can be added to the URL as variables:

  • start: the first field to be requested
  • limit: length of the requested batch
  • total: whether or not the total number of fields should be counted

More information on the meaning of these parameters can be found in the article on paging.

Returned fields

The method returns a list of fields in the database. For each field, the following properties are displayed:

  • ID: ID of the field in the database
  • name: the name of the new field. (mandatory)
  • 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 this field.
  • length: maximum text length
  • textlines: number of lines in forms to edit the field
  • hidden: boolean value to make sure a field is never shown in the interface
  • index: boolean value that shows whether or not the field should be indexed

PHP example

The following PHP script demonstrates how to use the API method:

// dependencies

// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// parameters to pass to the call
$parameters = array(
    'limit'     =>  100

// do the call, and print result
print_r($api->get("database/1234/fields", $parameters));

The example above requires the CopernicaRestApi class.

More information