ServiceNow Connector

The high-performance ServiceNow Connector provides read/write capabilities within your application, allowing you to perform numerous ServiceNow operations with minimal coding or even no-coding at all. Integrate ServiceNow data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.

Download for SSIS Download for SQL Server and ODBC Documentation

Integrate ServiceNow with these applications

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

Actions supported by ServiceNow Connector

ServiceNow Connector supports following actions for REST API integration:

Delete a Table Row

Description

Insert a row into the table.

Parameters

You can provide the following parameters to this action:

  • TableName
  • Allow Label as Input Value (Default: false - Use Id for reference field)

Input Fields

You can provide the following fields to this action:

  • [Dynamic Column]

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • [Dynamic Column]

Visit documentation for more information.

Delete Attachment

Description

Delete an attachment by its sys_id.

Parameters

You can provide the following parameters to this action:

  • Attachment Id (i.e. sys_id)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • status
  • sys_id
  • http_status

Visit documentation for more information.

Delete table row

Description

Delete the specified row in the table by row 'sys_id'.

Parameters

You can provide the following parameters to this action:

  • TableName
  • SysId

Input Fields

You can provide the following fields to this action:

  • sys_id

Output Fields

The following fields are returned after calling this action:

  • status
  • sys_id
  • http_status

Visit documentation for more information.

Download Table Attachment (Single - Using Id)

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • SysId (i.e. Attachment Id)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • http_status
  • sys_id
  • size_bytes
  • file_name
  • table_sys_id
  • content_type

Visit documentation for more information.

Download Table Attachments (Multiple - Using Query)

Description

Download all attachments for a specified table, or table and its row sys_id or specific attachment sys_id. When files are saved they are given a unique name using the pattern {table_sys_id}_{attachment_sys_id}_{attachment-file_name} so files with the same filename from different parent records will not overwrite each other in the download folder.

Parameters

You can provide the following parameters to this action:

  • SaveFolder
  • Page Size (Default=2000, Max=10000)
  • Output Mode
  • TableName (for attachments)
  • ParentSysId
  • Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)
  • Attachment Filter / Order By
  • OverwriteFile
  • PagingOffset
  • SysId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • table_sys_id
  • sys_id
  • table_name
  • file_name
  • size_bytes
  • content_type
  • hash
  • sys_created_on
  • sys_created_by
  • saved_file_size
  • status_code
  • error_message
  • save_folder
  • data_bytes

Visit documentation for more information.

Download Table Attachments By Parent Row Search

Description

Download attachments for parent rows returned by the parent query. When files are saved they are given a unique name using the pattern {table_sys_id}_{attachment_sys_id}_{attachment-file_name} so files with the same filename from different parent records will not overwrite each other in the download folder.

Parameters

You can provide the following parameters to this action:

  • SaveFolder
  • Page Size (Default=2000, Max=10000)
  • TableName
  • OverwriteFile
  • Attachment Filter / Order By
  • PagingOffset
  • SysId
  • Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)
  • Query / Order By (Server Side Filter)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • table_sys_id
  • sys_id
  • table_name
  • file_name
  • size_bytes
  • content_type
  • hash
  • sys_created_on
  • sys_created_by
  • saved_file_size
  • status_code
  • error_message
  • save_folder
  • data_bytes

Visit documentation for more information.

Get Attachments

Description

Get attachment details for a specified table or table + parent sys_id (e.g. incident) or a specific attachment sys_id. You can also search using search criterial related to attachment record (e.g. filename starts with xyz).

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • TableName (for attachments)
  • ParentSysId
  • Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)
  • Attachment Filter / Order By
  • PagingOffset
  • SysId

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • table_sys_id
  • file_name
  • content_type
  • hash
  • state
  • size_bytes
  • size_compressed
  • chunk_size_bytes
  • image_width
  • image_height
  • average_image_color
  • compressed
  • table_name
  • sys_created_by
  • sys_updated_by
  • sys_tags
  • sys_created_on
  • sys_updated_on
  • sys_mod_count

Visit documentation for more information.

Get Attachments By Parent Row Search

Description

Get table rows.

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • TableName
  • Attachment Filter / Order By
  • PagingOffset
  • SysId
  • Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)
  • Query / Order By (Server Side Filter)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • table_sys_id
  • file_name
  • content_type
  • hash
  • state
  • size_bytes
  • size_compressed
  • chunk_size_bytes
  • image_width
  • image_height
  • average_image_color
  • compressed
  • table_name
  • sys_created_by
  • sys_updated_by
  • sys_tags
  • sys_created_on
  • sys_updated_on
  • sys_mod_count

