Get Table Record By SysId with ServiceNow API on Dataset Refresh Failed from Microsoft Power BI API

Pipedream makes it easy to connect APIs for ServiceNow, Microsoft Power BI and 2,000+ other apps remarkably fast.

Trigger workflow on

Dataset Refresh Failed from the Microsoft Power BI API

Next, do this

Get Table Record By SysId with the ServiceNow API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the Dataset Refresh Failed trigger
1. Connect your Microsoft Power BI account
2. Optional- Select a Dataset ID
3. Optional- Configure Custom Dataset ID
4. Configure timer
Configure the Get Table Record By SysId action
1. Connect your ServiceNow account
2. Configure table_name
3. Configure sys_id
4. Optional- Select a api_version
5. Optional- Select a request_format
6. Optional- Select a response_format
7. Optional- Select a sysparm_display_value
8. Optional- Configure sysparm_exclude_reference_link
9. Optional- Configure sysparm_fields
10. Optional- Configure sysparm_view
11. Optional- Configure sysparm_query_no_domain
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#

Dataset Refresh Failed on Microsoft Power BI

Description:Emits an event when a dataset refresh operation has failed in Power BI. [See the documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history)

Version:0.0.4

Key:microsoft_power_bi-dataset-refresh-failed

View on GitHub

Microsoft Power BI Overview#

The Microsoft Power BI API allows you to interact with your Power BI assets programmatically. With this API, you can embed your reports and dashboards into applications, manage Power BI datasets, push data into datasets for real-time dashboard updates, and automate your reporting workflows. On Pipedream, you can use this API to create intricate workflows that react to various triggers, like webhooks or schedules, and perform actions like refreshing datasets, posting to datasets, and managing Power BI assets.

Trigger Code#

import common from "../common.mjs";

export default {
  key: "microsoft_power_bi-dataset-refresh-failed",
  name: "Dataset Refresh Failed",
  description: "Emits an event when a dataset refresh operation has failed in Power BI. [See the documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history)",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  ...common,
  methods: {
    ...common.methods,
    checkStatus(status) {
      return status === "Failed";
    },
    getSummary() {
      return "New Failed Refresh";
    },
  },
};

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
Microsoft Power BI	`powerBiApp`	`app`	This component uses the Microsoft Power BI app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Dataset ID	`datasetId`	`string`	Select a value from the drop down menu.
Custom Dataset ID	`customDatasetId`	`string`	You may enter a Dataset ID directly. Either Dataset ID or Custom Dataset ID must be entered.
	`timer`	`$.interface.timer`

Trigger Authentication#

Microsoft Power BI uses OAuth authentication. When you connect your Microsoft Power BI account, Pipedream will open a popup window where you can sign into Microsoft Power BI 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 Power BI API.

Pipedream requests the following authorization scopes when you connect your account:

offline_accesshttps://analysis.windows.net/powerbi/api/App.Read.Allhttps://analysis.windows.net/powerbi/api/Dashboard.Read.Allhttps://analysis.windows.net/powerbi/api/Workspace.Read.Allhttps://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All

About Microsoft Power BI#

Visualize any data and integrate the visuals into the apps you use every day with Power BI, a unified platform for self-service and business intelligence.

Action#

Get Table Record By SysId on ServiceNow

Description:Retrieves the record identified by the specified sys_id from the specified table.

Version:0.3.1

Key:servicenow-get-table-record-by-sysid

View on GitHub

ServiceNow Overview#

The ServiceNow API lets developers access and manipulate records, manage workflows, and integrate with other services on its IT service management platform. These capabilities support automating tasks, syncing data across platforms, and boosting operational efficiencies.

Action Code#

// legacy_hash_id: a_rJid2e
import { axios } from "@pipedream/platform";

