REST API: GET view

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

Een methode om de metadata van een database op te vragen. De methode kan aangeroepen worden met een HTTP GET verzoek aan de volgende URL:

https://api.copernica.com/v1/view/$id?access_token=xxxx

Hier moet de $id vervangen worden met de numerieke identifier van de database waarvan de selecties moeten worden opgevraagd.

Beschikbare parameters

Er zijn geen beschikbare parameters voor deze methode.

Geretourneerde velden

  • id: unieke numerieke identifier van selectie
  • name: naam van de selectie
  • description: beschrijving van de selectie
  • parent-type: type van de parent (view/database)
  • parent-id: id van de parent
  • has-children: geeft aan of de selectie zelf selecties bevat
  • has-referred: geeft aan of er andere selecties zijn die naar deze selectie refereren.
  • has-rules: geeft aan of de selectie regels heeft
  • database: id van de database waar deze selectie onder valt
  • last-built: tijdstip laatste opbouw van de selectie

Voorbeeld in PHP

Het volgende voorbeeld demonstreert hoe deze methode gebruikt kan worden met de API:

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

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

// voer de methode uit en print het resultaat
print_r($api->get("view/1234"));

Dit voorbeeld vereist de REST API class.

Meer informatie