Path

favorite

ellipsis.path.favorite()

Add path to favorites.

Mandatory arguments

  • pathId (uuid)

  • token (string)

unfavorite

ellipsis.path.unfavorite()

Remove path from favorites.

Mandatory arguments

  • pathId (uuid)

  • token (string)

editPublicAccess

ellipsis.path.editPublicAccess()

Update the public access of a path.

Mandatory arguments

  • pathId (uuid)

  • token (string)

  • recursive (boolean) If true access will be set to all children recursively (only applicable in case of a folder).

Optional arguments

  • access (dictionary, with key accessLevel of type int)

  • hidden (boolean)

editMetadata

ellipsis.path.editMetadata()

Update the metadata of a path.

Mandatory arguments

  • pathId (uuid)

  • token (string)

Optional arguments

  • attribution (string)

  • description (string)

  • licenseString (string)

  • properties (object)

get

ellipsis.path.get()

Retrieves a path.

Mandatory arguments

  • pathId (uuid)

Optional arguments

  • token (string)

move

ellipsis.path.move()

Moves paths to a different folder.

Mandatory arguments

  • pathIds (array of uuids)

Optional arguments

  • token (string)

  • parentId (uuid)

rename

ellipsis.path.rename()

Rename a path.

Mandatory arguments

  • pathId (uuid)

Optional arguments

  • token (string)

  • name (string)

trash

ellipsis.path.trash()

Place path in trash.

Mandatory arguments

  • pathId (uuid)

Optional arguments

  • token (string)

delete

ellipsis.path.delete()

Delete a path.

Mandatory arguments

  • pathId (uuid)

Optional arguments

  • recursive (boolean)

  • token (string)

recover

ellipsis.path.recover()

Recover a path.

Mandatory arguments

  • pathId (uuid)

Optional arguments

  • token (string)

setDomains

ellipsis.path.setDomains()

Set a white list of domains. Only apps of the given domains are allowed to use your layer

Mandatory arguments

  • pathId (uuid)

  • domains (Array of strings, that is the white list of domains)