Microsoft OneDrive Pipe
Microsoft OneDrive is a file hosting service operated by Microsoft. Use the OneDrive API to retrieve and update files, permissions, and folders.
Getting Started
Prerequisites:
-
- A Microsoft OneDrive account
In order to use Microsoft OneDrive with Tadabase, it is necessary to have a OneDrive account. If you do not have one, you can create an account here.
Install the Microsoft OneDrive Pipe
2. Type 'Microsoft OneDrive' into the search bar and click on the pipe to install.
3. Click the 'Authorize and Install' button.
4. A pop-up window will appear prompting you to sign in to your OneDrive account (if you aren't already signed in). Once you have signed in to your account, the Microsoft OneDrive Pipe will be ready to use.
API Calls
- Get Drives
- Recent Files
- Shared Files
- Get Item
- Create a Folder in Drive
- Update Item
- Delete Item
- Restore Item
- Move Item
- List Items in Drive
- Copy Item
- Create a Sharing Link
- List Permissions
- Send a Sharing Invitation
- Remove Permissions
- Update Permission
- Get Shared Item
- Upload a File
Get Drives
For more details and examples, go to the Microsoft OneDrive API Documentation - Get Drive
Parameters
- No Parameters
Response
- Drive Type
- Drive ID
- Owner ID
- Owner Display Name
- Quota Deleted
- Quota Remaining
- Quota Total
- Quota Used
- Quota State
- Storage Plan Upgrade Information
Recent Files
For more details and examples, go to the Microsoft OneDrive API Documentation - List Recent Files
Parameters
- No Parameters
Response
- Files (array)
Shared Files
For more details and examples, go to the Microsoft OneDrive API Documentation - List Shared Files
Parameters
- No Parameters
Response
Get Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Get Item
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
*Required
Response
- Created Date Time
- Item ID
- Last Modified Date/Time
- Item Name
- Item Size
- Web URL
- Created By App Name
- Created By App ID
- Created By User Display Name
- Created By User ID
- Modified By App Name
- Modified By App ID
- Modified By User Name
- Modified By User ID
- Drive ID
- Drive Type
- Parent Reference ID
- Parent Reference Path
- Folder Child Count
- Folder View Type
- Special Folder Name
Create a Folder in Drive
For more details and examples, go to the Microsoft OneDrive API Documentation - Create a Folder in Drive
Parameters
- Folder Name* - Create a name for the new folder.
*Required
Response
- Folder ID
- Folder Name
- Folder Size
- Last Modified Date/Time
- Web URL
- Created By App Name
- Created By App ID
- Created By User Name
- Created By User ID
- Modified By App Name
- Modified By App ID
- Modified By User Name
- Modified By User ID
- Drive ID
- Drive Type
- Parent Reference ID
- Parent Reference Path
- Folder Child Count
- Folder View Type
A dynamic path may be included (if the folders don't exist they will be generated), but a forward slash '/' must be used (Ex: Documents/Clients/DavidRoss). Note: Folder names cannot include spaces. (The "Search and Replace" pipe can be used to remove spaces and commas from the Name field before triggering the pipe. See image below.)
Update Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Update Item
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- Updated File Name* - Specify the updated name for the file.
*Required
Response
- Item ID
- File Name
- Created Date Time
- Last Modified Date/Time
- Item Size
- Web URL
- Created By App Name
- Created By App ID
- Created By User Display Name
- Created By User ID
- Modified By App Name
- Modified By App ID
- Modified By User Name
- Modified By User ID
- Drive ID
- Drive Type
- Parent Reference ID
- Parent Reference Path
- Folder Child Count
- Folder View Type
- Special Folder Name
Delete Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Delete Item
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
*Required
Response
- Empty Response - If the deletion was successful, you should receive a success message 204.
Restore Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Restore Item
Parameters
- Item ID* - Specify the Item ID (returned from the 'List Items in Drive' API Call) of the item you deleted and would like to restore, or of an item you would like to restore to its previous version.
*Required
Response
- Item ID
- Item Name
Move Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Move Item
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- New Parent Folder ID* - Specify the ID of the folder that you are moving the item to. The 'Folder ID' is returned from the 'Create a Folder in Drive' API Call.
*Required
Response
- Item ID
- Item Name
- Folder ID
- Folder Name
List Items in Drive
For more details and examples, go to the Microsoft OneDrive API Documentation - List Items in Drive
Parameters
- No Parameters
Response
- Items in Drive (array)
Copy Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Copy Item
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- New File Name* - Specify the name for the new copied file.
*Required
Response
- Empty Response - If the copying was successful, you should receive a success message 202.
Create a Sharing Link
For more details and examples, go to the Microsoft OneDrive API Documentation - Create a Sharing Link
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- Type* - Specify the type of sharing link to create. Either view, edit, or embed.
- Scope - Specify the scope of link to create. Either anonymous (anyone with the link has access, without needing to sign in), or organization (anyone signed into your organization can use the link to get access).
Note: Organization-scoped links are not available in OneDrive Personal.
*Required
Response
- Link ID
- Roles (array)
- Share ID
- Expiration Date/Time
- Has Password
- Link Type
- Web URL Link
- Link Application ID
List Permissions
For more details and examples, go to the Microsoft OneDrive API Documentation - List Permissions
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
Response
- Permissions (array)
Send a Sharing Invitation
For more details and examples, go to the Microsoft OneDrive API Documentation - Send a Sharing Invitation
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- Recipient Email* - Indicate the email address of the recipient of the sharing invitation.
- Message - The message that is included in the sharing invitation. Maximum length 2000 characters.
- Require Sign In* - (true or false) Specify whether the recipient of the invitation is required to sign-in to view the shared item.
- Send Invitation* - (true or false) If true, a sharing link is sent to the recipient. Otherwise, a permission is granted directly without sending a notification.
- Permission Roles* - Specify the roles that are to be granted to the recipient of the sharing invitation (read, write).
*Required
Response
- Sharing Invitations (array)
Remove Permissions
For more details and examples, go to the Microsoft OneDrive API Documentation - Remove Permissions
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- Permission ID* - Specify the 'Permission ID' returned from the 'List Permissions' API Call.
*Required
Response
- Empty Response - If the removal was successful, you should receive a success message 204.
Update Permission
For more details and examples, go to the Microsoft OneDrive API Documentation - Update Permission
Parameters
- Item ID* - Specify the Item ID returned from the 'List Items in Drive' API Call.
- Permission ID* - Specify the 'Permission ID' returned from the 'List Permissions' API Call.
- Updated Permission Roles* - Specify the updated roles that are to be granted to the recipients of the sharing invitation (read, write).
- Require Sign In - (true or false) Specify whether the recipient of the invitation is required to sign-in to view the shared item.
- Send Invitation - (true or false) If true, a sharing link is sent to the recipient. Otherwise, a permission is granted directly without sending a notification.
- Message - The message that is included in the sharing invitation. Maximum length 2000 characters.
*Required
Response
- Permissions (array)
- Permission ID
- Roles (array)
- Share ID
- Expiration Date/Time
- Has Password
- Granted To User ID
- Invitation Email
- Invitation Sign In Required
- Invited By User ID
- Link Web URL
Get Shared Item
For more details and examples, go to the Microsoft OneDrive API Documentation - Get Shared Item
Parameters
*Required
Response
Upload a File
For more details and examples, go to the Microsoft OneDrive API Documentation - Upload a File
Parameters
- File* - Specify the Web URL of the file.
- Folder Name* - Indicate the name of the folder you would like to upload the file to.
*Required
Response
- Created Date/Time
- Item ID
- Last Modified Date/Time
- Item Name
- Item Size
- Web URL
- Created By App Name
- Created By App ID
- Created By User Display Name
- Created By User ID
- Modified By App Name
- Modified By App ID
- Modified By User Name
- Modified By User ID
- Drive ID
- Drive Type
- Parent Reference ID
- Parent Reference Path
- Folder Child Count
- Folder View Type
- Special Folder Name
More Details
To learn more about this Pipe and see additional Examples, please see the OneDrive Developer Guide.
We'd love to hear your feedback.