Get Table Record By SysId with ServiceNow API

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

Trigger workflow on

HTTP requests, schedules and app events

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 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Table Record By SysId with the ServiceNow API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
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 Record By SysId with ServiceNow API on New Incoming SMS from Bandwidth API

Bandwidth + ServiceNow

Try it

Get Table Record By SysId with ServiceNow API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ServiceNow

Try it

Get Table Record By SysId with ServiceNow API on New Item in Feed from RSS API

RSS + ServiceNow

Try it

Get Table Record By SysId with ServiceNow API on New Message from Discord API

Discord + ServiceNow

Try it

Get Table Record By SysId with ServiceNow API on New Message In Channels from Slack API

Slack + ServiceNow

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

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

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

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: