REST API: PUT miniview

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

A miniview is for a collection what a selection is on a database. To edit a miniview an HTTP PUT request can be sent to the following URL:$id?access_token=xxxx

The $id is the ID of the miniview you want to edit.

Available data

The following properties can be added to the message body of the HTTP request:

  • name: Name of the selection
  • description: Description of the selection
  • parent-type: Indicates whether the current selection belongs to another selection or a collection.
  • parent-id: ID of the selection or the collection the selection belongs to

PHP example

The following example demonstrates how to use this method:

// dependencies

// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// declare the id of the selection that you want to edit
$id = 1;

// data to be sent to the api
$data = array(
    'description'   =>  'a new description',

// do the call, and print result
print_r($api->put("miniview/{$id}", $data));

The example above requires the CopernicaRestApi class.

More information