The Dropbox Connector can be configured using the Rest API. It requires the following entities to be created:

Credential
Connection
Connector
Seed

Below are the examples of how to create the Connection and the Seed. For the Connector, please refer to this page.

Easy Heading Free

navigationTitle	On this Page
wrapNavigationText	true
navigationExpandOption	expand-all-by-default

Create Credential

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "dropbox".	"dropbox"
description	Yes	-	No	Name of the credential object.	"DropboxCredential"
properties	Yes	-	No	Configuration object
Application Identifier	Yes	-	No	Dropbox's application name	"myTestBusinessApp"
Access Token	Yes	-	No	Access token for Dropbox application	"encrypted:Y78DI9DBAFJ8..."

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "dropbox",
    "description": "dropbox Credential",
    "properties": {   
		"applicationIdentifier": "myTestBusinessApp",
		"accessToken": "encrypted:8DBAY7I9DFJ4..."     
	}
}

Create Connection

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "dropbox"	"dropbox"
description	Yes	-	No	Name of the connection object.	"MyDropboxConnection"
credential	Yes	-	No	ID of the credential.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this connection will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
properties	Yes	-	No	Configuration object
Max Retries	Yes	-	No	Maximum retries permitted per document.	5
Page Size	No	-	No	The response page size	500
Ignore Dropbox Files	No	-	No	Ignore files that are created by default in a Dropbox account (does not include those files in the crawl process).	true

Example

Code Block

theme	RDark
title	POST aspire/_api/connections

{
    "type": "dropbox",
    "description": "Dropbox Test Connector",     
	"properties": {
    "maxRetries": "5",
	"pageSize": "500",
	"ignoreDropboxFiles": "true"
	} 
}

Update Connection

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the connection to update	"89d6632a-a296-426c-adb0-d442adcab4b0",
description	No	-	No	Name of the connection object.	"My dropbox Connection"
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this connection will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
properties	Yes	-	No	Configuration object
Max Retries	Yes	-	No	Maximum retries permitted per document.	5
Page Size	No	-	No	The response page size	500
Ignore Dropbox Files	No	-	No	Ignore files that are created by default in a Dropbox account (does not include those files in the crawl process).	false

Example

Code Block

theme	RDark

{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
    "description": "dropbox Test Connector",     
	"properties": {
    "maxRetries": "5",
	"pageSize": "500",
	"ignoreDropboxFiles": "false"
	}
 }

Create Connector Instance

For the creation of the Connector object using the Rest API, refer to this page

Update Connector Instance

For the update of the Connector object using the Rest API, refer to this page

Create Seed

Field	Required	Default	Multiple	Notes	Example
seed	Yes	-	No	<seed description>	"dropbox_seed"
type	Yes	-	No	The value must be Dropbox.	dropbox
description	Yes	-	No	Name of the seed object.	"My Dropbox Seed"
connector	Yes	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	Yes	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag2"]
properties	Yes	-	No	Configuration object
seed	Yes	-	No	ID of the seed to crawl.	seed
Crawl Team Members	No	-	No	Option to crawl all content in Team Members.	true
Crawl Share Folders	No	-	No	Option to crawl all content in Share Folders.	true
Crawl Team Folders	No	-	No	Option to crawl all content in Team Folders.	true

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

{
    "type": "dropbox",
    "seed": "directory",
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "description": "dropbox_Test_Seed",
    "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
    "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag1", "tag2"],
    "properties": {         
		"seed": "dropbox_seed",
	 	"crawlTeamMembers": "true",
		"crawlSharedFolder": "true",
		"crawlTeamFolder": "true"     
	}
}

Update Seed

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the seed to update.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
seed	No	-	No	<seed description>
description	No	-	No	Name of the seed object.	"MyDropboxSeed"
connector	No	-	No	The ID of the connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection	No	-	No	The ID of the connection to be used with this seed. The connection type must match the seed type.	"602d3700-28dd-4a6a-8b51-e4a663fe9ee6"
workflows	No	[ ]	Yes	The IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.add	No	[ ]	Yes	The IDs of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove	No	[ ]	Yes	The IDs of the workflows to remove.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
throttlePolicy	No	-	No	ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"
routingPolicies	No	[ ]	Yes	The IDs of the routing policies that this seed will use.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.add	No	[ ]	Yes	The IDs of the routingPolicies to add.	["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.remove	No	[ ]	Yes	The IDs of the routingPolicies to remove.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag3"]
tags.add	No	[ ]	Yes	The tags to add	["tag4"]
tags.remove	No	[ ]	Yes	The tags to remove	["tag2"]
properties	Yes	-	No	Configuration object
seed	Yes	-	No	ID of the seed to crawl.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
Crawl Team Members	No	-	No	Option to crawl all content in Team Members.	true
Crawl Share Folders	No	-	No	Option to crawl all content in Share Folders.	true
Crawl Team Folders	No	-	No	Option to crawl all content in Team Folders.	true

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
    "id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
    "seed": "dropbox_seed",
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "description": "dropbox_Test_Seed",
    "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
    "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag", "tag2"],
    "properties": {         
		"seed": "dropbox_seed",
 		"crawlTeamMembers": "true",
		"crawlSharedFolder": "true",
		"crawlTeamFolder": "true"        
	}
}

Page tree

Versions Compared

Old Version 15

New Version Current

Key

Create Credential

Create Connection

Update Connection

Create Connector Instance

Update Connector Instance

Create Seed

Update Seed

Page tree

Page History

Versions Compared

Old Version 15

New Version Current

Key

Create Credential

Create Connection

Update Connection

Create Connector Instance

Update Connector Instance

Create Seed

Update Seed