Get Table 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

Get Table 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 Get Table with the Microsoft OneDrive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Table action
1. Connect your Microsoft OneDrive account
2. Select a Spreadsheet
3. Select a Table name
4. Optional- Configure Remove headers?
5. Optional- Configure Number of rows to return
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#

Get Table with Microsoft OneDrive API on Webhook Destination (Instant) from Segment API

Segment + Microsoft OneDrive

Try it

Get Table with Microsoft OneDrive API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Microsoft OneDrive

Try it

Get Table with Microsoft OneDrive API on New Message in Channel from Discord Bot API

Discord Bot + Microsoft OneDrive

Try it

Get Table with Microsoft OneDrive API on New Submission from Typeform API

Typeform + Microsoft OneDrive

Try it

Get Table with Microsoft OneDrive API on Custom Events from Zoom API

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

Get Table on Microsoft OneDrive

Description:Retrieve a table from an Excel spreadsheet stored in OneDrive [See the documentation](https://learn.microsoft.com/en-us/graph/api/table-range?view=graph-rest-1.0&tabs=http)

Version:0.0.4

Key:microsoft_onedrive-get-excel-table

View on GitHub

Code#

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

export default {
  name: "Get Table",
  description: "Retrieve a table from an Excel spreadsheet stored in OneDrive [See the documentation](https://learn.microsoft.com/en-us/graph/api/table-range?view=graph-rest-1.0&tabs=http)",
  key: "microsoft_onedrive-get-excel-table",
  version: "0.0.4",
  type: "action",
  props: {
    onedrive,
    itemId: {
      type: "string",
      label: "Spreadsheet",
      description: "Search for the file by name, only xlsx files are supported",
      useQuery: true,
      async options( context ) {
        const response = await this.httpRequest({
          $: context,
          url: `/search(q='${context?.query ?? ""} .xlsx')?select=name,id`,
        });
        return response.value
          .filter(({ name }) => name.endsWith(".xlsx"))
          .map(({
            name, id,
          }) => ({
            label: name,
            value: id,
          }));
      },
    },
    tableName: {
      type: "string",
      label: "Table name",
      description: "This is set in the **Table Design** tab of the ribbon.",
      async options( context ) {
        const response = await this.httpRequest({
          $: context,
          url: `/items/${this.itemId}/workbook/tables?$select=name`,
        });
        return response.value.map(({ name }) => name);
      },
    },
    removeHeaders: {
      type: "boolean",
      label: "Remove headers?",
      optional: true,
      description: "By default, The headers are included as the first row.",
      default: false,
    },
    numberOfRows: {
      type: "integer",
      optional: true,
      default: 0,
      min: 0,
      label: "Number of rows to return",
      description: "Leave blank to return all rows.",
    },
  },
  methods: {
    httpRequest,
  },
  async run({ $ }) {
    const range = await this.httpRequest({
      $,
      url: `/items/${this.itemId}/workbook/tables/${this.tableName}/range`,
    });

    return this.removeHeaders
      ? this.numberOfRows <= 0
        ? range.text.slice(1)
        : range.text.slice(1, this.numberOfRows + 1)
      : this.numberOfRows <= 0
        ? range.text
        : range.text.slice(0, this.numberOfRows + 1);
  },
};

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.
Spreadsheet	`itemId`	`string`	Select a value from the drop down menu.
Table name	`tableName`	`string`	Select a value from the drop down menu.
Remove headers?	`removeHeaders`	`boolean`	By default, The headers are included as the first row.
Number of rows to return	`numberOfRows`	`integer`	Leave blank to return all rows.

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