ServiceNow
ServiceNow improves service levels, energizes employees, and enables your enterprise to work at lightspeed. Create, read and update records stored within ServiceNow including Incidents, Questions, Users and more.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - China Cloud operated by 21Vianet |
| Logic Apps | Standard | All Logic Apps regions except the following: - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - China Cloud operated by 21Vianet |
| Power Automate | Premium | All Power Automate regions except the following: - China Cloud operated by 21Vianet |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.servicenow.com/ |
| Privacy policy | https://www.servicenow.com/privacy-statement.html |
| Categories | Website |
Note
The Get Knowledge Articles operation can only be used when the Knowledge API (sn_km_api) plugin is activated.
Security and governance
Important
This connector exposes generic create, read, update, and delete actions on any ServiceNow table. When you use it through an AI agent or MCP server, instructions in a skill or prompt reduce risk but are not a security control. A large language model does not follow instructions deterministically.
Before you use this connector, configure granular access controls in ServiceNow:
- Use a dedicated integration account, not a personal or administrator account.
- Grant the account only the roles and table ACLs it needs (least privilege).
- Deny write access to approvals, roles, ACLs, credentials, and user state, and to any table the agent does not need.
- Review the account's audit trail regularly.
Configuration items (CMDB)
- Create or update configuration items uses the ServiceNow Identification and Reconciliation (IRE) engine, so duplicates are avoided. The connection user needs the
itilorassetrole. Set Data Source to adiscovery_sourcechoice value, or ServiceNow does not commit the payload. ServiceNow returns 200 even when single CIs fail, so checksummary.hasErrorsin the response. - Add configuration item relations adds typed relations through the CMDB Instance API. Repeating an identical add returns the existing relation, so no duplicate is created. Use it instead of Create Record on
cmdb_rel_ci, which does not check for duplicates. - To remove a relation, use Delete Record on the
cmdb_rel_citable with the relation sys_id. - To delete a CI, use Delete Record on its class table. ServiceNow also removes the CI's relations.
- For other CMDB reads, use Get Records with a
cmdb_ci*table. - Get Record Types returns every table (thousands). Set Search (matches name or label), Limit (1-500, default 50) and Offset to get a page;
metashowstotalandhasMore. Without these inputs the full list is returned.
Known Issues and Limitations
When using the Create Record action, it's not possible to specify the full record description. The field value will be ignored due to Service-Now REST API limitations.
The Get Records action may return an "Invalid Table" or other error in Power Apps. For Power Apps implementations the suggested work around is to utilize the Get Records action in Power Automate and pass the data back to Power Apps.
The connector currently supports only instance URLs ending with "service-now.com". Using alternative domains such as "servicenowservices.com" may lead to connection errors. In such cases—particularly when working with new ServiceNow domain in GCC — it is recommended to use Basic Authentication.
If you encounter a popup error stating "Invalid redirect_uri", copy the full URL from the popup window and extract the redirect_uri parameter (e.g., redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). After decoding the URL (replacing %3a with : and %2f with /), update the Redirect URL field in your ServiceNow instance’s OAuth app registry as shown in image below. Then, try re-adding the connection.

How to set up a ServiceNow Power Platform connection that uses Microsoft Entra ID
There are two connection types:
Microsoft Entra ID OAuth using Certificate: This is an app-token based authentication type where an application registered in Entra ID can be used to access ServiceNow by getting a token with the resource set as the ServiceNow representative Entra ID app.
Microsoft Entra ID OAuth using User Login: This is a user-token based authentication type where the end user can sign into the Entra ID 1P application (ServiceNow Connector 1p App) and get an access token with the scope set for the ServiceNow representative Entra ID app.
Steps to create a Microsoft Entra ID OAuth connection using Certificate
Step 1: Register an "Application A" in Microsoft Entra ID for OIDC Integration with ServiceNow. This is the ServiceNow representative Entra ID application.
Go to App registrations > New registration to create a new application registration
Name: any name of choice
Redirect URI: not required
Add
aud,email&upnto the claims under "Optional claims"


