Create new bookmark

Description

Creates a new bookmark

Endpoint

/path/bookmark

Method

POST

Access Level Rules

Minimum Access Level

edit+ on parent folder or account holder in root.

Processing Units

Processing units

1

Parameters

NameDescriptionRequiredDefault

name

The name of the new bookmark

true

bookmark

A JSON with properties layers and dems. Layers should be a list of JSONs containing the properties "type", "id" and "selected". Type should be one of "ellipsis", "base" or "external". Selected should be boolean. Id should be the id of the layer or external laye. In case of type "base" you can choose between id=1 (open street map) and id=2 (google satellite map). dems should be a list of JSONs containing the properties "id" and "selected". Selected should be boolean. Id should be the id of the raster layer.

true

thumbnail

A thumbnail image as base64.

false

Default null.

parentId

The id of the parent folder of the new path.

If omitted the new path is placed in your myDrive root.

false

Default null.

publicAccess

Public access object with properties "hidden" and "accessTier" "accessTier" must be between "none" and "edit" and "hidden" must be a boolean.

false

Default {accessTier:"none", hidden:true}.

metadata

A JSON with property "description" with the description of the file.

false

Default null.

Example request:

{
  name: 'test bookmark',
  metadata: { description: 'test description' },
  publicAccess: {hidden:true, accessTier:'view'},
  bookmark: {
    layers: [
      { type: 'ellipsis', id: '78cb1955-2910-4ede-9d21-2c6472d0ba71', selected: true },
      { type: 'base', id: 1, selected: true },
    ],
    dems: [{ id: '085f5e10-63b6-4e8f-a4c6-dce9689100d3', selected: false }],
  },
};

Last updated