Download File with Microsoft OneDrive API

Pipedream makes it easy to connect APIs for Microsoft OneDrive and 2,000+ 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

▶

Watch us build a workflow

4 min

Watch now ➜

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

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.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
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.5

Key:microsoft_onedrive-download-file

View on GitHub

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.5",
  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.

Label	Prop	Type	Description
Microsoft OneDrive	`onedrive`	`app`	This component uses the Microsoft OneDrive app.
File ID	`fileId`	`string`	Select a value from the drop down menu.
File Path	`filePath`	`string`	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 Name	`newFileName`	`string`	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