Find File by Name with Microsoft OneDrive API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Find File by Name with the Microsoft OneDrive API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Find File by Name action
1. Connect your Microsoft OneDrive account
2. Configure File Name
3. Optional- Configure Exclude Folders?
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#

Find File by Name with Microsoft OneDrive API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Microsoft OneDrive

Try it

Find File by Name with Microsoft OneDrive API on New Submission from Typeform API

Typeform + Microsoft OneDrive

Try it

Find File by Name with Microsoft OneDrive API on New Submission (Instant) from Jotform API

Jotform + Microsoft OneDrive

Try it

Find File by Name with Microsoft OneDrive API on New Scheduled Tasks from Pipedream API

Pipedream + Microsoft OneDrive

Try it

Find File by Name with Microsoft OneDrive API on New Download Counts from npm API

npm + 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.

Find File by Name on Microsoft OneDrive

Description:Search for a file or folder by name. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_search)

Version:0.0.1

Key:microsoft_onedrive-find-file-by-name

View on GitHub

Code#

import onedrive from "../../microsoft_onedrive.app.mjs";
import httpRequest from "../../common/httpRequest.mjs";

export default {
  key: "microsoft_onedrive-find-file-by-name",
  name: "Find File by Name",
  description: "Search for a file or folder by name. [See the documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/api/driveitem_search)",
  version: "0.0.1",
  type: "action",
  props: {
    onedrive,
    name: {
      type: "string",
      label: "File Name",
      description: "The name of the file or folder to search for",
    },
    excludeFolders: {
      propDefinition: [
        onedrive,
        "excludeFolders",
      ],
    },
  },
  methods: {
    httpRequest,
  },
  async run({ $ }) {
    const response = await this.httpRequest({
      url: `/search(q='${this.name}')`,
    });
    let values = response.value.filter(
      ({ name }) => name.toLowerCase().includes(this.name.toLowerCase()),
    );
    if (this.excludeFolders) {
      values = values.filter(({ folder }) => !folder);
    }

    const plural = values.length === 1
      ? ""
      : "s";
    const type = this.excludeFolders
      ? `file${plural}`
      : `file${plural} and/or folder${plural}`;
    $.export("$summary", `Found ${values.length} matching ${type}`);
    return values;
  },
};

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 Name	`name`	`string`	The name of the file or folder to search for
Exclude Folders?	`excludeFolders`	`boolean`	Set to `true` to return only files in the response. Defaults to `false`

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