REST API v1: GET view rule

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.

Selecties gebruiken regels om te beslissen welke profielen worden gebruikt in de selectie en welke niet. Profielen die tenminste een regel matchen worden toegevoegd. Om de informatie van een enkele regel op te vragen kan er een HTTP GET verzoek worden verstuurd naar de volgende URL:

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

De eerste $id code moet vervangen worden met de numerieke identifier van de selectie waar je een regel uit wilt opvragen. De tweede $id parameter moet de ID van de regel zijn.

De geretourneerde informatie

Het resultaat van deze methode is een regel met bijhorende informatie:

  • 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

Een regel heeft zijn eigen voorwaarden waaraan voldaan moet worden om met een profiel te matchen. De voorwaarden eigenschap die wordt teruggeven heeft een array van voorwaarde objecten, die elk de volgende eigenschappen bezitten:

  • ID: numerieke identifier van de voorwaarde
  • type: type van de voorwaarde
  • rule: numerieke identifier van de regel waar de voorwaarde bij hoort

De precieze eigenschappen hangen af van het type van de voorwaarde. Voor een overzicht van de ondersteunde voorwaarden en de eigenschappen die zij bezitten kunt u de volgende specifiekere artikels bekijken:

Voorbeeld in PHP

Het volgende script kan gebruikt worden om de eigenschappen van regel 12 binnen selectie 1234 op te vragen:

// 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/rule/12"));

Dit voorbeeld vereist de REST API class.

Meer informatie