FolderDetails

Full details of a given folder.

Structure

{
  "folderPath": String,
  "settings": FolderSettings,
  "settingsInherited": FolderSettingsInherited,
  "type": String,
  "virtual": Boolean
}

Example

{
  "folderPath": "/uploads",
  "settings": {},
  "settingsInherited": {
    "publicPermissions": {
      "folderPath": "/",
      "value": [
        {
          "scope": "Children",
          "permissions": {
            "file": {
              "downloadFile": [
                "*"
              ]
            }
          }
        }
      ]
    },
    "storageLayer": {
      "folderPath": "/",
      "value": {
        "type": "InternalStorageV2"
      }
    }
  },
  "type": "Folder",
  "virtual": true
}

Properties

folderPath Required

This folder's path. Always begins with a /.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

settings Required

The folder's settings, including its description, public download permissions, and storage layer.

Type: FolderSettings

settingsInherited Required

The FolderSettings inheritable from the folder's ancestors.

If both the settings field and the settingsInherited field define the same setting (e.g. the storageLayer setting) then the value from the settings field is used for the current folder and its descendants.

Type: FolderSettingsInherited

type Required

Indicates this item is a folder (as opposed to a file).

Type: String

Value: "Folder"

virtual Required

If true then the folder was created using the PutFolder operation.

If false then the folder was created automatically as the result of a file upload operation, and will disappear if/when the folder later becomes empty.

Type: Boolean

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

FolderDetails

Structure

Example

Properties

folderPath Required

settings Required

settingsInherited Required

type Required

virtual Required

Used by

You are using an outdated browser.