Overview
Configuration is provided for establishing connections with the Dropbox service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Dropbox REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Dropbox. Then click New in the Token File parameter to create a new token file.
Step 3: Provide client_id and client_secret. Then click on the Next button.
Step 4: In the next wizard provide Email. Then press the 'Continue' button.
Step 5: In the next wizard provide Password. Then press the 'Log in' button.
Step 6: In the next wizard click on Conitue.
Step 6: In the next wizard click on Allow.
Step 4: Save the generated access token to the file. Specify token protection password. Click OK.
Step 5. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Dropbox instance.
In this guide, we will show how to read data from the Dropbox service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select Dropbox connection from the combo. Select from the available Dropbox resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Dropbox resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the Dropbox service.
In this guide, we will show how to write data to the Dropbox service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Dropbox connection from the combo. Also, select resource action and Dropbox resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Dropbox resource.
Configuration
Base URL address: https://api.dropboxapi.com/2.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://www.dropbox.com/developers/reference/oauth-guide.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files/list_folder{{=parameters.iterator ? '/continue' : ''}}.
The result is extracted from:{{=response.entries}}.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ cursor: parameters.iterator, path: parameters.get('path') || '' }, parameters)}}
Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder.
-
application/json:
- [Read revision] action
-
Endpoint URL address:
/files/list_revisions.
The result is extracted from:{{=response.entries}}.The following request parameters will be automatically processed:
-
application/json:
{{={ path: parameters.revision, limit: parameters.batchSize } }}
Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-list_revisions.
-
application/json:
- [Read search] action
-
Endpoint URL address:
/files/search.
The result is extracted from:{{=jsonPath(response, 'matches[*].metadata')}}.
The result is paginated.The following request parameters will be automatically processed:
-
application/json:
{{={ query: parameters.search, start: parameters.iterator, max_results: parameters.batchSize } }}
Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-search.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/files/delete.The following request parameters will be automatically processed:
-
application/json:
{{={ id: item.id } }}
Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-delete.
-
application/json:
- id
A key field. Template: ShortText.
- type
Template: Tag.
- name
Template: ShortText.
- path_display
Template: LongText.
- client_modified
Data type: DT_DBTIMESTAMP
- server_modified
Data type: DT_DBTIMESTAMP
- rev
Template: ShortText.
- size
Data type: DT_I4
- sharing_info
Field components:
-
Uses template:
ShortText. - Contains the following components: read_only, parent_shared_folder_id, modified_by.
-
Uses template:
- property_groups
Template: LongText.
- has_explicit_shared_members
Data type: DT_BOOL
Based on resource template Shared Folder Member.
- [Read] action
-
The result is extracted from:{{=response.users}}.
- user
Field components:
-
Uses template:
ShortText. - Contains the following components: account_id, same_team, team_member_id.
-
Uses template:
Based on resource template Shared Folder Member.
- [Read] action
-
The result is extracted from:{{=response.groups}}.
- group
Field components:
-
Uses template:
ShortText. - Contains the following components: group_name, group_id, group_type, is_owner, same_team, member_count.
-
Uses template:
Based on resource template Shared Folder Member.
- [Read] action
-
The result is extracted from:{{=response.invitees}}.
- invitee
The gathered value is processed with
{{=value.email}}expression.
Based on resource template Template Shared Folder.
- [Read] action
-
Endpoint URL address:
/sharing/list_folders{{=parameters.iterator ? '/continue' : ''}}.
The result is extracted from:{{=response.entries}}.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders.
- [Create] action
-
Endpoint URL address:
/sharing/mount_folder.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder.
- [Delete] action
-
Endpoint URL address:
/sharing/unmount_folder.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder.
Based on resource template Template Shared Folder.
- [Read] action
-
Endpoint URL address:
/sharing/list_mountable_folders{{=parameters.iterator ? '/continue' : ''}}.
The result is extracted from:{{=response.entries}}.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sharing/list_shared_links.
The result is extracted from:{{=response.links}}.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_shared_links.
- id
A key field. Template: ShortText.
- type
Template: Tag.
- url
Template: ShortText.
- name
Template: ShortText.
- link_permissions
Field components:
-
Uses template:
Tag. - Contains the following components: can_revoke, resolved_visibility, revoke_failure_reason.
-
Uses template:
- client_modified
Data type: DT_DBTIMESTAMP
- server_modified
Data type: DT_DBTIMESTAMP
- rev
Template: ShortText.
- size
Data type: DT_I4
- path_lower
Template: LongText.
- team_member_info
Field components:
-
Uses template:
ShortText. - Contains the following components: team_info, display_name, member_id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sharing/list_received_files{{=parameters.iterator ? '/continue' : ''}}.
The result is extracted from:{{=response.entries}}.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files.
- policy
Template: FolderPolicy. A read-only field.
- preview_url
Template: ShortText.
- name
Template: ShortText.
- id
A key field. Template: ShortText.
- permissions
Template: LongText.
- owner_team
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- path_display
Template: LongText.
- [Read] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ cursor: parameters.iterator, limit: parameters.batchSize }, parameters)}}
-
application/json:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sharing/list_folder_members{{=parameters.iterator ? '/continue' : ''}}.Documentation: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members.
- access_type
Template: Tag.
- permissions
Template: LongText.
- is_inherited
Data type: DT_BOOL
Based on resource template Base.
- access_type
Template: Tag. A read-only field.
- is_team_folder
Data type: DT_BOOL A read-only field.
- policy
Template: FolderPolicy. A read-only field.
- name
Template: ShortText.
- shared_folder_id
A key field. Template: ShortText.
- time_invited
Data type: DT_DBTIMESTAMP A read-only field.
- path_lower
Template: LongText.
- permissions
Template: LongText. A read-only field.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Tag
Data type: DT_WSTR ( length 255 ) The gathered value is processed with
{{=(value && value['.tag']) || item['.tag']}}expression.- FolderPolicy
Field components:
-
Uses template:
Tag. - Contains the following components: acl_update_policy, shared_link_policy, member_policy, resolved_member_policy.
-
Uses template:
Related scripts
What's New
- New: Support for short-lived authentication tokens.
- Fixed: Failed to retrieve files from the root folder.
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.