← Microsoft OneDrive

Download File with Microsoft OneDrive API

Pipedream makes it easy to connect APIs for Microsoft OneDrive and 1400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Download File with the Microsoft OneDrive API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to Download File with the Microsoft OneDrive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Download File action
    1. Connect your Microsoft OneDrive account
    2. Optional- Select a File ID
    3. Optional- Configure File Path
    4. Configure New File Name
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Download File with Microsoft OneDrive API on New Requests from HTTP / Webhook API
HTTP / Webhook + Microsoft OneDrive
 
Try it
Download File with Microsoft OneDrive API on New Submission from Typeform API
Typeform + Microsoft OneDrive
 
Try it
Download File with Microsoft OneDrive API on New Submission (Instant) from Jotform API
Jotform + Microsoft OneDrive
 
Try it
Download File with Microsoft OneDrive API on New Custom Webhook Events from Stripe API
Stripe + Microsoft OneDrive
 
Try it
Download File with Microsoft OneDrive API on New Scheduled Tasks from Pipedream API
Pipedream + Microsoft OneDrive
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Download File on Microsoft OneDrive
Description:Download a file stored in OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get_content?view=odsp-graph-online)
Version:0.0.3
Key:microsoft_onedrive-download-file

Code

import fs from "fs";
import stream from "stream";
import util from "util";
import onedrive from "../../microsoft_onedrive.app.mjs";
import httpRequest from "../../common/httpRequest.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Download File",
  description: "Download a file stored in OneDrive. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_get_content?view=odsp-graph-online)",
  key: "microsoft_onedrive-download-file",
  version: "0.0.3",
  type: "action",
  props: {
    onedrive,
    fileId: {
      type: "string",
      label: "File ID",
      description: "The file to download. You can either search for the file here, provide a custom *File ID*, or use the `File Path` prop to specify the path directly.",
      optional: true,
      useQuery: true,
      async options(context) {
        const { query } = context;
        if (!query) return [];
        const response = await this.httpRequest({
          $: context,
          url: `/search(q='${query}')?select=folder,name,id`,
        });
        return response.value
          .filter(({ folder }) => !folder)
          .map(({
            name, id,
          }) => ({
            label: name,
            value: id,
          }));
      },
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The path to the file from the root folder, e.g., `Documents/My Subfolder/File 1.docx`. You can either provide this, or search for an existing file with the `File ID` prop.",
      optional: true,
    },
    newFileName: {
      type: "string",
      label: "New File Name",
      description: "The file name to save the downloaded content as, under the `/tmp` folder.",
    },
  },
  methods: {
    httpRequest,
  },
  async run({ $ }) {
    const {
      fileId, filePath, newFileName,
    } = this;

    if (!fileId && !filePath) {
      throw new ConfigurationError("You must specify either **File ID** or **File Path**.");
    }

    const url = fileId
      ? `items/${fileId}/content`
      : `/root:/${encodeURI(filePath)}:/content`;
    const response = await this.httpRequest({
      $,
      url,
      responseType: "stream",
    });

    const fileName = newFileName.split("/").pop();
    const tmpFilePath = `/tmp/${fileName}`;

    const pipeline = util.promisify(stream.pipeline);
    await pipeline(response, fs.createWriteStream(tmpFilePath));

    $.export("$summary", `Returned file contents and saved to \`${tmpFilePath}\`.`);
    return tmpFilePath;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Microsoft OneDriveonedriveappThis component uses the Microsoft OneDrive app.
File IDfileIdstringSelect a value from the drop down menu.
File PathfilePathstring

The path to the file from the root folder, e.g., Documents/My Subfolder/File 1.docx. You can either provide this, or search for an existing file with the File ID prop.

New File NamenewFileNamestring

The file name to save the downloaded content as, under the /tmp folder.

Authentication

Microsoft OneDrive uses OAuth authentication. When you connect your Microsoft OneDrive account, Pipedream will open a popup window where you can sign into Microsoft OneDrive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft OneDrive API.

Pipedream requests the following authorization scopes when you connect your account:

User.Reademailoffline_accessopenidprofileFiles.ReadFiles.Read.AllFiles.ReadWrite

About Microsoft OneDrive

Personal cloud storage

More Ways to Use Microsoft OneDrive

Triggers

New File (Instant) from the Microsoft OneDrive API

Emit new event when a new file is added to a specific drive in OneDrive

 
Try it
New File in Folder (Instant) from the Microsoft OneDrive API

Emit an event when a new file is added to a specific directory tree in a OneDrive drive

 
Try it
New File of Types in Folder (Instant) from the Microsoft OneDrive API

Emit an event when a new file of a specific type is created under a directory tree in a OneDrive drive

 
Try it
New Folder (Instant) from the Microsoft OneDrive API

Emit new event when a new folder is created in a OneDrive drive

 
Try it
New Folder in Folder (Instant) from the Microsoft OneDrive API

Emit an event when a new folder is created under a directory tree in a OneDrive drive

 
Try it

Actions

Get Table with the Microsoft OneDrive API

Retrieve a table from an Excel spreadsheet stored in OneDrive See the documentation

 
Try it
Upload File with the Microsoft OneDrive API

Upload a file to OneDrive. See the documentation

 
Try it

Explore Other Apps

1
-
12
of
1400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.