Visit documentation for more information.

Get List Of System Tables Admin Use Sys Db Object

Description

Get a list of tables created by 'system' user.

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • SysId
  • PagingOffset

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • name
  • label
  • sys_name
  • create_access
  • alter_access
  • access
  • live_feed_enabled
  • sys_updated_on
  • sys_class_name
  • is_extendable
  • user_role
  • create_access_controls
  • delete_access
  • sys_updated_by
  • sys_class_path
  • sys_created_on
  • caller_access
  • client_scripts_access
  • extension_model
  • actions_access
  • sys_scope_link
  • sys_scope_value
  • sys_created_by
  • sys_class_code
  • read_access
  • super_class
  • sys_mod_count
  • ws_access
  • update_access
  • sys_package_link
  • sys_package_value
  • sys_update_name
  • scriptable_table
  • configuration_access
  • number_ref
  • sys_policy
  • sys_scope
  • sys_package
  • super_class_link
  • super_class_value
  • number_ref_link
  • number_ref_value
  • user_role_link
  • user_role_value

Visit documentation for more information.

Get List of Tables

Description

Get a list of tables.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • name
  • label
  • raw_label
  • image
  • missing
  • reference
  • used
  • selected

Visit documentation for more information.

Get List Of Tables Admin Use Sys Db Object

Description

Get a list of tables by quering sys_db_object. To read data from this object make sure user has read permission to this table.

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • SysId
  • Query / Order By (Server Side Filter)
  • Fields
  • PagingOffset

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • name
  • label
  • sys_name
  • create_access
  • alter_access
  • access
  • live_feed_enabled
  • sys_updated_on
  • sys_class_name
  • is_extendable
  • user_role
  • create_access_controls
  • delete_access
  • sys_updated_by
  • sys_class_path
  • sys_created_on
  • caller_access
  • client_scripts_access
  • extension_model
  • actions_access
  • sys_scope_link
  • sys_scope_value
  • sys_created_by
  • sys_class_code
  • read_access
  • super_class
  • sys_mod_count
  • ws_access
  • update_access
  • sys_package_link
  • sys_package_value
  • sys_update_name
  • scriptable_table
  • configuration_access
  • number_ref
  • sys_policy
  • sys_scope
  • sys_package
  • super_class_link
  • super_class_value
  • number_ref_link
  • number_ref_value
  • user_role_link
  • user_role_value

Visit documentation for more information.

Get List Of User Tables Admin Use Sys Db Object

Description

Get a list of tables not created by 'system' user.

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • SysId
  • PagingOffset

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • name
  • label
  • sys_name
  • create_access
  • alter_access
  • access
  • live_feed_enabled
  • sys_updated_on
  • sys_class_name
  • is_extendable
  • user_role
  • create_access_controls
  • delete_access
  • sys_updated_by
  • sys_class_path
  • sys_created_on
  • caller_access
  • client_scripts_access
  • extension_model
  • actions_access
  • sys_scope_link
  • sys_scope_value
  • sys_created_by
  • sys_class_code
  • read_access
  • super_class
  • sys_mod_count
  • ws_access
  • update_access
  • sys_package_link
  • sys_package_value
  • sys_update_name
  • scriptable_table
  • configuration_access
  • number_ref
  • sys_policy
  • sys_scope
  • sys_package
  • super_class_link
  • super_class_value
  • number_ref_link
  • number_ref_value
  • user_role_link
  • user_role_value

Visit documentation for more information.

Get Record Labels (Tags)

Description

Returns UI labels (tags) applied to a specific record using the ServiceNow label framework.

Parameters

You can provide the following parameters to this action:

  • Parent Table Name
  • Table (***DO NOT CHANGE***)
  • ShowDisplayValue
  • Parent Record Sys_ID
  • Additional Filter (Optional)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • [Dynamic Column]
  • [Dynamic Column]_diaplay_value

Visit documentation for more information.

Get Table Columns

Description

Get a list of columns of a table.

Parameters

You can provide the following parameters to this action:

  • TableName

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • name
  • element
  • label
  • internal_type
  • max_length
  • column_type
  • type
  • filterable
  • reference_display_field
  • reference_attributes_display_field
  • reference_attributes_ref_ac_columns
  • reference_attributes_ref_ac_columns_search
  • reference_attributes_ref_ac_display_value
  • reference_attributes_ref_auto_completer
  • canmatch
  • cangroup
  • max_unit
  • mandatory
  • reference
  • default
  • base_type
  • read_only
  • hint
  • attributes
  • cansort
  • multitext
  • choice_type
  • choices

