REST API v4: POST database collections

Om een collectie (een tweede laag dus) aan een database toe te voegen, kun je een HTTP POST-request sturen naar het volgende adres:

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

De code $id moet je vervangen door de numerieke identifier of de naam van de database waar je de collectie aan wilt toevoegen. De naam van de collectie moet als message body aan het HTTP-request worden toegevoegd.

Beschikbare parameters

De volgende variabelen kunnen in de body van de HTTP POST call worden geplaatst.

  • name: naam van de nieuw aan te maken collectie
  • description: beschrijving van de nieuw aan te maken colelctie

Voorbeeld in JSON

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

{
  "name": "mijn_collectie",
  "description": "voorbeeld collectie"
}

Voorbeeld in PHP

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

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

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

// data om mee te geven aan de methode
$data = array(
    'name'          => 'example-collection',
    'description'   => 'This is a example collection'
);

// voer het verzoek uit
$api->post("database/{$databaseID}/collections", $data);

// bij een succesvolle call wordt het id van het aangemaakte verzoek teruggegeven

Dit voorbeeld vereist de REST API-klasse.

Meer informatie