export default {
  key: "servicenow-get-table-record-by-sysid",
  name: "Get Table Record By SysId",
  description: "Retrieves the record identified by the specified sys_id from the specified table.",
  version: "0.3.1",
  type: "action",
  props: {
    servicenow: {
      type: "app",
      app: "servicenow",
    },
    table_name: {
      type: "string",
      description: "The name of the table containing the record to retrieve.",
    },
    sys_id: {
      type: "string",
      description: "Unique identifier of the record to retrieve.",
    },
    api_version: {
      type: "string",
      description: "API version number. Version numbers identify the endpoint version that a URI accesses. By specifying a version number in your URIs, you can ensure that future updates to the REST API do not negatively impact your integration. Use `lastest` to use the latest REST endpoint for your instance version.",
      optional: true,
      options: [
        "lastest",
        "v1",
        "v2",
      ],
    },
    request_format: {
      type: "string",
      description: "Format of REST request body",
      optional: true,
      options: [
        "application/json",
        "application/xml",
        "text/xml",
      ],
    },
    response_format: {
      type: "string",
      description: "Format of REST response body.",
      optional: true,
      options: [
        "application/json",
        "application/xml",
        "text/xml",
      ],
    },
    sysparm_display_value: {
      type: "string",
      description: "Return field display values (true), actual values (false), or both (all) (default: false).",
      optional: true,
      options: [
        "true",
        "false",
        "all",
      ],
    },
    sysparm_exclude_reference_link: {
      type: "boolean",
      description: "True to exclude Table API links for reference fields (default: false).",
      optional: true,
    },
    sysparm_fields: {
      type: "string",
      description: "A comma-separated list of fields to return in the response.",
      optional: true,
    },
    sysparm_view: {
      type: "string",
      description: "Render the response according to the specified UI view (overridden by sysparm_fields).",
      optional: true,
    },
    sysparm_query_no_domain: {
      type: "boolean",
      description: "True to access data across domains if authorized (default: false).",
      optional: true,
    },
  },
  async run({ $ }) {
  // See the API docs: https://docs.servicenow.com/bundle/paris-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html#table-GET-id                      */

    if (!this.table_name || !this.sys_id) {
      throw new Error("Must provide table_name, and sys_id parameters.");
    }

    var apiVersion = "";
    if (this.api_version == "v1" || this.api_version == "v2") {
      apiVersion = this.api_version + "/";
    }

    return await axios($, {
      url: `https://${this.servicenow.$auth.instance_name}.service-now.com/api/now/${apiVersion}table/${this.table_name}/${this.sys_id}`,
      headers: {
        "Authorization": `Bearer ${this.servicenow.$auth.oauth_access_token}`,
        "Accept": this.request_format || "application/json",
        "Content-Type": this.response_format || "application/json",
      },
      params: {
        sysparm_display_value: this.sysparm_display_value,
        sysparm_exclude_reference_link: this.sysparm_exclude_reference_link,
        sysparm_fields: this.sysparm_fields,
        sysparm_view: this.sysparm_view,
        sysparm_query_no_domain: this.sysparm_query_no_domain,
      },
    });
  },
};

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
ServiceNow	`servicenow`	`app`	This component uses the ServiceNow app.
table_name	`table_name`	`string`	The name of the table containing the record to retrieve.
sys_id	`sys_id`	`string`	Unique identifier of the record to retrieve.
api_version	`api_version`	`string`	Select a value from the drop down menu:`lastestv1v2`
request_format	`request_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xmltext/xml`
response_format	`response_format`	`string`	Select a value from the drop down menu:`application/jsonapplication/xmltext/xml`
sysparm_display_value	`sysparm_display_value`	`string`	Select a value from the drop down menu:`truefalseall`
sysparm_exclude_reference_link	`sysparm_exclude_reference_link`	`boolean`	True to exclude Table API links for reference fields (default: false).
sysparm_fields	`sysparm_fields`	`string`	A comma-separated list of fields to return in the response.
sysparm_view	`sysparm_view`	`string`	Render the response according to the specified UI view (overridden by sysparm_fields).
sysparm_query_no_domain	`sysparm_query_no_domain`	`boolean`	True to access data across domains if authorized (default: false).

Action Authentication#

ServiceNow uses OAuth authentication. When you connect your ServiceNow account, Pipedream will open a popup window where you can sign into ServiceNow and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any ServiceNow API.

Pipedream requests the following authorization scopes when you connect your account: