Retrieve ServiceNow Incident Tickets: Service details

Ops Center Automator User Guide

Version
10.8.x
File Size
3.6 MB
Audience
anonymous
Part Number
MK-99AUT001-14

This service enables you to retrieve an incident ticket or a group of incident tickets.

The following service template details apply to the Retrieve ServiceNow Incident Tickets service template.

This service template does not have an associated service.

Software and setup prerequisites

For software and setup prerequisites, see Service template prerequisites.

Edit Service settings

The following table lists the Edit Service settings for the Retrieve ServiceNow Incident Tickets service template.

Navigation pane Settings pane Description
ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection.

This setting is required.

sys_id Specify the system ID (sys_id) of the ticket to retrieve information for a single ticket.
Query Parameters sysparm_display_value

Whether to return the actual values of the field or return the display values.

  • false: Return only the actual values.
  • true: Return only the display values.
  • all: Return both.
sysparm_exclude_reference_link

Whether to add detailed information for the reference field.

  • false: Do not add
  • true: Add
sysparm_fields

Specify the field names you want to return in the response in comma-separated values.

The specified value will be encoded before sending a Table API request.

sysparm_view

A parameter that renders the response according to the specified UI view.

The specified value will be encoded before sending a Table API request.

This is overridden by sysparm_fields.

sysparm_query

Specify the query string that filters the response data.

The specified value will be encoded before sending a Table API request.

(Only for multiple information acquisition)

sysparm_suppress_pagination_header

Whether to suppress the pagination header.

(Only when acquiring multiple pieces of information.)

  • false: Do not suppress
  • true: Suppress
sysparm_limit

Specify the maximum number of results returned per page. (default: 10,000)

(Only when acquiring multiple pieces of information.)

sysparm_query_category

Specify the name of the query category (read replica category) to use for queries.

The specified value will be encoded before sending a Table API request.

(Only when acquiring multiple pieces of information.)

sysparm_query_no_domain Whether to restrict the record search to only the domains for which the logged in user is configured.
  • false: Restrict
  • true: Do not restrict

If this setting is omitted, the default is false.

sysparm_no_count Whether to include the number of search results in the results.
  • false: Do not include
  • true: Include

Submit Service settings

The following table lists the submit Service settings for the Retrieve ServiceNow Incident Tickets service template.

Navigation pane Settings pane Description
ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection.

This setting is required.

sys_id Specify the system ID (sys_id) of the ticket to retrieve information for a single ticket.
Query Parameters sysparm_display_value

Whether to return the actual values of the field or return the display values.

  • false: Return only the actual values.
  • true: Return only the display values.
  • all: Return both.
sysparm_exclude_reference_link

Whether to add detailed information for the reference field.

  • false: Do not add
  • true: Add
sysparm_fields

Specify the field names you want to return in the response in comma-separated values.

The specified value will be encoded before sending a Table API request.

sysparm_view

A parameter that renders the response according to the specified UI view.

The specified value will be encoded before sending a Table API request.

This is overridden by sysparm_fields.

sysparm_query

Specify the query string that filters the response data.

The specified value will be encoded before sending a Table API request.

(Only for multiple information acquisition)

sysparm_suppress_pagination_header

Whether to suppress the pagination header.

(Only when acquiring multiple pieces of information.)

  • false: Do not suppress
  • true: Suppress
sysparm_limit

Specify the maximum number of results returned per page. (default: 10,000)

(Only when acquiring multiple pieces of information.)

sysparm_query_category

Specify the name of the query category (read replica category) to use for queries.

The specified value will be encoded before sending a Table API request.

(Only when acquiring multiple pieces of information.)

sysparm_query_no_domain Whether to restrict the record search to only the domains for which the logged in user is configured.
  • false: Restrict
  • true: Do not restrict

If this setting is omitted, the default is false.

sysparm_no_count Whether to include the number of search results in the results.
  • false: Do not include
  • true: Include