REST API v3: PUT minirule

Een minirule is voor een miniview wat een regel is voor een selectie. Om de eigenschappen van een minirule aan te passen kan er een HTTP PUT verzoek verstuurd worden naar de volgende URL:

https://api.copernica.com/v3/minirule/$id?access_token=xxxx

De $id moet aangepast worden naar de ID van de minirule die je aan wilt passen.

Beschikbare parameters

De volgende parameters kunnen in de message body geplaatst worden:

  • name: naam van de regel;
  • inversed: boolean waarde die aangeeft of de regel geïnverteerd moet worden of niet. Als deze op "True" staat worden alleen profielen die niet aan de condities voldoen teruggegeven;
  • disabled: boolean waarde om aan te geven of de regel uitgeschakeld moet worden of niet.

Voorbeeld in JSON

De volgende JSON demonstreert hoe je de API methode kunt gebruiken:

{
    "name": "nieuwe regel naam"
}

Voorbeeld in PHP

Het volgende voorbeeld demonstreert hoe deze methode gebruikt kan worden:

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

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

// data voor de methode
$data = array(
    'name'   =>  'nieuwe regel naam',
);

// voer het verzoek uit en print het resultaat
print_r($api->put("minirule/{$miniruleID}", $data));

Dit voorbeeld vereist de REST API klasse.

Meer informatie