Visit documentation for more information.

Get Table Columns Admin Use Sys Dictionary

Description

Get a list of columns by quering sys_dictionary. To read data from this table make sure user has read permission to sys_dictionary table.

Parameters

You can provide the following parameters to this action:

  • TableName
  • Page Size (Default=2000, Max=10000)
  • PagingOffset

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • name
  • element
  • internal_type
  • max_length
  • column_label
  • sys_name
  • comments
  • calculation
  • dynamic_ref_qual
  • choice_field
  • function_field
  • sys_updated_on
  • spell_check
  • reference_cascade_rule
  • reference
  • sys_updated_by
  • read_only
  • sys_created_on
  • array_denormalized
  • element_reference
  • reference_key
  • reference_qual_condition
  • xml_view
  • dependent
  • internal_type_link
  • sys_created_by
  • use_dependent_field
  • delete_roles
  • virtual_type
  • active
  • choice_table
  • foreign_database
  • sys_update_name
  • unique
  • dependent_on_field
  • dynamic_creation
  • primary
  • sys_policy
  • next_element
  • virtual
  • widget
  • use_dynamic_default
  • sizeclass
  • mandatory
  • sys_class_name
  • dynamic_default_value
  • write_roles
  • array
  • audit
  • read_roles
  • sys_scope_link
  • sys_scope_value
  • create_roles
  • dynamic_creation_script
  • defaultsort
  • use_reference_qualifier
  • display
  • reference_floats
  • sys_mod_count
  • default_value
  • staged
  • reference_type
  • sys_package_link
  • sys_package_value
  • formula
  • attributes
  • choice
  • reference_qual
  • table_reference
  • text_index
  • function_definition
  • sys_scope
  • sys_package

Visit documentation for more information.

Get Table Row Count

Description

Get table row count (count for all rows or for specified query filter).

Parameters

You can provide the following parameters to this action:

  • TableName
  • Query / Order By (Server Side Filter)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • count

Visit documentation for more information.

Get Table Rows

Description

Get table rows.

Parameters

You can provide the following parameters to this action:

  • Page Size (Default=2000, Max=10000)
  • TableName
  • PagingOffset
  • SysId
  • Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)
  • Query / Order By (Server Side Filter)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • [Dynamic Column]

Visit documentation for more information.

Test Connection

Description

Not available.

Parameters

You can provide the following parameters to this action:

  • N/A

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • Status

Visit documentation for more information.

Update a Table Row

Description

Insert a row into the table.

Parameters

You can provide the following parameters to this action:

  • TableName
  • SysId
  • Allow Label as Input Value (Default: false - Use Id for reference field)

Input Fields

You can provide the following fields to this action:

  • [Dynamic Column]
  • sys_id

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • [Dynamic Column]

Visit documentation for more information.

Upload Attachment

Description

Upload a file as an attachment to a ServiceNow record. Requires table name and sys_id in headers.

Parameters

You can provide the following parameters to this action:

  • Table Name (e.g. incident)
  • Parent Table Row Id (i.e. table_sys_id)
  • File Name
  • Source File Path (e.g. c:\uploads\file.pdf)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • sys_id
  • table_sys_id
  • file_name
  • content_type
  • hash
  • state
  • size_bytes
  • size_compressed
  • chunk_size_bytes
  • image_width
  • image_height
  • average_image_color
  • compressed
  • table_name
  • sys_created_by
  • sys_updated_by
  • sys_tags
  • sys_created_on
  • sys_updated_on
  • sys_mod_count

Visit documentation for more information.

Make Generic API Request

Description

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • HTTP - Url or File Path
  • HTTP - Request Body
  • HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
  • HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb)
  • Parser - Filter (e.g. $.rows[*] )
  • Download - Enable reading binary data
  • Download - File overwrite mode
  • Download - Save file path
  • Download - Enable raw output mode as single row
  • Download - Raw output data RowTemplate
  • Download - Request Timeout (Milliseconds)

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Make Generic API Request (Bulk Write)

Description

This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameters

You can provide the following parameters to this action:

  • Url
  • IsMultiPart
  • Filter
  • Headers

Input Fields

You can provide the following fields to this action:

  • N/A

Output Fields

The following fields are returned after calling this action:

  • N/A

Visit documentation for more information.

Download for SSIS Download for SQL Server and ODBC