EN-US
Digibee.comDigibee Academy

ServiceNow

Discover more about the ServiceNow connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

ServiceNow interacts with ServiceNow through its REST API.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

ParameterDescriptionDefault valueData type

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The account used by the connector. It is only available if the Dynamic Account parameter is inactive.

N/A

Account

Instance Name (DB)

The ServiceNow instance name.

N/A

String

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Optional tab

ParameterDescriptionDefault valueData type

Display

Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any value in the Display field. The default value is true.

True

String

Display Value

Returns the display value (true), actual value (false), or both (all) for reference fields (default: false).

False

String

Exclude Reference Link

Set to true to exclude Table API links for reference fields (default: false).

False

Boolean

Favorites

Set this parameter to true to return only scorecards that are favorites of the querying user.

False

Boolean

Include Aggregates

Set this parameter to true to return all available aggregates for an indicator, even if an aggregate has already been applied. If not specified, it defaults to false and returns no aggregates.

False

Boolean

Include Available Aggregates

Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If not specified, it defaults to false and returns no aggregates.

False

Boolean

Include Available Breakdowns

Set this parameter to true to return all available breakdowns for an indicator. If not specified, it defaults to false and returns no breakdowns.

False

Boolean

Include Score Notes

Set this parameter to true to return all notes associated with the score. The note element includes the note text, author, and timestamp when the note was added.

False

Boolean

Include Scores

Set this parameter to true to return all scores for a scorecard. If not specified, it defaults to false and returns only the most recent score value.

False

Boolean

Input Display Value

Set to true to use the raw value of input fields (default: false).

False

Boolean

Key

Set this parameter to true to return only scorecards for key indicators.

False

Boolean

Models (DB)

Defines both the request and response models.

N/A

JSON

Per Page

Enter the maximum number of scorecards each query can return. The default value is 10, with a maximum of 100.

10

Number

Release

The ServiceNow release to target, default is Helsinki. See https://docs.servicenow.com.

HELSINKI

String

Request Models (DB)

Defines the request model.

N/A

JSON

Resource (DB)

The default resource, can be overridden by the header CamelServiceNowResource.

N/A

String

Response Models (DB)

Defines the response model.

N/A

JSON

Sort By

Specify the field to use when sorting results. By default, queries sort records by value.

N/A

String

Sort Dir

Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.

N/A

String

Suppress Auto Sys Field

Set to true to suppress the auto-generation of system fields (default: false).

False

Boolean

Suppress Pagination Header

Set to true to remove the Link header from the response. The Link header allows requesting additional pages of data when the number of records exceeds the query limit.

False

Boolean

Table (DB)

The default table, can be overridden by the header CamelServiceNowTable.

N/A

String

Target

Set this parameter to true to return only scorecards that have a target.

False

Boolean

Top Level Only

Retrieves only categories whose parent is a catalog.

False

Boolean

Api Version (DB)

The ServiceNow REST API version, default is the latest.

N/A

String

Date Format (DB)

The date format used for JSON serialization/deserialization.

yyyy-MM-dd

String

Date Time Format (DB)

The date-time format used for JSON serialization/deserialization.

yyyy-MM-dd HH:mm:ss

String

Retrieve Target Record On Import

Set this parameter to true to retrieve the target record when using the import set API. The import set result is replaced by the target record.

False

Boolean

Time Format (DB)

The time format used for JSON serialization/deserialization.

HH:mm:ss

String

Body

The body, if applicable.

{}

JSON

Headers tab

ParameterDescriptionDefault valueData type

Resource (DB)

The resource to be accessed.

N/A

String

Action (DB)

The action to be performed.

N/A

String

Action Subject (DB)

The subject of the action.

N/A

String

Model (DB)

Defines the data model.

N/A

String

Request Model (DB)

Defines the request data model.

N/A

String

Response Model (DB)

Defines the response data model.

N/A

String

Content Type (DB)

The type of the content.

N/A

String

Content Meta (DB)

Metadata associated with the content.

N/A

JSON

Response Meta (DB)

Metadata associated with the response.

N/A

JSON

Api Version (DB)

The version of the REST API.

N/A

String

Response Type (DB)

The type of the response.

N/A

String

Retrieve Target Record

Set this parameter to true to retrieve the target record.

False

