REST API v1: PUT miniview

Waarschuwing: Je bekijkt nu het overzicht voor de oude versie van onze API. Wij raden aan om onze laastste versie van de API te gebruiken.

Een miniview is voor een collectie wat een selectie is voor een database. Om een miniview aan te passen kan er een HTTP PUT verzoek verstuurd worden naar de volgende URL:

https://api.copernica.com/v1/miniview/$id?access_token=xxxx

De $id is de ID van de miniview die je aan wilt passen.

Beschikbare parameters

De volgende eigenschappen kunnen toegevoegd worden aan de body van het HTTP verzoek:

  • name: Naam van de miniview/selectie
  • description: Omschrijving van de selectie
  • parent-type: Geeft aan of de huidige selectie onder een andere selectie of een collectie valt.
  • parent-id: ID van de selectie of de collectie waar de selectie onder valt

Voorbeeld

Het volgende voorbeeld demonstreert hoe de methode gebruikt kan worden:

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

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

// data voor de methode
$data = array(
    'description'   =>  'a new description',
);

// voer het verzoek uit en print het resultaat
print_r($api->put("miniview/1234", array(), $data));

Dit voorbeeld vereist de REST API class.

Meer informatie