REST API: GET databases

Waarschuwing: Je bekijkt nu het overzicht voor de oude versie van onze API. Wij raden aan om versie 2 van de API te gebruiken.

Je kunt alle informatie omtrent databases opvragen met de onderstaande methode. Dit is een HTTP GET call naar het volgende adres:

https://api.copernica.com/v1/databases?access_token=xxxx

Beschikbare parameters

De volgende parameters kunnen aan de URL als parameters worden toegevoegd:

  • start: eerste database die wordt opgevraagd;
  • limit: lengte van de batch die wordt opgevraagd;
  • total: toon wel/niet het totaal aantal databases in de output.

Geretourneerde velden

De methode retourneert een lijst van databases. Van elke database in de lijst wordt een aantal velden teruggegeven:

  • id: unieke id;
  • name: naam van de database;
  • description: omschrijving van de database;
  • archived: checkt of een database is gearchiveerd;
  • created: tijdstip waarop de database is aangemaakt;
  • fields: array met de fields in de database;
  • interests: array met de interests in de database;
  • collections: array met de collections in de database.

Het is ook mogelijk om apart informatie over fields, interests en collections op te vragen:

Voorbeeld

Het volgende PHP script demonstreert hoe je de API methode kunt aanroepen:

// vereiste scripts
require_once("copernica_rest_api.php");

// verander dit naar je access token
$api = new CopernicaRestApi("your-access-token");

// parameters voor de methode
$parameters = array(
    'limit' =>  100
);

// voer de methode uit en print het resultaat
print_r($api->get("databases", $parameters));

Dit voorbeeld vereist de REST API class.

Meer informatie