REST API v4: GET view rule

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/v4/view/$id/rule/$id

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.

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 script kan gebruikt worden om de eigenschappen van een regel op te vragen:

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

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

// voer de methode uit en print het resultaat
print_r($api->get("view/{$view}/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.