Cmdlets for Dropbox

Build 24.0.9060

Files

Returns files from a user's account.

Table Specific Information

The following scopes are required to access this view: files.metadata.read

Select

The cmdlet uses the Dropbox API to process search criteria that refer to the Id, FilePath, or ParentId columns. The cmdlet processes other filters client-side within the cmdlet. For example, the following queries are processed server side.

SELECT * FROM Files WHERE Id = 'id:a4ayc_80_OEAAAAAAAAAYa'

SELECT * FROM Files WHERE ParentId = 'id:a4aad_40_OEACHSBDLKAYa'

SELECT * FROM Files WHERE FilePath = '/TestFolder/test.png'

Note that the FilePath filter will only return data for one specific file, since the FilePath is an absolute path. If you want to get data for all the files underneath a specified folder path, filter using ParentId. ParentId is a unique identifier for the containing folder. You can only retrieve the files that are located directly in this folder, not in its subfolders.

Delete

The cmdlet uses the Dropbox API to process search criteria that refer to the Id column in order to perform a DELETE operation on a file. For example, the following queries are processed server side:

DELETE FROM Files WHERE Id = 'id:a4aad_40_OEACHSBDLKAYa'

DELETE FROM Files WHERE Id IN ('id:a4aad_40_OEACHSBDLKAYa', 'id:a4aad_40_OEACHSB3234234')

Columns

Name Type ReadOnly Description
Id [KEY] String True

A unique identifier for the file.

Name String True

The name of the file (including extension).

ClientModified Datetime True

The modification time set by the desktop client when the file was added to Dropbox.

ServerModified Datetime True

The last time the file was modified on Dropbox.

Revision String True

A unique identifier for the current revision of a file.

Size Long True

The file size in bytes.

DisplayPath String True

The cased path to be used for display purposes only.

SymlinkInfoTarget String True

Set if this file is a symlink.

HasExplicitSharedMembers Boolean True

If this flag is present, it will be true if this file has any explicit shared members.

ContentHash String True

A hash of the file content.

ReadOnly Boolean True

True if the file is inside a read-only shared folder.

ParentSharedFolderId String True

ID of shared folder that holds this file.

ModifiedBy String True

The last user who modified the file.

ParentId String True

A unique identifier for the containing folder. Set this in the filter to retreive only files under the specified parent folder.

FilePath String True

The absolute file path used for retrieving a specific file. Set this in the filter to retrieve data for the exact file which has this path.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060