Download File with Microsoft OneDrive API on New Campsite Availability Changed Event from Recreation.gov API

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

Trigger workflow on

New Campsite Availability Changed Event from the Recreation.gov API

Next, do this

Download File 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#

This integration creates a workflow with a Recreation.gov trigger and Microsoft OneDrive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Campsite Availability Changed Event trigger
1. Connect your Recreation.gov account
2. Configure timer
3. Select a Campsite Id
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
5. Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Campsite Availability Changed Event on Recreation.gov

Description:Emit new events when selected campsite's availability is changed. [See the documentation](https://ridb.recreation.gov/docs#/Campsites/getCampsite)

Version:0.0.1

Key:recreation_gov-campsite-availability-changed

View on GitHub

Recreation.gov Overview#

The Recreation.gov API provides access to data about federal recreational activities and areas. With it, you can fetch details about campsites, tours, permits, and articles. On Pipedream, leverage this API to automate notifications, analyze recreational data, or integrate with other services for trip planning or environmental monitoring.

Trigger Code#

import common from "../common/attribute-based.mjs";

export default {
  ...common,
  key: "recreation_gov-campsite-availability-changed",
  name: "New Campsite Availability Changed Event",
  description: "Emit new events when selected campsite's availability is changed. [See the documentation](https://ridb.recreation.gov/docs#/Campsites/getCampsite)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campsiteId: {
      propDefinition: [
        common.props.app,
        "campsiteId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceFnConfig() {
      return {
        resourceFn: this.app.getCampsite,
        resourceKey: "RECDATA",
        params: {
          campsiteId: this.campsiteId,
        },
      };
    },
    getMeta(item) {
      return {
        ts: new Date().getTime(),
        id: new Date().getTime(),
        // eslint-disable-next-line multiline-ternary
        summary: `Campsite(${item.CampsiteName}) availability was changed to ${item.CampsiteAccessible ? "available" : "not available"}`,
      };
    },
    compareFn(item) {
      return item.CampsiteAccessible !== this.getAttribute();
    },
    getAttributeKey() {
      return "CampsiteAccessible";
    },
  },
};

Trigger 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
Recreation.gov	`app`	`app`	This component uses the Recreation.gov app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Campsite Id	`campsiteId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Recreation.gov uses API keys for authentication. When you connect your Recreation.gov account, Pipedream securely stores the keys so you can easily authenticate to Recreation.gov APIs in both code and no-code steps.

Obtaining a Recreation.gov API Key

Recreation.gov's API requires an API key to authenticate requests.

First sign up for an account at https://recreation.gov

Then open the API dashboard and enabled developer access under your profile.

This will generate an API key for your account to use with Pipedream.

Copy the API key into the field below.

About Recreation.gov#

The Recreation Information Database (RIDB) provides data resources to citizens, offering a single point of access to information about recreational opportunities nationwide.

Action#

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.9

Key:microsoft_onedrive-download-file

View on GitHub

Microsoft OneDrive Overview#

The Microsoft OneDrive API taps into the robust file storage and management capabilities of OneDrive, allowing for operations like file uploads, retrievals, sharing, and synchronization. Integrating this API into Pipedream workflows lets you automate tasks involving file management, content collaboration, and data backup processes. With OneDrive's API on Pipedream, you can streamline document workflows, trigger actions based on file changes, and connect your file storage to countless other services for enhanced productivity.

Action 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.9",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    onedrive,
    fileId: {
      propDefinition: [
        onedrive,
        "fileId",
      ],
      optional: true,
    },
    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. Make sure to include the file extension.",
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  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`;
    let response;
    try {
      response = await this.httpRequest({
        $,
        url,
        responseType: "stream",
      });
    } catch {
      throw new ConfigurationError(`Error accessing file. Please make sure that the ${ fileId
        ? "File ID"
        : "File Path"} is correct.`);
    }

    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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

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. Make sure to include the file extension.
syncDir	`syncDir`	`dir`

Action 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#

Microsoft OneDrive lets you store your personal files in one place, share them with others, and get to them from any device.