Step 2: Register the same ID as an OIDC provider in ServiceNow
Navigate to
System OAuth > Application Registry > New > Configure an OIDC providerto verify ID tokens- Name: any name of choice
- Client ID: the
client IDof "Application A" created in Step 1 - Client Secret: this will not actually be used, any value can be set
In the OIDC provider registration form, add a new OIDC provider configuration. Select the search icon against the OAuth OIDC Provider Configuration field to open the records of OIDC configurations, select "New".
- OIDC Provider: Microsoft Entra ID
- OIDC Metadata URL: The URL must be in the form
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, replacetenantIDwithDirectory (tenant) ID - OIDC Configuration Cache Life Span: 120
- Application: Global
- User Claim: oid
- User Field: User ID
- Enable JTI claim verification: Disabled
Select "Submit" and update the OAuth OIDC Entity form

Step 3: Register an "Application B" in Microsoft Entra ID for Connector Usage. This is the Application which plays the role of a user with elevated permissions in the ServiceNow instance
Navigate to
App registrations > New registrationto create a new app- Name: any name of choice
- In Certificates & secrets, upload the .cer file of the certificate
In case of SNI certificate, just add
trustedCertificateSubjectsin the manifest of the application with the relevantauthorityIdandsubjectName
Step 4: Create a System User in ServiceNow. This is the "Application B" as a user in the ServiceNow instance
Navigate to
User Administration > Usersto create a new user- User ID: The object ID of the service principal of "Application B" created in Step 3
- Check
Web service access only
Step 5: Connect Using the Connector – Copilot Studio – Connector configuration
Configure the connector with the following information and connect:
- Instance Name: The instance name of ServiceNow
- Tenant ID: The tenant ID of the Microsoft Entra tenant
- Client ID: The client ID of "Application B" created in Step 3
- Resource URI: The client ID of "Application A" created in Step 1 (not the Application URI)
- Client Certificate Secret: The .pfx file of the certificate created in Step 3
- Certificate Password: The password of the .pfx file
Steps to create Microsoft Entra ID OAuth User login
To configure a Microsoft Entra ID OAuth User Login connection, please complete Step 1 and Step 2 as outlined in the certificate authentication section above.
Step 1 stays the same. In Step 2, update the user claim to Upn or custom claim property from the token (for third-party identity providers other than Entra) in ServiceNow. The user field should match the ServiceNow system user table field containing the upn or user ID.

Steps 3 and 4 from the certificate authentication section above are not required. Instead, "Application B" in this case is a 1p App which is created for the ServiceNow connector. The below app needs to be granted permissions in the "Application A".
"Application B" ID: c26b24aa-7874-4e06-ad55-7d06b1f79b63
Important
In this scenario "Application B" must use ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 which is a pre-existing 1p App owned by Microsoft, not a user-created app (as is required for creating a Microsoft Entra ID OAuth connection using Certificate).

While creating the connection for the ServiceNow connector, the user needs to select "Microsoft Entra ID User Login" as the authentication type and only needs to provide the ServiceNow Instance name and the resource ID (which would be the identifier for "Application A"). After this, the sign-in button will take user through the Entra ID login using their own account.

