Dropbox

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

CopyResource action

This action lets you copy a file or folder to a different location in the user's Dropbox.

Input parameters of the CopyResource action

For example on how to configure the CopyResource action, see Action examples.

CreateFolder action

This action lets you create a folder at a given path.

Input parameters of the CreateFolder action

For example on how to configure the CreateFolder action, see Action examples.

DeleteResource action

This action lets you delete the file or folder at a given path. If the path is a folder, all its contents will be deleted too.

Input parameters of the DeleteResource action

For example on how to configure the DeleteResource action, see Action examples.

MoveResource action

Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved. Note that we do not currently support case-only renaming.

Input parameters of the MoveResource action

For example on how to configure the MoveResource action, see Action examples.

RenameResource action

This action lets you rename a resource by providing a path and new name.

Input parameters of the RenameResource action

For example on how to configure the RenameResource action, see Action examples.

UnshareFolder action

This action lets you Unshares a folder. Requires the sharing.write scope.

Input parameters of the UnshareFolder action

For example on how to configure the UnshareFolder action, see Action examples.

DownloadFile action

This action lets you Downloads a File. Requires the files.content.read scope.

Input parameters of the DownloadFile action

For example on how to configure the DownloadFile action, see Action examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Copy a resource

The following example shows how to copy a resource with specified path to a different path:

1. In the Configure connector task dialog, click Actions.
2. Select the CopyResource action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "From_Path": "/DropboxFolder/pptxFile.pptx",
     "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx"
   }

If the action is successful, the CopyResource task's connectorOutputPayload response parameter will have a value similar to the following:

[ { "Success": "true", "metadata_.tag": "file", 
  "metadata_name": "pptxFile.pptx", 
  "metadata_path_lower": "/testingdropboxupdated/abcde/pptxfile.pptx", 
  "metadata_path_display": "/TestingDropBoxUpdated/abcde/pptxFile.pptx", 
  "metadata_parent_shared_folder_id": "3204685267", "metadata_id": "id:8-07A6kHAoIAAAAAAAAC1w",
  "metadata_client_modified": "2024-06-13T11:06:37Z", "metadata_server_modified": "2024-07-12T10:19:02Z",
  "metadata_rev": "61d0a3560ecb5bf039dd3", "metadata_size": "17052", 
  "metadata_sharing_info_read_only": "false", "metadata_sharing_info_parent_shared_folder_id": "3204685267",
  "metadata_sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A", 
  "metadata_is_downloadable": "true", 
  "metadata_content_hash": "0234f7d4eaf914cb276716c8b2a24e24655d1f6f39ee549207e33a4255e2fba2" } ]

Example - Create a folder

The following example shows how to create a folder at a given path:

1. In the Configure connector task dialog, click Actions.
2. Select the CreateFolder action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Path": "/TestDrobBoxFolder/newFolder"
   }

If the action is successful, the CreateFolder task's connectorOutputPayload response parameter will have a value similar to the following:

[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]

Example - Delete a resource

The following example shows how to delete a resource:

1. In the Configure connector task dialog, click Actions.
2. Select the DeleteResource action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Path": "/TestingDropBox/FolderToBeDeletedName"
   }

If the action is successful, the DeleteResource task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Move a resource

The following example shows how to move a resource:

1. In the Configure connector task dialog, click Actions.
2. Select the MoveResource action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf",
     "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf"
   }

If the action is successful, the MoveResource task's connectorOutputPayload response parameter will have a value similar to the following:

[{
  "Status": "Success"
  }]

Example - Rename a resource

The following example shows how to rename a resource:

1. In the Configure connector task dialog, click Actions.
2. Select the RenameResource action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Path": "/TestDropBox/abcd",
     "NewName": "abcded"
   }

If the action is successful, the RenameResource task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Unshare a folder

The following example shows how to unshare a folder:

1. In the Configure connector task dialog, click Actions.
2. Select the UnshareFolder action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "FolderId": "3336772979"
   }

If the action is successful, the UnshareFolder task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Status": "Success"
}]

Example - Download a file

The following example shows how to download a file:

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadFile action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Id": "id:8-07A6kHAoIAAAAAAAABcg",
     "FileType": "file"
   }

If the action is successful, the DownloadFile task's connectorOutputPayload response parameter will have a value similar to the following:

[ { "Success": "true", "Name": "license.txt", 
  "Id": "id:8-07A6kHAoIAAAAAAAABcg", "ClientModified": "2024-07-09T09:52:41Z", 
  "ServerModified": "2024-07-09T09:52:41Z", "Revision": "61ccd7da2b987c0f52053", "Size": "11", 
  "LowerCasePath": "/sahil kapoor/testingdropboxupdated/uploadfolderwithnestedfolder/nestedfolder2/license.txt",
   "DisplayPath": "/Sahil Kapoor/TestingDropBoxUpdated/uploadFolderWithNestedFolder/NestedFolder2/license.txt",
    "PreviewURL": null, "IsDownloadable": "true", "HasExplicitSharedMembers": null, 
  "ContentHash": "f6dc724d119649460e47ce719139e521e082be8a9755c5bece181de046ee65fe", "Owner": null,
  "Title": null, "MimeType": null, "FileData": "SGVsbG8gd29ybGQ=", "parent_shared_folder_id": "3237290067",
  "sharing_info_read_only": "false", "sharing_info_parent_shared_folder_id": "3237290067", 
  "sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A" } ]