REST API v3 condities: Change

Condities zijn kleinere onderdelen van regels. Er hoeft maar aan een conditie van een regel te worden voldaan om aan de regel te voldoen. Elke conditie heeft specifieke eigenschappen.

Dit artikel gaat over de change conditie. Als je op zoek bent naar andere type condities kun je deze vinden onder het kopje Meer informatie.

Eigenschappen

Voor deze conditie zijn de volgende parameters beschikbaar:

  • change-type: Changetype van de change conditie, zie changetypes tabel;
  • field: Database veld om wel/niet te veranderen;
  • interest: Database interesse om wel/niet te veranderen.

Change types

Er zijn verschillende soorten veranderingen die kunnen voorkomen in je database. Daarom kun je bij de change conditie een type en een waarde opgeven. In de onderstaande tabel vind je de soorten veranderingen die gebruikt kunnen worden voor de conditie.

Change type Omschrijving
any elke verandering
none geen verandering
field field waarde veranderd
nofield field waarde onveranderd
new profile werd aangemaakt
notnew profile werd niet aangemaakt
edit profile werd aangepast
noedit profile werd niet aangepast
newsubprofile nieuw subprofile aangemaakt
nonewsubprofile geen nieuw subprofile aangemaakt
editsubprofile subprofile werd veranderd
noeditsubprofile subprofile werd niet veranderd
removesubprofile subprofile werd verwijderd
noremovesubprofile subprofile werd niet verwijderd
interest interest veranderd
gotinterest nieuwe interest toegevoegd
lostinterest interest verloren

Change per tijdsinterval

Voor deze conditie kun je ook een datum toevoegen, zodat je weet wanneer de conditie is aangemaakt of geüpdatet. Je kunt tijd op de volgende manieren gebruiken:

  • before-time: matcht alleen de change condition voor deze tijd;
  • after-time: matcht alleen de change condition na deze tijd;
  • before-mutation: tijdverschil voor de change condition;
  • after-mutation: tijdverschil na de change condition.

Je kunt in het volgende formaat de waarde voor de 'time' properties meegeven:

'YYYY-MM-DD HH:MM:SS'
'2022-01-01 00:00:00'

De 'mutation' properties accepteren voor de value de volgende stringvolgorde:

'["plus/minus", "count", "unit(second,minute,hour,day,week,month or year)", "floorto(second,minute,hour,day,month or year)"]'
'["plus", "0", "day", "day"]'

Voorbeeld in JSON

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

{
    "type": "Change",
    "change-type": "any"
}

Voorbeeld in PHP

We gebruiken hier een conditie die geldt als er ooit veranderingen zijn gemaakt.

// vereiste module
require_once("copernica_rest_api.php");

// maak een API object met je eigen token
$api = new CopernicaRestAPI("your-access-token", 3);

$data = array(
    // selecteer email conditie
    'type' => 'Change',

    // selecteer gewenste eigenschappen
    'change-type' => 'any'
);

// voer het verzoek uit
$result = $api->post("rule/{$regelID}/conditions", $data);

// print het resultaat
print_r($result);

Dit voorbeeld vereist de REST API klasse.

Meer informatie