Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

REST API: POST rule conditions

A method to add a condition for a rule. It is called by sending an HTTP POST request to the following URL:

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

In this, $id needs to be replaced by the numerical identifier or the name of the rule you wish to edit the conditions of. After a successful call the ID of the created request is returned.

Available parameters

  • type: type of condition

Based on the condition type, specific properties are set. For an overview of the supported conditions and the properties that they support, check the specific articles:

PHP example

The following example demonstrates how to use this method:

// dependencies
require_once('copernica_rest_api.php');

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 2);

// parameters to pass to the call
$data = array(
	'type' => 'date'
);

// do the call, and print result
$api->post("rule/{$rule}/conditions", array(), $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information