REST API v4: GET database restrictions

Methode om een overzicht op te vragen van alle beschikbare restricties in een database. Dit is een HTTP GET-call naar het volgende adres:

https://api.copernica.com/v4/database/$id/restrictions

De code $id moet je vervangen door de numerieke identifier of de naam van de database waar je de restricties van wilt opvragen.

Beschikbare parameters

De volgende parameters kunnen aan de URL als variabelen worden toegevoegd:

• start: eerste restrictie die wordt opgevraagd
• limit: lengte van de batch die wordt opgevraagd
• total: toon wel/niet het totaal aantal restricties in de output

Meer informatie over de betekenis van deze parameters vind je in het artikel over paging.

Geretourneerde velden

De methode retourneert een lijst van restricties in de database. Voor elke restrictie worden eerst de algemene eigenschappen teruggegeven. Daarnaast bevat een restrictie één of meerdere rules (regels), die op hun beurt weer één of meerdere conditions bevatten.

Eigenschappen van een restrictie

Voor elke restrictie worden de volgende eigenschappen teruggegeven:

• ID: numeriek ID van de restrictie
• name: naam van de restrictie
• description: beschrijving van de restrictie
• disabled: boolean waarde die aangeeft of de restrictie is uitgeschakeld
• rules: lijst met rule die onderdeel zijn van deze restrictie

Eigenschappen van een rule

Elke restrictie kan één of meerdere rules bevatten. Een rule bevat de volgende eigenschappen:

• ID: numeriek ID van de rule
• name: naam van de rule
• disabled: boolean waarde die aangeeft of de rule is uitgeschakeld
• conditions: lijst met condities die onderdeel zijn van deze rule

Eigenschappen van een condition

Een rule bestaat uit één of meerdere condities. Voor elke condition worden de volgende eigenschappen teruggegeven:

• ID: numeriek ID van de condition
• type: type conditie, bijvoorbeeld een waarde-vergelijking
• field: veld waarop de conditie wordt toegepast
• value: waarde waarmee het veld wordt vergeleken
• match-mode: manier waarop de vergelijking wordt uitgevoerd (bijvoorbeeld contains of not_equals)
• numeric-comparison: boolean waarde die aangeeft of de vergelijking numeriek wordt uitgevoerd

JSON voorbeeld

De JSON voor een enkele database ziet er bijvoorbeeld zo uit:

{
  "start": 0,
  "limit": 100,
  "count": 1,
  "data": [
    {
      "ID": "1",
      "name": "Filter email address",
      "description": "This is a restriction to block all @copernica.com addresses",
      "disabled": false,
      "rules": [
        {
          "ID": "22",
          "name": "Rule_0",
          "disabled": false,
          "conditions": [
            {
              "ID": "8",
              "type": "Value",
              "field": "Email",
              "value": "@copernica.com",
              "match-mode": "contains",
              "numeric-comparison": false
            }
          ]
        }
      ]
    }
  ]
}

Voorbeeld in PHP

Het volgende PHP-script demonstreert hoe je de API-methode kunt aanroepen:

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

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

// voer methode uit en print resultaat
print_r($api->get("database/{$databaseID}/restrictions", $parameters));

Dit voorbeeld vereist de REST API-klasse.

Meer informatie

• Overzicht van alle API-calls