REST API v4: POST view copy
Methode om een selectie te kopiëren. Dit is een HTTP POST methode naar het volgende adres:
https://api.copernica.com/v4/view/$id/copy
Hier moet de $id
vervangen worden door de ID van de selectie die je
wil kopiëren. Als het verzoek succesvol wordt uitgevoerd geeft de methode
de ID van de nieuwe selectie terug. Het kan even duren voordat de
kopie klaar is.
Beschikbare parameters
Deze methode kan alleen een nieuwe selectie aanmaken. De naam hiervoor is verplicht.
- name: Naam voor de kopie van de selectie. (verplicht)
- options: Array met opties voor het kopiëren. (optioneel)
De 'options' array bevat de optie om onderliggende selecties wel of niet mee te kopiëren:
- views: Een boolean die aangeeft of de onderliggende selecties mee gekopieërd moeten worden.
Voorbeeld in JSON
De volgende JSON demonstreert hoe je de API methode kunt gebruiken:
{
"name": "View_copy",
"options": {
"views": true
}
}
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);
// stel de opties voor de kopie in
$options = array(
'views' => true
);
// data voor de methode
$data = array(
'name' => 'View_copy',
'options' => $options
);
// voer de methode uit
print_r($copyID = $api->post("view/{$viewID}/copy", $data));
// bij een succesvol verzoek wordt de ID van de kopie geretourneerd
Dit voorbeeld vereist de REST API klasse.