Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

REST API: GET database views

To request which selections are available in a database, do an HTTP GET request to the following URL:

https://api.copernica.com/v2/database/$id/views?access_token=xxxx

In this, $id needs to be replaced by the numerical identifier or the name of the database you wish to request the selections for.

Available parameters

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

Parameter Description
start The first view to be requested.
limit Length of the requested batch.
total Whether or not the total number of views 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 JSON object with views in the data field. Each view has the following fields:

Variable Description
ID Unique numerical identifier.
name Name of the selection.
description Description of the selection.
parent-type Type of the parent: view or database.
parent-id ID of the database or view.
has-children Boolean value: whether or not the database has selections nested underneath it.
has-referred Boolean value: whether or not there are other selections that refer to this selection.
has-rules Boolean value: whether or not the selection has selection rules.
database ID of the database this selection belongs to.
last-built Timestamp of the last time the view was built.
intentions Array with the intentions for the view (either 1 or null for email/sms/fax/pdf).

JSON example

The JSON for a single view might look something like this:

{  
   "ID":"4184",
   "name":"Leadscoring",
   "description":"",
   "parent-type":"database",
   "parent-id":"7616",
   "has-children":false,
   "has-referred":false,
   "has-rules":true,
   "database":"7616",
   "last-built":"2019-04-17 00:21:26"
}

PHP example

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

// dependencies
require_once('copernica_rest_api.php');

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

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

// do the call, and print result
print_r($api->get("database/{$databaseID}/views", $parameters));

The example above requires the CopernicaRestApi class.

More information