REST API v1: GET collection fields

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

Een collectie is een geneste tweede laag bij een database. Een collectie heeft dus ook velden. Om deze velden op te vragen kun je een HTTP GET request sturen naar het volgende adres:

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

De code $id moet je vervangen door de numerieke identifier van de collectie waar je de velden van wilt opvragen.

Beschikbare parameters

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

  • start: eerste veld dat wordt opgevraagd
  • limit: lengte van de batch die wordt opgevraagd
  • total: toon wel/niet het totaal aantal beschikbare velden

Meer informatie over de betekenis van deze parameters vind je in het artikel over paging.

Geretourneerde velden

De methode retourneert een lijst van velden in de database. Voor elk veld worden de volgende eigenschappen teruggegeven:

  • id: numeriek id van het veld
  • name: naam van het veld
  • type: veld type

Voorbeeld in PHP

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

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

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

// parameters om mee te geven
$parameters = array(
    'limit' =>  100,
);

// voer de methode uit en print de resultaten
print_r($api->get("collection/id/fields", $parameters));

Dit voorbeeld vereist de REST API class.

Meer informatie