Dropbox

1. Overview

Dropbox is a leading cloud storage service that offers file synchronization, personal cloud, and client software. It allows users to store files on remote servers and access them from various devices.

The GoInsight Dropbox node enables you to seamlessly integrate file and folder management into your automated workflows. It provides a comprehensive set of operations to interact with your Dropbox account, including:

• Folder Management: Create new folders at specific locations within your Dropbox.
• Content Listing: List the contents of any folder, with options for recursive searches and including deleted items.
• File and Folder Operations: Perform essential management tasks such as copying, moving, and deleting items in batches.
• Querying: Search for files within a specified folder.

2. Prerequisites

Before using this node, you need to have a valid Dropbox account. Depending on the operations you wish to perform, you may also need appropriate permissions for the files and folders you intend to access or modify.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

This node provides operations centered around managing folders and the items (files and folders) within them.

Summary

Operation Details

Create Folder

Creates a new folder in Dropbox at the specified path. If the folder already exists, an error will be returned.

Input Parameters:

• Path: The path of the folder to create. Must start with "/".

Output:

• Created (bool): A boolean value indicating whether the folder was successfully created (true) or not (false).
• FolderId (string): A unique identifier (string) assigned to the newly created folder in Dropbox.
• StatusCode (number): HTTP status code indicating the result of the operation.
• ErrorMessage (string): Error message if the operation failed.

Delete Item

Deletes one or more files or folders.

Input Parameters:

• DeleteItems: The path(s) of the files/folders to delete. For multiple items, separate each path with a new line.

Output:

• AllDeleted (bool): Indicates whether all specified items were successfully deleted (true) or if any failed (false).
• FailedItems (object-array): A list of items that could not be deleted.
• StatusCode (number): HTTP status code indicating the result of the operation.
• ErrorMessage (string): Error message if the operation failed.

List a Folder

Lists the contents of a Dropbox folder, optionally recursively, and returns file/folder metadata.

Input Parameters:

• Path: The path of the folder to list. The root directory is an empty string (""), otherwise, it must start with "/".

Optional Parameters:

• Recursive: Whether to list the contents of all subfolders recursively. Defaults to false.
• IncludeDeleted: Whether the results will include entries for files and folders that were deleted. Defaults to false.
• IncludeHasExplicitSharedMembers: Whether the results will include a flag for each file indicating if it has explicit members. Defaults to false.
• IncludeMountedFolders: Whether to include entries under mounted folders (app, shared, team folders). Defaults to true.
• IncludeNonDownloadableFiles: Whether to include files that are not downloadable (e.g., Google Docs). Defaults to true.
• Limit: The maximum number of results to return in a single call (1-2000). Defaults to 1000.

Output:

• Entries (object-array): An array of metadata entries representing the contents of the folder.
• Cursor (string): A pagination token used to fetch the next batch of entries.
• HasMore (bool): Indicates whether the folder contains more entries beyond the current response.
• StatusCode (number): HTTP status code for the request.
• ErrorMessage (string): Error message if the operation failed.

Copy Item

Copies one or more files or folders to a new location.

Input Parameters:

• FromItems: The source path(s) of the files/folders to copy. For multiple items, separate each path with a new line.
• ToItem: The destination folder path where the items will be copied.

Output:

• AllCopied (bool): Indicates whether all specified items were successfully copied.
• FailedItems (object-array): A list of items that failed to copy.
• StatusCode (number): HTTP status code for the request.
• ErrorMessage (string): General error message if the request failed.

Move Item

Moves one or more files or folders to a new location.

Input Parameters:

• FromItems: The source path(s) of the files/folders to move. For multiple items, separate each path with a new line.
• ToItem: The destination folder path where the items will be moved.

Output:

• AllMoved (bool): Indicates whether all specified items were successfully moved.
• FailedItems (object-array): A list of items that failed to move.
• StatusCode (number): HTTP status code for the request.
• ErrorMessage (string): General error message if the request failed.

Query

Queries for all files within a specified folder.

Input Parameters:

• FolderItem: The path of the folder to query.

Output:

• QueryResult (string): The results of the search query.
• StatusCode (number): HTTP status code for the request.
• ErrorMessage (string): General error message if the request failed.

5. Example Usage

This section will guide you through creating a simple workflow to create a new folder in your Dropbox account.

The workflow will consist of three nodes: Start -> Dropbox: Create Folder -> Answer.

1. Add the Dropbox Node

• On the workflow canvas, click the "+" icon to add a new node.
• In the panel that appears, select the "Tools" tab.
• Find and select "Dropbox" from the list of tools.
• From the list of supported operations for Dropbox, click on "Create Folder" to add the node to your canvas.

2. Configure the Node

• Click on the newly added "Create Folder" node to open its configuration panel on the right.
• Credentials: In the "Credentials" field, click the dropdown menu and select your pre-configured Dropbox credential.
• Parameters: Fill in the required input parameters for the operation.
  • Path: Enter the full path for the new folder you want to create. The path must start with a forward slash (/). For this example, enter /My Automated Reports.

3. Run and Validate

• Once all required parameters are correctly filled, any error indicators on the workflow canvas should disappear.
• Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
• After a successful execution, you can click the logs icon (also in the top-right) to view the detailed inputs and outputs of the node. You should see the FolderId in the output, confirming that the folder was created. You can also check your Dropbox account to see the new "My Automated Reports" folder.

After completing these steps, your workflow is fully configured. When run, it will automatically create the specified folder in your Dropbox account.

6. FAQs

Q: My "Create Folder" operation failed with a conflict error. Why?

A: This typically means a folder or file with the same name already exists at the specified path. Dropbox paths are unique, and you cannot have two items with the same name in the same location. Please choose a different name or path.

Q: What is the correct format for the Path parameter in operations like "Create Folder" or "List a Folder"?

A: All paths must be absolute and start with a forward slash (/), representing the root of your Dropbox. For example, /Apps/MyData is a valid path. The only exception is the Path parameter for "List a Folder," which can be an empty string ("") to list the contents of the root directory itself.

Q: How do I use the "Delete Item" or "Move Item" operations for multiple files at once?

A: The DeleteItems, FromItems, and MoveItems input fields are designed to handle multiple paths. You should enter one full path per line. For example:

/folder1/file_a.txt
/folder2/file_b.jpg
/archive/old_report.docx

7. Official Documentation

For more in-depth information about the Dropbox API and its capabilities, please refer to the official developer documentation:

Dropbox API Documentation