Boolean

Table (DB)

The default table to be accessed.

N/A

String

Sys Id (DB)

The system ID (sys_id) of the target record.

N/A

String

User SysId (DB)

The system ID (sys_id) of the user.

N/A

String

User Id (DB)

The user’s ID.

N/A

String

Cart Item Id (DB)

The cart item ID.

N/A

String

File Name (DB)

The name of the file.

N/A

String

Table Sys Id (DB)

The system ID (sys_id) of the table.

N/A

String

Encryption Context (DB)

The context for encryption.

N/A

String

Category (DB)

The sys_param category.

N/A

String

Type (DB)

The sys_param type.

N/A

String

Catalog (DB)

The sys_param catalog.

N/A

String

Query (DB)

The sys_param query.

N/A

String

Display Value (DB)

Returns the display value (true), actual value (false), or both (all) for reference fields.

False

String

Input Display Value

Set this parameter to true to use the raw value of input fields.

False

Boolean

Exclude Reference Link

Set to true to exclude Table API links for reference fields.

False

Boolean

Fields (DB)

The sys_param fields to retrieve.

N/A

String

Limit

The sys_param limit for query results.

N/A

Number

Text (DB)

The sys_param text.

N/A

String

Offset

The sys_param offset for pagination.

N/A

Number

View (DB)

The sys_param view.

N/A

String

Suppress Auto Sys Field

Set to true to suppress auto-generation of system fields.

False

Boolean

Suppress Pagination Header

Set to true to remove the Link header from the response, which enables requesting additional pages of data.

False

Boolean

Min Fields (DB)

The sys_param min fields to retrieve.

N/A

String

Max Fields (DB)

The sys_param max fields to retrieve.

N/A

String

Sum Fields (DB)

The sys_param sum fields to calculate.

N/A

String

Avg Fields (DB)

The sys_param avg fields to calculate.

N/A

String

Count

Set to true to return a count of the records.

False

Boolean

Group By (DB)

The sys_param group by fields for aggregation.

N/A

String

Order By (DB)

The sys_param order by fields for sorting.

N/A

String

Having (DB)

The sys_param having clause for filtering aggregated results.

N/A

String

UUID (DB)

The sys_param UUID.

N/A

String

Breakdown (DB)

The sys_param breakdown field.

N/A

String

Include Scores

Set this parameter to true to return all scores for a scorecard. If not specified, only the most recent score will be returned.

False

Boolean

Include Score Notes

Set this parameter to true to return all notes associated with a score, including text, author, and timestamp.

False

Boolean

Include Aggregates

Set this parameter to true to return all available aggregates, even if an aggregate has already been applied.

False

Boolean

Include Available Breakdowns

Set this parameter to true to return all available breakdowns for an indicator.

False

Boolean

Include Available Aggregates

Set this parameter to true to return all available aggregates when no aggregate has been applied.

False

Boolean

Favorites

Set this parameter to true to return only scorecards that are marked as favorites by the querying user.

False

Boolean

Key

Set this parameter to true to return only scorecards for key indicators.

False

Boolean

Target

Set this parameter to true to return only scorecards that have a target.

False

Boolean

Display (DB)

Set this parameter to true to return scorecards where the Display field is selected. Use all to return scorecards with any value in the Display field.

True

String

Per Page

Specify the maximum number of scorecards to return in a query. Default is 10, with a maximum of 100.

10

Number

Sort By (DB)

Specify the field to use for sorting results. By default, records are sorted by value.

N/A

String

Sort Dir (DB)

Specify the sort direction: ascending or descending. By default, results are sorted in descending order. Use sysparm_sortdir=asc for ascending.

N/A

String

Contains (DB)

The sys_param contains clause.

N/A

String

Tags (DB)

The sys_param tags for categorizing records.

N/A

String

Page (DB)

The sys_param page number for pagination.

N/A

String

Elements Filter (DB)

The sys_param elements filter.

N/A

String

Breakdown Relation (DB)

The sys_param breakdown relation.

N/A

String

Data Source (DB)

The sys_param data source to query.

N/A

String

Top Level Only

Set to true to return only categories whose parent is a catalog.

False

Boolean

Documentation tab

ParameterDescriptionDefault valueData type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

PreviousTelegramNextWorkday

Last updated