REST API v2: PUT view

Methode om de properties van een selectie bij te werken. Dit is een HTTP PUT methode die toegankelijk is via het volgende adres:

https://api.copernica.com/v2/view/$id?access_token=XXX

De variabele $id in de URL moet worden vervangen door de numerieke identifier van de selectie die je wilt bewerken.

Beschikbare parameters

De volgende variabelen kunnen in de body van het HTTP PUT commando worden geplaatst:

  • name: de optionele nieuwe naam van de selectie
  • description: de optionele nieuwe omschrijving van de selectie
  • parent-type: geeft aan of de selectie onder een selectie of database valt
  • parent-id: id van de database of selectie waar de selectie onder valt
  • has-children: boolean waarde om aan te geven of er selecties onder deze selectie vallen
  • has-referred: boolean waarde om aan te geven of er andere selecties naar deze selectie refereren
  • has-rules: boolean waarde om aan te geven of de selectie regels heeft of niet

Voorbeeld

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", 2);

// data voor de methode
$data = array(
    'description'   =>  'een nieuwe omschrijving',
);

// voer het verzoek uit
api->put("view/{$viewID}", $data);

Dit voorbeeld vereist de REST API klasse.

Meer informatie