REST API v4: GET miniview rules

Een miniview is voor een collectie wat een view/selectie is voor een database. Om de regels van zo'n miniview op te vragen kun je een HTTP GET verzoek versturen naar de volgende URL:

https://api.copernica.com/v4/miniview/$id/rules

De $id moet vervangen worden door de ID van de selectie van een collectie waarvoor je de regels op wilt vragen.

Ondersteunde parameters

Je kunt een of meerdere van de volgende parameters aan de URL toevoegen:

  • start: eerste regel om op te vragen
  • limit: maximale grootte van de opgevraagde hoeveelheid regels
  • total: laat wel of niet het totaal aantal matchende regels zien

Je kunt meer informatie vinden over de start, limit en total parameters in ons artikel over paging.

Teruggegeven eigenschappen

Deze methode geeft een lijst van regels terug. Elk item in deze lijst is een JSON object met de volgende eigenschappen:

  • ID: numerieke identifier van de regel
  • name: naam van de regel
  • view: ID van de selectie waar de regel bij hoort
  • disabled: waarde om aan te geven of de regel niet (1) /wel (0) geactiveerd is
  • inversed: waarde die aangeeft of de regel een inverse is. Als deze variabele waar is worden profielen teruggegeven als ze de regel niet matchen
  • conditions: array van voorwaarden voor de regel

Voorbeeld in PHP

Het volgende script kan gebruikt worden om de regels van een selectie op te vragen.

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

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

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

// voer het verzoek uit en print het resultaat
print_r($api->get("view/{$viewID}/rules", $parameters));

Dit voorbeeld vereist de REST API klasse.

Meer informatie