REST API v2: GET rule

Dit is een methode om alle metadata van een regel op te vragen. Deze methode ondersteunt geen parameters. De methode is aan te roepen met een HTTP GET request naar de volgende URL:

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

De $id hier moet vervangen worden door de ID van de regel waarvan je de data op wil vragen.

Teruggegeven velden

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
  • conditions: array van voorwaarden voor de regel
  • disabled: Boolean om aan te geven of de regel wel (true) of niet (false) geactiveerd is
  • inversed: Boolean die aangeeft of de regel wel (true) of niet (false) een inverse is.

Condities

De 'conditions' zijn voorwaarden waaraan voldaan moet worden om met een profiel te matchen. De conditions 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 'condition'. Specifiekere uitleg is te vinden onder het "Meer informatie" kopje.

JSON voorbeeld

De JSON voor een regel ziet er bijvoorbeeld zo uit:

{  
    "ID":"4012",
    "name":"Rule",
    "view":"4184",
    "conditions":{  
    "start":0,
    "limit":100,
    "count":1,
    "data":[  
        {  
            "ID":"2110",
            "type":"Field",
            "rule":"4039",
            "comparison":"equals",
            "field":{  
                "ID":"22142",
                "name":"subscribed",
                "type":"text",
                "value":"no",
                "displayed":false,
                "ordered":false,
                "length":"255",
                "textlines":"3",
                "hidden":false,
                "index":false
            },
            "value":"yes",
            "other-field":false,
            "numeric-comparison":false
        }
    ],
    "total":1
    },
    "inversed":false,
    "disabled":false
}

Voorbeeld in PHP

Het volgende PHP script demonstreert hoe de API method te gebruiken is.

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

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

// voer het verzoek uit en print het resultaat
print_r($api->get("rule/{$regelID}"));

Dit voorbeeld vereist de REST API klasse.

Meer informatie

De condities waaruit regels bestaan verschillen onderling flink. Daarom gaan de onderstaande artikelen dieper in op de verschillende soorten condities.