REST API v4 condities: Export

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 export 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:

  • include-never-exported-profiles: een boolean value om aan te geven of profielen die niet eerder zijn geëxporteerd, alsnog meegenomen moeten worden.

Export per tijdsinterval

Voor deze conditie kun je ook een datum toevoegen, zodat je weet wanneer de conditie is aangemaakt of geüpdatet. Deze datums kun je op de volgende manier meegeven aan de POST request:

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

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

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

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

'["plus/minus", "YYYY-MM-DD", "HH:MM:SS"]'
'["plus", "2017-01-01", "05:43:21"]'

Voorbeeld in JSON

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

{
    "type": "Export",
    "include-never-exported-profiles": true
}

Voorbeeld in PHP

Je kunt ook selecteren op profielen die je voor een bepaalde dag al eens
hebt geëxporteerd. Hieronder is weergegeven hoe je zo'n scenario vertaald naar daadwerkelijke code.

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

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

$data = array(
    // selecteer export conditie
    'type' => 'Export',

    // gebruik gewenste eigenschappen
    'include-never-exported-profiles' => true,
);

// 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