Create or Update Reference Data with GoCanvas API

Pipedream makes it easy to connect APIs for GoCanvas and 2,900+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create or Update Reference Data with the GoCanvas 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 Create or Update Reference Data with the GoCanvas API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create or Update Reference Data action
1. Connect your GoCanvas account
2. Configure Reference Data Name
3. Configure Data
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#

Create or Update Reference Data with GoCanvas API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + GoCanvas

Try it

Create or Update Reference Data with GoCanvas API on New Submission from Typeform API

Typeform + GoCanvas

Try it

Create or Update Reference Data with GoCanvas API on New Submission (Instant) from Jotform API

Jotform + GoCanvas

Try it

Create or Update Reference Data with GoCanvas API on New Scheduled Tasks from Pipedream API

Pipedream + GoCanvas

Try it

Create or Update Reference Data with GoCanvas API on New Download Counts from npm API

npm + GoCanvas

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.

Create or Update Reference Data on GoCanvas

Description:Creates or updates GoCanvas reference data. [See the documentation](https://help.gocanvas.com/hc/en-us/article_attachments/26468076609559)

Version:0.0.2

Key:gocanvas-create-or-update-reference-data

View on GitHub

Code#

import gocanvas from "../../gocanvas.app.mjs";
import { parse } from "csv-parse/sync";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "gocanvas-create-or-update-reference-data",
  name: "Create or Update Reference Data",
  description: "Creates or updates GoCanvas reference data. [See the documentation](https://help.gocanvas.com/hc/en-us/article_attachments/26468076609559)",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    gocanvas,
    name: {
      type: "string",
      label: "Reference Data Name",
      description: "The attribute name of the dataset to operate on. Will be created if it doesn't already exist.",
    },
    data: {
      type: "string",
      label: "Data",
      description: `A string of comma separated values representing the data to create/update. **Include Column names**:
      \n Example:
      \n  Column1,Column2,Column3
      \n  Data1Column1,Data1Column2,Data1Column3
      \n  Data2Column1,Data2Column2,Data3Column3
      `,
    },
  },
  methods: {
    csvToXml(data) {
      const records = parse(data, {
        columns: true,
        trim: true,
      });

      if (!records?.length) {
        throw new ConfigurationError("No data items found to create/update. Please enter column names and at least 1 row of data.");
      }

      // Extract columns
      const columns = Object.keys(records[0]);
      let result = "<Columns>";
      result += columns.map((col) => `<c>${col}</c>`).join("");
      result += "</Columns>\n<Rows>\n";

      // Extract rows
      result += records
        .map((row) => {
          const rowValues = columns.map((col) => `<v>${row[col]}</v>`).join("");
          return `  <r>${rowValues}</r>`;
        })
        .join("\n");

      result += "\n</Rows>";
      return result;
    },
  },
  async run({ $ }) {
    const response = await this.gocanvas.createUpdateReferenceData({
      $,
      data: `
        <?xml version="1.0" encoding="utf-8"?>
          <List Name="${this.name}">
            ${await this.csvToXml(this.data)}
          </List>
      `,
    });
    $.export("$summary", "Successfully created/updated reference data");
    return response;
  },
};

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
GoCanvas	`gocanvas`	`app`	This component uses the GoCanvas app.
Reference Data Name	`name`	`string`	The attribute name of the dataset to operate on. Will be created if it doesn't already exist.
Data	`data`	`string`	A string of comma separated values representing the data to create/update. Include Column names: Example: Column1,Column2,Column3 Data1Column1,Data1Column2,Data1Column3 Data2Column1,Data2Column2,Data3Column3

Authentication#

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

Go to Account > Account Settings. Scroll down to the Security Settings > API Keys and click Settings.
On this page, check the box to Enable API Keys and then click Create API Key.

For username, use your email address such as test_user@gocanvas.com. See docs