ServiceNow: Get multiple records

🕙  3 minute read

Use this action to return a data table of all records from a ServiceNow table. All record fields are included as columns in the table.

You can use the Sysparm query field to set how you want to filter the ServiceNow table. By default, this action returns all records.

How to configure this action

This action requires a preconfigured ServiceNow integration. For more information on integrating Catalytic with other systems, please refer to the Integrations section of our help documentation.

Fields for this action

  • Integration

    • Select your ServiceNow integration from the options. You may have multiple integrations configured.
  • Table name

    • Enter the Table name where the record is stored, for example incident. For a list of the default ServiceNow tables, see the Tables and Classes article.
  • Sysparm view

    • Select the UI view to determine which fields are returned from the records. The options are desktop, mobile, or both.
    • ✅   Heads-up: Sysparm fields takes precedent over this field.
  • Sysparm limit

    • Set the number of records to return in the table. Default is 10000.
    • See the Workflow System Limits for more information on the maximum number of rows in a data table.
  • Sysparm query

    • Optionally, enter a query string to filter the results in the table. If the query is invalid, all rows are returned up to the Sysparm limit.
      • For example, to filter for only Active records, use active=true.
      • To link two queries together, separate them with ^, for example, region=EMEA^active=true.
      • To sort records based on certain fields, use ORDERBY and ORDERBYDESC. For example, ORDERBYregion sorts records by the region field, ^ORDERBYDESCcustomer sorts records by customer. You can combine these with other queries, such as active=true^ORDERBYregion^ORDERBYDESCcustomer.
    • 💡   Tip: For an quick way to create a query, browse and set filters when viewing the table ServiceNow, then right click the last entry in the breadcrumb and choose Copy query.
  • Sysparm fields

    • By default, this action returns every field from the records. To return specific fields, enter a comma separated list of field names to return in the response.
    • ✅   Heads-up: Takes precedent over Sysparm view
  • Output Field Prefix

    • To help keep output fields organized, choose an output field prefix to add to the beginning of each output field name as this action may output more than one field.
    • The step’s name is used as the prefix by default.
  • Sysparm display value

    • Select how the ServiceNow record data is formatted in the output fields. You can choose to output the display value, or actual value. For example, the display value of a currency field may be $100, but the actual value is 100, the display value of a user field may be Rick, but the actual value is 783c019v389900b98. Default is false.
      • Enter true to return the display values
      • Enter false to return the actual values
      • Enter all to return both display and actual values in the output.
    • For an overview of the display/actual values of different field types, see ServiceNow’s Field types affected by export controls article.
  • Sysparm query category

    • Name of the query category (read replica category) to use for queries
  • Sysparm query no domain

    • Set whether to attempt to include records from restricted domains. This is based on the permissions provided to the user account used during integration creation. The user account must be an admin, or the user must have the query_no_domain_table_api role.
      • Enter true to exclude records from restricted domains.
      • Enter false to include records from restricted domains.
    • If a field references other resources or databases, you can include additional information such as the URI link to the reference resource. Default is false.
      • Select true to exclude links when a field references other resources.
      • Select False to include links when a field references other resources.
  • Sysparm suppress pagination header

    • Select whether to exclude the Link header from the output. ServiceNow adds a Link header of URLS to relative pages for each records. This is typically used as a way to sort or paginate the output records.
      • Select true to remove the Link header from the response.
      • Select false to include the link header in the response.

What will this output?

This action will output a data table field, where each row is a record from the table. The table has a column for every field in the record. The column name will be the same name as the field in ServiceNow.

This action may generate multiple fields. To help keep output fields organized, the prefix above will be added to the beginning of each of the output field names, separated by two dashes. Each field will result as:{{output-field-prefix--output-field}}

Sorry about that. What was the most unhelpful part?

Thanks for your feedback

We update the Help Center daily, so expect changes soon.

Link Copied

Paste this URL anywhere to link straight to the section.

Need more help?

If you're signed in to Catalytic Community, you can ask other users a question. You'll be redirected to Community where you can add more info.