Using a 3rd Party identity provider, or data mismatches existing between the user in Entra ID and the ServiceNow users table
- If there is a mismatch between the user identifier property in the Entra ID token and the user identifier value thats in the ServiceNow table
- For example, the token contains the full upn (along with domain –
abc@contoso.com) and the ServiceNow users table only contains the user identifier (abc). It is recommended to add a custom attribute to the token that contains a value which matches the user identifier in the ServiceNow identifier by applying a formula, and then leveraging that new property to do the claim mapping in Step 2. - Microsoft Learn Documentation describing the process of adding a new claim property: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- For example, the token contains the full upn (along with domain –
"How to set up a ServiceNow Power Platform connection that uses Microsoft Entra ID" references:
- External ID Token Authentication (OIDC) for Rest APIs - Support and Troubleshooting
- ServiceNow Catalog Microsoft Graph connector | Microsoft Learn
Creating a connection
The connector supports the following authentication types:
| Basic Authentication | Sign in using basic authentication | All regions | Not shareable |
| Microsoft Entra ID OAuth using Certificate | OAuth with Microsoft Entra ID using PFX certificate. | POWERPLATFORM only | Shareable |
| Microsoft Entra ID User Login | Login with Microsoft Entra ID Credentials | All regions | Not shareable |
| Use Oauth2 | Sign in with Oauth2 | All regions | Not shareable |
| Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
Basic Authentication
Auth ID: basicAuthentication
Applicable: All regions
Sign in using basic authentication
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Instance | string | Name of the instance for service-now.com or custom URL for migrated account | True |
| Username | string | Username for this instance | True |
| Password | securestring | The password for this account | True |
Microsoft Entra ID OAuth using Certificate
Auth ID: aadOAuthCert
Applicable: POWERPLATFORM only
OAuth with Microsoft Entra ID using PFX certificate.
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| Instance Name | string | The instance name used to identify the ServiceNow Site URl | True |
| Tenant ID | string | True | |
| Client ID | string | True | |
| Resource URI | string | True | |
| Client certificate secret | clientCertificate | The client certificate secret allowed by this application | True |
Microsoft Entra ID User Login
Auth ID: entraIDUserLogin
Applicable: All regions
Login with Microsoft Entra ID Credentials
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Resource URI | string | True | |
| Instance Name | string | The instance name used to identify the ServiceNow Site URL | True |
Use Oauth2
Auth ID: oauth2ServiceNow
Applicable: All regions
Sign in with Oauth2
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Instance Name | string | The instance name used to identify the ServiceNow Site URl | True |
| Client Id | string | The ID used to identify this application with the service provider | True |
| Client secret | securestring | The shared secret used to authenticate this application with the service provider | True |
Default [DEPRECATED]
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Instance | string | Name of the instance for service-now.com or custom URL for migrated account | True |
| Username | string | Username for this instance | True |
| Password | securestring | The password for this account | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 600 | 60 seconds |
Actions
| Add configuration item relations |
Adds inbound or outbound relations to a configuration item (CI). The inbound and outbound relation fields set the direction. |
| Create or update configuration items |
Creates or updates configuration items (CIs) in CMDB. Use this instead of direct CMDB tables. Always check summary.hasErrors in response for individual CI fails. |
| Create Record |
Creates a record in a ServiceNow table, for example incident or change_request. |
| Delete an attachment |
Delete an attachment |
| Delete Record |
Deletes a record from a ServiceNow table, for example incident or change_request |
| Get Attachment Metadata |
Retrieve metadata for attachments |
| Get catalog categories |
Retrieves list of categories for a specific catalog |
| Get catalog item |
Retrieve a specific catalog item. |
| Get catalog items |
Lists catalog items, optionally by search text or catalog. |
| Get catalogs |
Retrieves a list of catalogs |
| Get Knowledge Article |
Returns the full content of a knowledge base (KB) article, including template sections. |
| Get Knowledge Articles |
Returns a list of knowledge base (KB) articles which can be searched and filtered |
| Get Record |
Gets a record from a ServiceNow table, for example incident or change_request |
| Get Record Types |
Lists the available record types. Use search, limit and offset to page the result. With any of these inputs, an unreadable ServiceNow response returns 502. |
| List Records |
Gets records from a ServiceNow table, for example incident or change_request |
| Order item |
Orders or buys a specific catalog item. |
| Retrieve attachment content |
Retrieve attachment content |
| Retrieve attachment metadata |
Retrieve attachment metadata |
| Update Record |
Updates a record in a ServiceNow table, for example incident or change_request |
| Upload a binary file as an attachment |
Uploads a binary file as an attachment to a specified record |
| Upload a multipart file attachment |
Upload an attachment from a multipart form |
Add configuration item relations
Adds inbound or outbound relations to a configuration item (CI). The inbound and outbound relation fields set the direction.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
CI Class
|
className | True | string |
CMDB class (table) name of the CI, such as cmdb_ci_linux_server. |
|
CI ID
|
sys_id | True | string |
The sys_id of the CI to add the relations to. |
|
Source
|
source | True | string |
Source of the relations. Must be a discovery_source choice value on cmdb_ci. |
|
Related CI ID
|
target | True | string |
The sys_id of the related CI from the Configuration Item [cmdb_ci] table. |
|
Relationship Type ID
|
type | True | string |
The sys_id of the relationship type (cmdb_rel_type). |
|
Related CI ID
|
target | True | string |
The sys_id of the related CI from the Configuration Item [cmdb_ci] table. |
|
Relationship Type ID
|
type | True | string |
The sys_id of the relationship type (cmdb_rel_type). |
Returns
Create or update configuration items
Creates or updates configuration items (CIs) in CMDB. Use this instead of direct CMDB tables. Always check summary.hasErrors in response for individual CI fails.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data Source
|
sysparm_data_source | True | string |
Source of the CI data. Must be a discovery_source choice value on cmdb_ci. Required. |
|
CI Class
|
className | True | string |
The sys_class_name (table) of the CI, such as cmdb_ci_linux_server. |
|
Internal ID
|
internal_id | string |
Identifier of this item inside the payload. It must be unique in the payload. |
|
|
Values
|
values | object |
Field values of the CI as name and value pairs. |
|
|
Lookup
|
Lookup | object | ||
|
Related Items
|
Related Items | object | ||
|
Settings
|
settings | object |
Optional flags that limit the update, such as updateWithoutDowngrade. |
|
|
Source Information
|
sys_object_source_info | object |
Optional unique identifier of the CI at its source. |
Returns
Create Record
Creates a record in a ServiceNow table, for example incident or change_request.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record Type
|
tableType | True | string |
Name of the ServiceNow table, for example incident, change_request or a custom table. |
|
body
|
body | True | dynamic | |
|
Display System References
|
sysparm_display_value | boolean |
Determines if system references should be included |
|
|
Exclude Reference Links
|
sysparm_exclude_reference_link | boolean |
Determines if reference links should be excluded |
|
|
Fields
|
sysparm_fields | string |
Comma-separated list of fields to be returned. Example: name,email,phone |
Returns
Delete an attachment
Delete an attachment
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Sys ID
|
sys_id | True | string |
Sys_id of the attachment to delete |
Delete Record
Deletes a record from a ServiceNow table, for example incident or change_request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record Type
|
tableType | True | string |
Name of the ServiceNow table, for example incident, change_request or a custom table. |
|
System ID
|
sysid | True | string |
System ID for the record. |
Get Attachment Metadata
Retrieve metadata for attachments
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | string |
Maximum records to return. Default 1000. |
|
|
Offset
|
sysparm_offset | string |
Number of records to skip. Use it to get the next page. Default 0. |
|
|
Query
|
sysparm_query | string |
Encoded query on sys_attachment. Example: file_name=attachment.doc |
Get catalog categories
Retrieves list of categories for a specific catalog
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Catalog ID
|
catalogId | True | string |
The id of the catalog for which to retrieve categories |
|
Limit
|
sysparm_limit | integer |
Number of catalog categories to retrieve |
|
|
Offset
|
sysparm_offset | integer |
Offset for the query |
Returns
Get catalog item
Retrieve a specific catalog item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
The sys_id of the catalog item to retrieve |
Returns
Get catalog items
Lists catalog items, optionally by search text or catalog.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Category
|
sysparm_category | string |
The category ID to filter items by. If not specified, all items are returned. |
|
|
Limit
|
sysparm_limit | True | integer |
Number of catalog items to retrieve |
|
Search Text
|
sysparm_text | string |
Search text to filter items by |
|
|
Catalog
|
sysparm_catalog | string |
The catalog ID to filter items by. If not specified, items from all catalogs are returned |
Returns
Get catalogs
Retrieves a list of catalogs
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | integer |
Number of catalogs to retrieve |
|
|
Search Text
|
sysparm_text | string |
Search text to filter catalogs by name or description |
Returns
- Body
- GetCatalogsResponse
Get Knowledge Article
Returns the full content of a knowledge base (KB) article, including template sections.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Article Sys ID
|
articleSysId | True | string |
The sys_id or KB number of the knowledge article to retrieve. |
|
Fields
|
fields | string |
Comma-separated list of fields from the Knowledge table to return. |
|
|
Language
|
language | string |
Comma-separated list of languages of the KB article to return. |
Returns
- Body
- GetArticleResponse
Get Knowledge Articles
Returns a list of knowledge base (KB) articles which can be searched and filtered
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Comma-separated list of fields from the Knowledge table. |
|
|
Limit
|
limit | integer |
Maximum number of records to return. |
|
|
Query
|
query | True | string |
Text to search for. |
|
Filter
|
filter | string |
Encoded query to use to filter the result set. |
|
|
Kb
|
kb | string |
Comma-separated list of knowledge base sys_ids. |
Returns
- Body
- GetArticlesResponse
Get Record
Gets a record from a ServiceNow table, for example incident or change_request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record Type
|
tableType | True | string |
Name of the ServiceNow table, for example incident, change_request or a custom table. |
|
System ID
|
sysid | True | string |
System ID for the record. |
|
Display System References
|
sysparm_display_value | boolean |
Determines if system references should be included |
|
|
Exclude Reference Links
|
sysparm_exclude_reference_link | boolean |
Determines if reference links should be excluded |
|
|
Fields
|
sysparm_fields | string |
Comma-separated list of fields to be returned. Example: name,email,phone |
Returns
Get Record Types
Lists the available record types. Use search, limit and offset to page the result. With any of these inputs, an unreadable ServiceNow response returns 502.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search
|
search | string |
Return only record types whose name or label contains this text |
|
|
Limit
|
limit | integer |
Maximum record types to return, 1 to 500. Default 50 when search or offset is set. Without search, limit and offset, all record types are returned. |
|
|
Offset
|
offset | integer |
Number of matching record types to skip, sorted by name |
Returns
- Body
- GetTypesResponse
List Records
Gets records from a ServiceNow table, for example incident or change_request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record Type
|
tableType | True | string |
Name of the ServiceNow table, for example incident, change_request or a custom table. |
|
Display System References
|
sysparm_display_value | boolean |
Determines if system references should be included |
|
|
Exclude Reference Links
|
sysparm_exclude_reference_link | boolean |
Determines if reference links should be excluded |
|
|
Query
|
sysparm_query | string |
Encoded query used to filter the result set. Example: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limit
|
sysparm_limit | integer |
Limit to be applied on pagination. The default is 10000. |
|
|
Offset
|
sysparm_offset | integer |
Number of records to exclude from the query. |
|
|
Fields
|
sysparm_fields | string |
Comma-separated list of fields to be returned. Example: name,email,phone |
Returns
Order item
Orders or buys a specific catalog item.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
The sys_id of the catalog item to order |
|
Order Item Body
|
body | True | dynamic |
Quantity, requested-for user, and item variables. |
Returns
- Body
- OrderItemResponse
Retrieve attachment content
Retrieve attachment content
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Sys ID
|
sys_id | True | string |
Sys_id of the attachment to retrieve content for |
Retrieve attachment metadata
Retrieve attachment metadata
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
sys_id | True | string |
Sys_id of the attachment to retrieve metadata for |
Update Record
Updates a record in a ServiceNow table, for example incident or change_request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Record Type
|
tableType | True | string |
Name of the ServiceNow table, for example incident, change_request or a custom table. |
|
System ID
|
sysid | True | string |
System ID for the record. |
|
body
|
body | True | dynamic | |
|
Display System References
|
sysparm_display_value | boolean |
Determines if system references should be included |
|
|
Exclude Reference Links
|
sysparm_exclude_reference_link | boolean |
Determines if reference links should be excluded |
|
|
Fields
|
sysparm_fields | string |
Comma-separated list of fields to be returned. Example: name,email,phone |
Returns
Upload a binary file as an attachment
Uploads a binary file as an attachment to a specified record
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Table Name
|
table_name | True | string |
Name of the table to which you want to attach the file |
|
Sys ID
|
table_sys_id | True | string |
Sys_id of the record on the specified table to which you want to attach the file |
|
File Name
|
file_name | True | string |
Name to give the attachment |
|
File
|
file | True | binary |
Binary file to attach to the specified record |
Returns
Upload a multipart file attachment
Upload an attachment from a multipart form
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Table Name
|
table_name | True | string |
Name of the table to which you want to attach the file. |
|
Table Id
|
table_sys_id | True | string |
Sys_id of the record on the specified table to which you want to attach the file |
|
Attachment content
|
attachment_content | True | file |
Attachment to upload. Must be the last part of the multipart form. |
Returns
Definitions
UpsertConfigurationItemsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
result.items | array of ReconciledItem |
Outcome for each submitted CI. |
|
Additional Items
|
result.additionalCommittedItems | array of ReconciledItem |
CIs that were committed but were not part of the request. |
|
Relations
|
result.relations | array of object |
Relations processed with the items. |
|
items
|
result.relations | object | |
|
Additional Relations
|
result.additionalCommittedRelations | array of object |
Relations that were committed but were not part of the request. |
|
items
|
result.additionalCommittedRelations | object | |
|
Processed Items
|
summary.processedItems | integer |
Number of CIs that ServiceNow reported. |
|
Failed Items
|
summary.failedItems | integer |
Number of CIs that reported errors or an unreadable error value. |
|
Processed Relations
|
summary.processedRelations | integer |
Number of relations that ServiceNow reported. |
|
Failed Relations
|
summary.failedRelations | integer |
Number of relations that reported errors or an unreadable error value. |
|
Has Errors
|
summary.hasErrors | boolean |
True when at least one CI or relation failed, or ServiceNow set result.hasError to true or to an unreadable value. |
|
Failures
|
summary.failures | array of object |
The CIs and relations that reported errors. |
|
Section
|
summary.failures.section | string |
Result section of the failed entry: items, additionalCommittedItems, relations, or additionalCommittedRelations. |
|
CI Class
|
summary.failures.className | string |
Class of the CI or relation that failed. |
|
Input Indices
|
summary.failures.inputIndices | array of integer |
Positions of the failing entry in the request items array. For relation sections, positions refer to relations that ServiceNow derived. |
|
Errors
|
summary.failures.errors | array of object |
Errors reported for the CI or relation. The connector adds MALFORMED_RESPONSE when ServiceNow returned an unreadable errors or errorCount value. |
|
error
|
summary.failures.errors.error | string |
Type of the error. |
|
message
|
summary.failures.errors.message | string |
Error message. |
ReconciledItem
| Name | Path | Type | Description |
|---|---|---|---|
|
CI Class
|
className | string |
The sys_class_name of the CI. |
|
CI ID
|
sysId | string |
The sys_id of the CI that was created or updated. |
|
Operation
|
operation | string |
What IRE did with the CI, such as INSERT, UPDATE, or NO_CHANGE. |
|
Error Count
|
errorCount | integer |
Number of errors for this CI. |
|
Errors
|
errors | array of object |
Errors for this CI. |
|
error
|
errors.error | string |
Type of the error. |
|
message
|
errors.message | string |
Error message. |
|
Input Indices
|
inputIndices | array of integer |
Positions of the request items that produced this CI. |
|
Markers
|
markers | array of string |
IRE markers for this CI. |
LinkConfigurationItemsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Attributes
|
result.attributes | object |
Current attributes of the CI. The attributes depend on the CI class. |
|
Inbound Relations
|
result.inbound_relations | array of CIRelation |
Inbound relations of the CI. |
|
Outbound Relations
|
result.outbound_relations | array of CIRelation |
Outbound relations of the CI. |
CIRelation
| Name | Path | Type | Description |
|---|---|---|---|
|
Relation ID
|
sys_id | string |
The sys_id of the relation (cmdb_rel_ci). |
|
value
|
target.value | string |
The sys_id of the related CI. |
|
display_value
|
target.display_value | string |
Display name of the related CI. |
|
link
|
target.link | string |
Link to the related CI. |
|
value
|
type.value | string |
The sys_id of the relationship type. |
|
display_value
|
type.display_value | string |
Display name of the relationship type. |
|
link
|
type.link | string |
Link to the relationship type. |
GetArticleResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Number
|
result.number | string |
The KB number of the article. |
|
Sys ID
|
result.sys_id | string |
The sys_id of the article. |
|
Short Description
|
result.short_description | string |
The short description (title) of the article. |
|
Text
|
result.text | string |
Body of standard articles. Empty for template articles; see content. |
|
Template
|
result.template | boolean |
True for a template article; its body is in content. |
|
Template Table
|
result.template_table | string |
Template table of a template article, for example kb_template_how_to. |
|
Language
|
result.language | string |
The language of the returned article. |
|
Content
|
result.content | array of object |
The assembled template sections for template/Knowledge-Block articles. |
|
Label
|
result.content.label | string |
The display label of the template section. |
|
Column
|
result.content.column | string |
The template column backing the section. |
|
Type
|
result.content.type | string |
The content type of the section (for example html). |
|
Content
|
result.content.content | string |
The section body. |
UploadAttachmentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
If the attachment is an image, the sum of all colors. |
|
compressed
|
result.compressed | string |
Flag that indicates whether the attachment file has been compressed. |
|
content_type
|
result.content_type | string |
Content type of the attachment file, for example image/png. |
|
created_by_name
|
result.created_by_name | string |
Full name of entity that originally created the attachment file. |
|
download_link
|
result.download_link | string |
Download URL of the attachment on the ServiceNow instance. |
|
file_name
|
result.file_name | string |
File name of the attachment. |
|
image_height
|
result.image_height | string |
If an image file, the height of the image. Unit: Pixels |
|
image_width
|
result.image_width | string |
If an image file, the width of the image. Unit: Pixels |
|
size_bytes
|
result.size_bytes | string |
Size of the attachment. Unit: Bytes |
|
size_compressed
|
result.size_compressed | string |
Size of the attachment. Unit: Bytes |
|
sys_created_by
|
result.sys_created_by | string |
Entity that originally created the attachment file. |
|
sys_created_on
|
result.sys_created_on | string |
Date and time that the attachment file was initially saved to the instance. |
|
sys_id
|
result.sys_id | string |
Sys_id of the attachment file. |
|
sys_mod_count
|
result.sys_mod_count | string |
Number of times the attachment file has been modified (uploaded to the instance). |
|
sys_tags
|
result.sys_tags | string |
Any system tags associated with the attachment file. |
|
sys_updated_by
|
result.sys_updated_by | string |
Any system tags associated with the attachment file. |
|
sys_updated_on
|
result.sys_updated_on | string |
Date and time that the attachment file was last updated. |
|
table_name
|
result.table_name | string |
Name of the table to which the attachment is associated. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id of the table associated with the attachment. |
|
updated_by_name
|
result.updated_by_name | string |
Full name of entity that last updated the attachment file. |
GetTypesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object |
Result set of all record types for current instance. |
|
Display name
|
result.label | string |
Display name of the record type. |
|
Value
|
result.value | string |
Value of the record type. |
|
Total
|
meta.total | integer |
Number of matching record types. |
|
Offset
|
meta.offset | integer |
Number of matches skipped. |
|
Limit
|
meta.limit | integer |
Page size used. |
|
Has more
|
meta.hasMore | boolean |
True when more matches follow this page. |
GetCatalogsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object | |
|
title
|
result.title | string | |
|
sys_id
|
result.sys_id | string | |
|
has_categories
|
result.has_categories | boolean | |
|
has_items
|
result.has_items | boolean | |
|
description
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object | |
|
title
|
result.title | string | |
|
description
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
icon
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
subcategories
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItemsResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
result
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icon
|
result.icon | string | |
|
description
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
type
|
result.type | string | |
|
visible_standalone
|
result.visible_standalone | boolean | |
|
local_currency
|
result.local_currency | string | |
|
sys_class_name
|
result.sys_class_name | string | |
|
sys_id
|
result.sys_id | string | |
|
content_type
|
result.content_type | string | |
|
price
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
order
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
owner
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
picture
|
result.picture | string | |
|
url
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
catalogs
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
active
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
name
|
result.name | string | |
|
localized_recurring_price
|
result.localized_recurring_price | string | |
|
show_wishlist
|
result.show_wishlist | boolean | |
|
sys_id
|
result.category.sys_id | string | |
|
title
|
result.category.title | string | |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean | |
|
show_delivery_time
|
result.show_delivery_time | boolean |
GetCatalogItemResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icon
|
result.icon | string |
icon |
|
description
|
result.description | string |
description |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
type
|
result.type | string |
type |
|
visible_standalone
|
result.visible_standalone | boolean |
visible_standalone |
|
sys_class_name
|
result.sys_class_name | string |
sys_class_name |
|
sys_id
|
result.sys_id | string |
sys_id |
|
content_type
|
result.content_type | string |
content_type |
|
order
|
result.order | integer |
order |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
owner
|
result.owner | string |
owner |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
picture
|
result.picture | string |
picture |
|
url
|
result.url | string |
url |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
active
|
result.catalogs.active | boolean |
active |
|
title
|
result.catalogs.title | string |
title |
|
name
|
result.name | string |
name |
|
show_wishlist
|
result.show_wishlist | boolean |
show_wishlist |
|
sys_id
|
result.category.sys_id | string |
sys_id |
|
title
|
result.category.title | string |
title |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean |
turn_off_nowassist_conversation |
|
show_delivery_time
|
result.show_delivery_time | boolean |
show_delivery_time |
|
categories
|
result.categories | array of object |
categories |
|
sys_id
|
result.categories.sys_id | string |
sys_id |
|
active
|
result.categories.active | boolean |
active |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
active
|
result.categories.category.active | boolean |
active |
|
title
|
result.categories.category.title | string |
title |
|
title
|
result.categories.title | string |
title |
|
variables
|
result.variables | array of object |
variables |
|
ui_policy
|
result.ui_policy | array of |
ui_policy |
|
onChange
|
result.client_script.onChange | array of |
onChange |
|
onSubmit
|
result.client_script.onSubmit | array of |
onSubmit |
|
onLoad
|
result.client_script.onLoad | array of |
onLoad |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
variablesSchema
|
result.variablesSchema | object |
OrderItemResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
number
|
result.number | string |
number |
|
request_number
|
result.request_number | string |
request_number |
|
request_id
|
result.request_id | string |
request_id |
|
table
|
result.table | string |
table |
GetArticlesResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
meta.type | string |
Always 'object' |
|
Count
|
meta.properties.count | integer |
Number of available KB articles |
|
End
|
meta.properties.end | integer |
Ending index of the result set |
|
Fields
|
meta.properties.fields | string |
Fields in the article |
|
Filter
|
meta.properties.filter | string |
Filter used to acquire the data |
|
Kb
|
meta.properties.kb | string |
List of knowledge base article sys_ids |
|
Language
|
meta.properties.language | string |
List of comma-separated languages of the KB articles that were requested |
|
Query
|
meta.properties.query | string |
Specified request query |
|
Start
|
meta.properties.start | integer |
Starting index of result set |
|
Status
|
meta.properties.status.code | integer |
Status of the call |
|
Text Search Query Id
|
meta.properties.ts_query_id | string |
Identifier of the text search query |
|
articles
|
articles | array of object | |
|
Fields
|
articles.fields | object |
Requested fields, keyed by field name |
|
id
|
articles.id | string |
Knowledge article sys_id from the Knowledge [kb_knowledge] table |
|
Number
|
articles.number | string |
Knowledge article number |
|
Rank
|
articles.rank | float |
Search rank of article specific to this search |
|
Score
|
articles.score | float |
Relevancy score, results sorted in descending order by score |
|
Snippet
|
articles.snippet | string |
Text showing a small portion of the knowledge article |
|
Title
|
articles.title | string |
Short description or title of the knowledge article |
|
Link
|
articles.link | string |
Link to the article |