REST API: POST database interest

The HTTP POST method to add an interest to an existing database is available at the following address:$id/interests?access_token=xxxx

In this, $id should be replaced by the ID of the database you want to add an interest to. The name of the interest field and other values 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 set in the message body:

  • name: the title of the new interest field (mandatory)
  • group: the group the field belongs to. Interests that belong to the same group are put together in the user interface

JSON example

The following JSON demonstrates how to use the API method:

  "name": "Football",
  "group": "Sport"

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", 3);

// data to pass to the call
$data = array(
    'name'      =>  'Football',
    'group'     =>  'Sport'

// do the call
$api->post("database/{$databaseID}/interests", $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information: