Articles in this section

Available ServiceNow APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt ServiceNow connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the ServiceNow API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Account Query account by search query X
Query account by ID X
Agent schedule Log analytics X
Aggregate API Retrieve statistical calculations for a table X
Application service Get content X
Application service Internal API BS data - Internal API X
CI full data - Internal API X
Compare BS data - Internal API X
Compare CI full data - Internal API X
Compare service - Internal API X
Get all BS preferences - Internal API X
Get BS preference - Internal API X
Get baselines - Internal API X
Get service timeline - Internal API X
Get service timeline checkpoints - Internal API X
Is changed - Internal API X
Map - Internal API X
Map notifications - Internal API X
Map API - Internal API X
Related items full data - Internal API X
Remove baseline - Internal API X
Service tree data - Internal API X
Set BS preference - Internal API X
Update baseline - Internal API X
Was table updated since - Internal API X
Application service utils API Get map URL X
Assignment workbench Mandatory skill X
Attachment API Get metadata for multiple attachments X
Get metadata for the attachment file by Sys_ID value X
Delete the attachment with a specific Sys_ID value X
AWA agent API Get agent presence state and channel availability X
Set state of a specified agent presence X
AWA assignment API Assigns work item to work assignment agent X
AWA routing API Creates a work item X
Batch API Create multiple rest API requests in a single call X
Benchmark client API Retrieve categories X
Get groups by category X
Retrieve indicator scores X
Benchmark indicators X
Opt out feedback X
Cab workbench (Internal API) Get agenda item X
Get meeting agenda X
Get approval info X
User joined meeting X
Attendee info X
Change schedules meta X
Get meeting calendar X
End meeting X
Set no decision and next agenda item X
Set next agenda item X
Pause current agenda item X
Resume current agenda item X
Start meeting X
Get runtime state X
Calendar Configurations X
Events X
User info X
Case API Get customer service management (CSM) cases X
Get customer service management (CSM) cases X
Get activities for a customer service management (CSM) case X
Creates a new customer service management case X
Update customer service management case X
Central dispatch Agent events X
Configuration X
Log analytics X
Task events X
Task ordering X
Configuration X
Unassign task X
Change request calendar (Internal API) Related changes X
Change schedules meta X
Glide stack X
Ci lifecycle management API Get CI actions X
Get compatible actions X
Get lease expired X
Get not allowed action X
Get not allowed operational transition X
Get register operator X
Get validate requestor X
Get operational state X
Unregister an operator X
CMDB instance API Query records for a CMBD class X
Query attributes and relationship information for a specific record X
Read metadata for a CMBD class. X
Create a record with associated relations X
Create relation for the CI X
Replace CI record X
Update CI record X
Delete the relation for the specified CI X
CMDB UI API (Internal API) Identification lookup tables X
Validate X
Consumer Query consumer by search query X
Query consumer by ID X
Create consumer X
Contact Query contact by search query X
Query contact by ID X
Create contact X
Contextual search Contextual search parameter X
Continuous integration/continuous delivery (CI/CD) API Get current progress and status of progress ID X
Get results of a test suite run based on a specified results identifier X
Get results of a batch install of result identifier X
Copy assessments Copy X
Customer central API Customer information and configuration details X
Data classification API Get all data classifications X
Assign data classifications to existing dictionary entries X
Removes all data classifications for dictionary entries X
Retrieves all data classifications for dictionary entries X
Devops API Get schema object for a specified code resource X
Get schema object for a specified orchestration resource X
Get change request details for a specified orchestration pipeline execution X
Get current status of the specified onboarding event X
Email API Get an email X
Create a new email X
Global text search API Get an ordered list of all of the search groups available to the current user X
Search group[s] with a keyword-based query X
Guided setup API Get content details X
Get root content details X
Get children content details X
Guided tours Autolaunch - get tours for a page X
All - get tours for a page X
Standard UI - count of tours per page X
Standard UI - search for page names X
HR rest API Get an employee profile in the United States X
Identification and reconciliation API Inserts or updates configuration items X
Import set API Retrieve an import set record X
Create a record in an import set staging table X
Interaction API Create an interaction X
Close an interaction X
Interaction management API Create or updates a record in the interaction table X
Changes the state of an interaction to closed X
Interactive analysis (Internal API) Get saved preference values X
Knowledge management rest API Get list of knowledge base (KB) articles X
Get a knowledge article attachment as a file X
Get featured knowledge articles X
Get a specific knowledge article X
Get most-viewed knowledge articles X
List query Context query X
Manager calendar Groups X
Manager calendar Team members X
Manual CI Get BS domain ID X
Get CI types X
Get CIs by type X
Metricbase time series API Get specified time series data from metric base database X
Transforms specified data based on specified parameters X
Create metric values at specified timestamp X
Adds time series data to the metric base database X
Order API Retrieves complete order details X
Create a new order X
Predictive intelligence API Get a predictive intelligence-specific solution X
Get predictions for multiple solutions X
Product catalog open API Get a list of all product offering catalogs X
Get a product offering catalog X
Get all product offerings X
Get a product offering X
Get all product specifications. X
Get a product specification X
Creates a product offering catalog X
Creates a product offering X
Creates a product specification X
Product inventory open API Get a list of all product inventories X
Get a product inventory X
Creates a product inventory X
Reporting API Retrieve the list of reports X
Reporting API: Favorites Retrieve the list of favorite reports X
Update a report from favorites X
Remove a report from favorites X
SA business service Get number of candidates X
Load initial page data X
Schedule page API Get event X
Get custom info X
Get page info X
Scorecards API Retrieve list of scorecards X
Favorites a scorecard X
Unfavorites a scorecard X
Service catalog API List of catalogs X
Specific catalog X
List of categories for a catalog X
Retrieves details of a category X
Get list of catalog items X
Retrieves details of a specific catalog item X
Default cart contents X
Get shipping address X
Add item to cart X
Add item to wishlist X
Checkout items of an order guide X
Buy item X
Update cart item X
Delete items from cart X
Delete empty cart X
Skill management Log analytics X
SLA (Internal API) Get SLA definition X
Get task SLA timeline X
Special handling notes Messages X
Alertseen X
Table API Retrieve records from a table X
Retrieve a record using Sys_ID X
Create X
Update X
Delete X
Retrieve records from a table X
Retrieve a record using Sys_ID X
Create X
Update X
Delete X
UI glide record API Query records from a table X
Retrieve a record using Sys_ID X
Create X
Update X
Delete X
User role inheritance Retrieve details of the user roles inheritance X
Vcs List applications X
Get application X
List local changes X
Has local changes X
List branches X
Has remote changes X
Get history X
Get current stash preview X
List stashes X
Get stash X
List tags X
Is in repository X
Plugin installed X
Get progress X

Available DI objects

The following objects are available when using ServiceNow as a source in Celigo Data Integration (DI).

Primary key: All ServiceNow DI endpoints use sys_id as the primary key, except Scorecards which uses uuid. ServiceNow assigns a 32-character GUID sys_id to every record across all tables.

Note

ServiceNow supports both soft and hard deletes. Records can be deactivated via the active field, but hard deletes permanently remove records from the system. Celigo syncs all data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Account Query account by search query Full, Incremental sysparm_query
Calendar Events Full —
Case API Get customer service management (csm) cases Full, Incremental sysparm_query
Centraldispatch Task events Full —
Consumer Query consumer by search query Full, Incremental sysparm_query
Contact Query contact by search query Full, Incremental sysparm_query
Knowledge management rest API Get list of knowledge base (kb) articles Full —
Manager calendar Groups Full —
Product catalog open API Get a list of all product offering catalogs Full —
Product inventory open API Get a list of all product inventories Full —
Scorecards API Retrieve list of scorecards Full, Incremental sysparm_from

Response schemas

Click an object below to view its response fields and delta configuration.

Account — Query account by search query

Delta configuration: use it to request incremental data.

Setting Value
Delta filter sysparm_query = sys_updated_on>{{{lastExportDateTime}}}
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
sys_id string (Primary key)
name string
email string
phone string
status string
sys_created_on string
sys_updated_on string
Calendar — Events

Response schema:

Field Type
sys_id string (Primary key)
title string
start_time string
end_time string
location string
description string
attendees objectarray
attendees.attendee_id string
attendees.attendee_name string
Case API — Get customer service management (csm) cases

Delta configuration: use it to request incremental data.

Setting Value
Delta filter sysparm_query = sys_updated_on>{{{lastExportDateTime}}}
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
sys_id string (Primary key)
number string
short_description string
description string
priority number
state number
assigned_to object
assigned_to.sys_id string
assigned_to.name string
opened_at string
closed_at string
comments objectarray
comments.sys_id string
comments.comment string
comments.sys_created_on string
Centraldispatch — Task events

Response schema:

Field Type
sys_id string (Primary key)
event_type string
event_time string
task_id string
user_id string
status string
details object
details.description string
details.additional_info objectarray
details.additional_info.info_key string
details.additional_info.info_value string
Consumer — Query consumer by search query

Delta configuration: use it to request incremental data.

Setting Value
Delta filter sysparm_query = sys_updated_on>{{{lastExportDateTime}}}
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
sys_id string (Primary key)
name string
email string
phone string
address object
address.street string
address.city string
address.state string
address.zip string
sys_created_on string
sys_updated_on string
Contact — Query contact by search query

Delta configuration: use it to request incremental data.

Setting Value
Delta filter sysparm_query = sys_updated_on>{{{lastExportDateTime}}}
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
sys_id string (Primary key)
name string
email string
phone string
address object
address.street string
address.city string
address.state string
address.zip string
sys_created_on string
sys_updated_on string
Knowledge management rest API — Get list of knowledge base (kb) articles

Response schema:

Field Type
sys_id string (Primary key)
title string
content string
created string
updated string
author string
category string
tags stringarray
status string
Manager calendar — Groups

Response schema:

Field Type
sys_id string (Primary key)
name string
description string
manager_id string
sys_created_on string
sys_updated_on string
Product catalog open API — Get a list of all product offering catalogs

Response schema:

Field Type
sys_id string (Primary key)
name string
description string
lastUpdate string
validFor object
validFor.startDateTime string
validFor.endDateTime string
productSpecification object
productSpecification.id string
productSpecification.name string
sys_created_on string
sys_updated_on string
Product inventory open API — Get a list of all product inventories

Response schema:

Field Type
sys_id string (Primary key)
name string
description string
status string
productOffering object
productOffering.id string
productOffering.name string
productSpecification object
productSpecification.id string
productSpecification.version string
isBundle boolean
sys_created_on string
sys_updated_on string
Scorecards API — Retrieve list of scorecards

Delta configuration: use it to request incremental data.

Setting Value
Delta filter sysparm_from = {{{lastExportDateTime}}}
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
uuid string (Primary key)
name string
description string
value_formatted string
target_formatted string
gap_formatted string
frequency_label string
direction_label string
indicator object
indicator.display_value string
indicator.value string
key boolean
favorite boolean