REST API v3: PUT rule

Dit is een methode om de eigenschappen van een bestaande regel aan te passen. Om deze uit te voeren kan er een HTTP PUT verzoek worden verstuurd naar de volgende URL:

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

De $id moet hier vervangen worden door de ID van de regel waarvan je de eigenschappen aan wilt passen.

Beschikbare parameters

De volgende eigenschappen voor de regel kunnen toegevoegd worden aan de HTTP PUT command:

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

Voorbeeld in JSON

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

{
    "name": "new_name"
}

Voorbeeld in PHP

Het volgende voorbeeld laat zien hoe je deze methode gebruikt met de API:

// 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(
    'description'   =>  'a new description'
);

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

Dit voorbeeld vereist de REST API klasse.

Meer informatie