ServiceNow Connector for C# Allows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access. In this article you will learn how to quickly and efficiently integrate ServiceNow data in C#. We will use high-performance ServiceNow Connector to easily connect to ServiceNow and then access the data inside C#. Let's follow the steps below to see how we can accomplish that! Download Documentation ServiceNow Connector for C# is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to ServiceNow in other apps Connect to ServiceNow in SSIS Connect to ServiceNow in SQL Server Connect to ServiceNow in Power BI Connect to ServiceNow in SSRS Connect to ServiceNow in Informatica Connect to ServiceNow in MS Access Connect to ServiceNow in MS Excel Connect to ServiceNow in SSAS Connect to ServiceNow in Python Connect to ServiceNow in JAVA Connect to ServiceNow in Tableau Connect to ServiceNow in SAP Crystal Reports Connect to ServiceNow in Azure Data Factory (Pipeline) Connect to ServiceNow in Azure Data Factory (SSIS) Connect to ServiceNow in Talend Studio Connect to ServiceNow in UiPath Connect to ServiceNow in PowerShell Connect to ServiceNow in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from ServiceNow using C# we first need to create a DSN (Data Source) which will access data from ServiceNow. We will later be able to read data using C#. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "ServiceNow" from the list of Popular Connectors. If "ServiceNow" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   ServicenowDSN

   ServiceNow

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Basic Auth [Http]

   Authenticate using ServiceNow instance username and password.

   Steps how to get and use ServiceNow credentials
   

   Locate your ServiceNow instance credentials and use them for HTTP authentication:

   1. Go to https://developer.servicenow.com/dev.do and log in.
   2. Click on your profile picture.

   3. When a menu appears, click on Manage instance password or a similar option:

      

   4. In a new window you will see your HTTP Basic Authentication credentials:

      

   5. Done! Use this username and password when configuring OAuth Authentication parameters.

   Fill in all required parameters and set optional parameters if needed:

   ServicenowDSN

   ServiceNow

   Basic Auth [Http]

   https://[$InstanceName$].service-now.com/api/now

   Required Parameters
   InstanceName	Fill-in the parameter...
   User name	Fill-in the parameter...
   Password	Fill-in the parameter...
   Optional Parameters
   ApiVersion	v2
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

    OAuth [OAuth]

   Authenticate using ServiceNow instance username, password, OAuth Client ID, and Client Secret. [API reference]

   Steps how to get and use ServiceNow credentials
   

   Create OAuth application and use it for authentication:

   1. Login to your instance at https://your-instance-id.service-now.com.

   2. Start by clicking on menu item All, then search for oauth, and click Application Registry option:

      

   3. Then click button New:

      

   4. Continue by clicking Create an OAuth API endpoint for external clients option:

      

   5. Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).

   6. Finally give it a final touch by increasing the Refresh Token Lifespan value to 315,360,000 (it should last for 10 years):

      

   7. Done! Now you can use Client ID and Client Secret when configuring OAuth Authentication parameters.

   Fill in all required parameters and set optional parameters if needed:

   ServicenowDSN

   ServiceNow

   OAuth [OAuth]

   https://[$InstanceName$].service-now.com/api/now

   Required Parameters
   InstanceName	Fill-in the parameter...
   User name	Fill-in the parameter...
   Password	Fill-in the parameter...
   Client ID	Fill-in the parameter...
   Client Secret	Fill-in the parameter...
   ApiVersion	Fill-in the parameter...
   Optional Parameters
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429|503
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - ServiceNow

   Allows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access.

   ServicenowDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in C# to retrieve data from ServiceNow. Hit OK button to use this query in the next step.

   SELECT * FROM incident 
   
   --Using Primary Key				
   --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause
   
   --Using Filter Expression
   --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition
   --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition
   --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition
   --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition
   --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition
   --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator)  -- (number=INC0000001 and state=7) OR (number=INC0000002)
   
   --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html
   
   
   -- To read all available tables execute this query:
   -- SELECT * FROM Tables
   
   -- Other common tables:
   -----------------------
   -- SELECT * FROM sys_db_object
   -- SELECT * FROM sys_dictionary
   -- SELECT * FROM sys_user
   -- SELECT * FROM sys_user_has_role
   -- SELECT * FROM sys_user_grmember
   -- SELECT * FROM task
   -- SELECT * FROM task_sla
   -- SELECT * FROM incident
   -- SELECT * FROM incident_sla
   -- SELECT * FROM change_request
   -- SELECT * FROM cmdb_ci_computer
   -- SELECT * FROM cmdb_ci_outage
   -- SELECT * FROM cmdb_ci
   -- SELECT * FROM sn_customerservice_case
   -- SELECT * FROM kb_knowledge
   -- SELECT * FROM kb_use
   -- SELECT * FROM sc_req_item
   -- SELECT * FROM sc_request
   -- SELECT * FROM sc_task

   
   Some parameters configured in this window will be passed to the ServiceNow API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in C#:

   

   ZappySys API Driver - ServiceNow

   Allows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access.

   ServicenowDSN

   SELECT * FROM incident 
   
   --Using Primary Key				
   --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause
   
   --Using Filter Expression
   --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition
   --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition
   --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition
   --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition
   --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition
   --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition
   --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator)  -- (number=INC0000001 and state=7) OR (number=INC0000002)
   
   --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html
   
   
   -- To read all available tables execute this query:
   -- SELECT * FROM Tables
   
   -- Other common tables:
   -----------------------
   -- SELECT * FROM sys_db_object
   -- SELECT * FROM sys_dictionary
   -- SELECT * FROM sys_user
   -- SELECT * FROM sys_user_has_role
   -- SELECT * FROM sys_user_grmember
   -- SELECT * FROM task
   -- SELECT * FROM task_sla
   -- SELECT * FROM incident
   -- SELECT * FROM incident_sla
   -- SELECT * FROM change_request
   -- SELECT * FROM cmdb_ci_computer
   -- SELECT * FROM cmdb_ci_outage
   -- SELECT * FROM cmdb_ci
   -- SELECT * FROM sn_customerservice_case
   -- SELECT * FROM kb_knowledge
   -- SELECT * FROM kb_use
   -- SELECT * FROM sc_req_item
   -- SELECT * FROM sc_request
   -- SELECT * FROM sc_task

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the ServiceNow API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in ServiceNow servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in C#

Using ODBC DSN

1. Create a new Console project and use this code to read the data:
   

   "ServicenowDSN";

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "ServicenowDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - ServiceNow

   Allows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access.

   ServicenowDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = @"DRIVER={ZappySys API Driver};ServiceUrl=https://[$InstanceName$].service-now.com/api/now;CredentialType=Basic;UserName=[$UserName$];Password=[$Password$];RetryMode=[$RetryMode$];RetryCountMax=[$RetryCountMax$];RetryMultiplyWaitTime=[$RetryMultiplyWaitTime$];RetryStatusCodeList=[$RetryStatusCodeList$];";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in C# with no problems.

Actions supported by ServiceNow Connector

Learn how to perform common ServiceNow actions directly in C# with these how-to guides:

• Delete a Table Row
• Delete table row
• Get List of System Tables - Admin (Use sys_db_object)
• Get List of Tables
• Get List of Tables - Admin (Use sys_db_object)
• Get List of User Tables - Admin (Use sys_db_object)
• Get Table Columns
• Get Table Columns - Admin (Use sys_dictionary)
• Get Table Rows
• Update a Table Row
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to ServiceNow in C# and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to ServiceNow, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download ServiceNow Connector for C# and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download ServiceNow Connector for C# Documentation

More integrations

Other connectors for C#

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for ServiceNow

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: