Back to ServiceNow Integrations
Handler · Version 1

ServiceNow Object Query Retrieve

Download GitHub


This handler allows the generic retrieval of a ServiceNow object when given a table and a query. Using the ServiceNow REST API and basic authentication, a URL is built up to retrieve records from a table. If that REST call successfully finds records, a JSON representation of the objects will be returned as handler results.

Name Description Sample
username Username/Email of target user.
password Password of the user. *********
server The subdomain of service now the server belongs to (ie.
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Name Description Sample
Error Handling Determine what to return if an error is encountered. raise error
Table The name of the table to retrieve info from (ie. change_request,incident, task,etc). incident
Query The query to retrieve objects. Use a '^' to seperate parameters. state=7^category=hardware
Display Value Return field display values (true), actual values (false), or both (all) (default: false). true
Exclude Reference Link True to exclude Table API links for reference fields (default: false). true
Suppress Pagination Header True to supress pagination header (default: false). true
Fields A comma-separated list of fields to return in the response. number,opened_by
Limit The maximum number of results returned per page (default: 10,000). 10
Query Category Name of the query category (read replica category) to use for queries. hardware
Name Description
Handler Error Message Error message if an error was encountered and Error Handling is set to "Error Message".
object_json A JSON representation of the returned ServiceNow object

ServiceNow Object Query Retrieve V1 (2019-31-1)

  • Modified the label to a new name.

ServiceNow Object Query Retrieve V1 (2019-25-1)

  • Moved from unpublished to published
  • Added error handling

ServiceNow Object Query Retrieve V1 (2019-24-1)

  • Added parameters to the handler to expose more features
  • of the serviceNow API endpoint.

ServiceNow Object Query Retrieve V1 (2018-15-11)

  • Initial version. See README for details.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top