Overview
Configuration is provided for establishing connections with the OneDrive 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
Configuration
Base URL address: https://api.onedrive.com/v1.0.
-
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://dev.onedrive.com/auth/msa_oauth.htm#code-flow.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/drives.The following request parameters will be automatically processed:
-
top:
Documentation: https://dev.onedrive.com/drives/list-drives.htm.
-
top:
- id
A key field. Template: ShortText.
- driveType
Template: ShortText.
- owner
Template: IdentitySet.
- quota
Field components:
-
Uses template:
ShortText. - Contains the following components: total, used, remaining, deleted, state.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.path}}/children.
- [Read shared] action
-
Endpoint URL address:
/drive/shared.Documentation: https://dev.onedrive.com/drives/shared_by_me.htm.
- [Read recent] action
-
Endpoint URL address:
/drive/view.recent.Documentation: https://dev.onedrive.com/drives/recent_files.htm.
- [Read delta] action
-
Endpoint URL address:
{{=parameters.delta}}/view.delta.
The result is paginated.The action has the following user-defined parameters:
- delta: Required. Specify delta.
The following request parameters will be automatically processed:
-
@delta.token:
{{=parameters.iterator}}
Documentation: https://dev.onedrive.com/resources/viewDeltaResource.htm.
- [Read search] action
-
Endpoint URL address:
{{=parameters.path}}/view.search.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "q").
The following request parameters will be automatically processed:
-
q:
{{=parameters.search}}
Documentation: https://dev.onedrive.com/items/search.htm.
- [Create] action
-
Endpoint URL address:
{{=item.path}}.
- [Update] action
-
Endpoint URL address:
{{=item.path}}.Documentation: https://dev.onedrive.com/items/update.htm.
- [Delete] action
-
Endpoint URL address:
{{=item.path}}.Documentation: https://dev.onedrive.com/items/delete.htm.
- id
A key field. Template: ShortText.
- audio
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: album, albumArtist, artist, bitrate, composers, copyright, disc, discCount, duration, genre, hasDrm, isVariableBitrate, title, track, trackCount, year.
-
Uses template:
- createdBy
Template: IdentitySet. A read-only field.
- createdDateTime
Data type: DT_DBTIMESTAMP A read-only field.
- cTag
Template: ShortText. A read-only field.
- deleted.state
Template: ShortText. A read-only field.
- description
Template: LongText.
- eTag
Template: ShortText. A read-only field.
- file
Template: File. A read-only field.
- fileSystemInfo
Template: FileSystemInfo.
- folder
Field components:
- Contains the following components: childCount.
- image
A read-only field. Field components:
- Contains the following components: width, height.
- lastModifiedBy
Template: IdentitySet. A read-only field.
- lastModifiedDateTime
Data type: DT_DBTIMESTAMP A read-only field.
- location
A read-only field. Field components:
- Contains the following components: altitude, latitude, longitude.
- name
Template: LongText.
- package.type
Template: ShortText.
- parentReference
Template: ItemReference.
- photo
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: takenDateTime, cameraMake, cameraModel, fNumber, exposureDenominator, exposureNumerator, focalLength, iso.
-
Uses template:
- remoteItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, parentReference, folder.childCount, file, fileSystemInfo, size, name.
-
Uses template:
- searchResult.onClickTelemetryUrl
Template: LongText.
- shared
Field components:
-
Uses template:
IdentitySet. - Contains the following components: owner, scope.
-
Uses template:
- sharepointIds
Field components:
-
Uses template:
ShortText. - Contains the following components: siteId, webId, listId, listItemId, listItemUniqueId.
-
Uses template:
- size
Data type: DT_I8
- specialFolder.name
Template: ShortText.
- video
Field components:
- Contains the following components: bitrate, duration, height, width.
- webDavUrl
Template: LongText.
- webUrl
Template: LongText.
- content
Data type: DT_IMAGE The value is gathered from
{{? item.remoteItem}}{{='/drive/items/' + item.remoteItem.id + '/content'}}{{?? item.file}}{{='/drive/items/' + item.id + '/content'}}{{?}}address. The value is sent to{{=item.path}}:/contentaddress.- path
Template: ShortText. The gathered value is processed with
{{=item.parentReference.path + '/' + item.name}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.path}}/subscriptions.Documentation: https://dev.onedrive.com/webhooks/list-subscriptions.htm.
- [Create] action
-
Endpoint URL address:
{{=item.resource}}/subscriptions.Documentation: https://dev.onedrive.com/webhooks/create-subscription.htm.
- [Update] action
-
Endpoint URL address:
{{=item.resource}}/subscriptions/{{=item.id}}.Documentation: https://dev.onedrive.com/webhooks/update-subscription.htm.
- [Delete] action
-
Endpoint URL address:
{{=item.resource}}/subscriptions/{{=item.id}}.Documentation: https://dev.onedrive.com/webhooks/delete-subscription.htm.
- id
A key field. Template: ShortText.
- resource
Template: ShortText. A read-only field.
- notificationUrl
Template: LongText.
- clientState
Template: ShortText.
- createdBy
Template: IdentitySet. A read-only field.
- expirationDateTime
Data type: DT_DBTIMESTAMP
- scenarios
Data type: DT_WSTR ( length 4000 ) A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=parameters.path}}/permissions.Documentation: https://dev.onedrive.com/items/permissions.htm.
- id
A key field. Template: ShortText.
- role
Template: ShortText.
- link
-
Field components:
-
Uses template:
Identity. - Contains the following components: application, type, scope, webHtml, webUrl.
Documentation: https://dev.onedrive.com/facets/sharinglink_facet.htm.
-
Uses template:
- grantedTo
Template: IdentitySet.
- invitation
-
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: email, signInRequired, invitedBy.
Documentation: https://dev.onedrive.com/facets/invitation_facet.htm.
-
Uses template:
- inheritedFrom
Template: ItemReference.
- shareId
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.value}}.
The result is paginated.The action has the following user-defined parameters:
- path: Required. Specify remote path.
The following request parameters will be automatically processed:
-
select:
{{=_.filter(parameters.fields, function(item) { return item.indexOf('.') == -1; })}} -
$skiptoken:
{{=parameters.iterator}} -
top:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Identity
-
Field components:
-
Uses template:
ShortText. - Contains the following components: id, displayName, thumbnails.
Documentation: https://dev.onedrive.com/resources/identity.htm.
-
Uses template:
- IdentitySet
-
Field components:
-
Uses template:
Identity. - Contains the following components: user, application, device, organization.
Documentation: https://dev.onedrive.com/resources/identitySet.htm.
-
Uses template:
- ItemReference
-
Field components:
-
Uses template:
ShortText. - Contains the following components: driveId, id, path.
Documentation: https://dev.onedrive.com/resources/itemReference.htm.
-
Uses template:
- File
Field components:
-
Uses template:
ShortText. - Contains the following components: mimeType, hashes.
-
Uses template:
- FileSystemInfo
Field components:
- Contains the following components: createdDateTime, lastModifiedDateTime.
- Thumbnail
Field components:
-
Uses template:
LongText. - Contains the following components: width, height, url.
-
Uses template:
What's New
- Fixed: Failed to process folder or file containing space in name.
- 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.