ServiceNow

Since Camel 2.18

Only producer is supported

The ServiceNow component provides access to ServiceNow platform through their REST API.

The component supports multiple version of ServiceNow platform with default to Helsinki.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-servicenow</artifactId>
    <version>${camel-version}</version>
</dependency>

URI format

servicenow://instanceName?[options]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The ServiceNow component supports 48 options, which are listed below.

Name Description Default Type

configuration (producer)

Component configuration.

ServiceNowConfiguration

display (producer)

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 Display field value. This parameter is true by default.

Enum values:

  • false

  • true

  • all

true

String

displayValue (producer)

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

Enum values:

  • false

  • true

  • all

false

String

excludeReferenceLink (producer)

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

Boolean

favorites (producer)

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

Boolean

includeAggregates (producer)

Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

Boolean

includeAvailableAggregates (producer)

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

Boolean

includeAvailableBreakdowns (producer)

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

Boolean

includeScoreNotes (producer)

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

Boolean

includeScores (producer)

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

Boolean

inputDisplayValue (producer)

True to set raw value of input fields (default: false).

Boolean

key (producer)

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

Boolean

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

models (producer)

Defines both request and response models.

Map

perPage (producer)

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

10

Integer

release (producer)

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

Enum values:

  • FUJI

  • GENEVA

  • HELSINKI

HELSINKI

ServiceNowRelease

requestModels (producer)

Defines the request model.

Map

resource (producer)

The default resource, can be overridden by header CamelServiceNowResource.

String

responseModels (producer)

Defines the response model.

Map

sortBy (producer)

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

Enum values:

  • value

  • change

  • changeperc

  • gap

  • gapperc

  • duedate

  • name

  • order

  • default

  • group

  • indicator_group

  • frequency

  • target

  • date

  • trend

  • bullet

  • direction

String

sortDir (producer)

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

Enum values:

  • asc

  • desc

String

suppressAutoSysField (producer)

True to suppress auto generation of system fields (default: false).

Boolean

suppressPaginationHeader (producer)

Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit.

Boolean

table (producer)

The default table, can be overridden by header CamelServiceNowTable.

String

target (producer)

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

Boolean

topLevelOnly (producer)

Gets only those categories whose parent is a catalog.

Boolean

apiVersion (advanced)

The ServiceNow REST API version, default latest.

String

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

dateFormat (advanced)

The date format used for Json serialization/deserialization.

yyyy-MM-dd

String

dateTimeFormat (advanced)

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

yyyy-MM-dd HH:mm:ss

String

httpClientPolicy (advanced)

To configure http-client.

HTTPClientPolicy

instanceName (advanced)

The ServiceNow instance name.

String

mapper (advanced)

Sets Jackson’s ObjectMapper to use for request/reply.

ObjectMapper

proxyAuthorizationPolicy (advanced)

To configure proxy authentication.

ProxyAuthorizationPolicy

retrieveTargetRecordOnImport (advanced)

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

false

Boolean

timeFormat (advanced)

The time format used for Json serialization/deserialization.

HH:mm:ss

String

proxyHost (proxy)

The proxy host name.

String

proxyPort (proxy)

The proxy port number.

Integer

apiUrl (security)

The ServiceNow REST API url.

String

oauthClientId (security)

OAuth2 ClientID.

String

oauthClientSecret (security)

OAuth2 ClientSecret.

String

oauthTokenUrl (security)

OAuth token Url.

String

password (security)

Required ServiceNow account password, MUST be provided.

String

proxyPassword (security)

Password for proxy authentication.

String

proxyUserName (security)

Username for proxy authentication.

String

sslContextParameters (security)

To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html.

SSLContextParameters

useGlobalSslContextParameters (security)

Enable usage of global SSL context parameters.

false

boolean

userName (security)

Required ServiceNow user account name, MUST be provided.

String

Endpoint Options

The ServiceNow endpoint is configured using URI syntax:

servicenow:instanceName

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

instanceName (producer)

Required The ServiceNow instance name.

String

Query Parameters (44 parameters)

Name Description Default Type

display (producer)

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 Display field value. This parameter is true by default.

Enum values:

  • false

  • true

  • all

true

String

displayValue (producer)

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

Enum values:

  • false

  • true

  • all

false

String

excludeReferenceLink (producer)

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

Boolean

favorites (producer)

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

Boolean

includeAggregates (producer)

Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

Boolean

includeAvailableAggregates (producer)

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

Boolean

includeAvailableBreakdowns (producer)

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

Boolean

includeScoreNotes (producer)

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

Boolean

includeScores (producer)

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

Boolean

inputDisplayValue (producer)

True to set raw value of input fields (default: false).

Boolean

key (producer)

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

Boolean

models (producer)

Defines both request and response models.

Map

perPage (producer)

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

10

Integer

release (producer)

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

Enum values:

  • FUJI

  • GENEVA

  • HELSINKI

HELSINKI

ServiceNowRelease

requestModels (producer)

Defines the request model.

Map

resource (producer)

The default resource, can be overridden by header CamelServiceNowResource.

String

responseModels (producer)

Defines the response model.

Map

sortBy (producer)

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

Enum values:

  • value

  • change

  • changeperc

  • gap

  • gapperc

  • duedate

  • name

  • order

  • default

  • group

  • indicator_group

  • frequency

  • target

  • date

  • trend

  • bullet

  • direction

String

sortDir (producer)

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

Enum values:

  • asc

  • desc

String

suppressAutoSysField (producer)

True to suppress auto generation of system fields (default: false).

Boolean

suppressPaginationHeader (producer)

Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit.

Boolean

table (producer)

The default table, can be overridden by header CamelServiceNowTable.

String

target (producer)

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

Boolean

topLevelOnly (producer)

Gets only those categories whose parent is a catalog.

Boolean

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

apiVersion (advanced)

The ServiceNow REST API version, default latest.

String

dateFormat (advanced)

The date format used for Json serialization/deserialization.

yyyy-MM-dd

String

dateTimeFormat (advanced)

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

yyyy-MM-dd HH:mm:ss

String

httpClientPolicy (advanced)

To configure http-client.

HTTPClientPolicy

mapper (advanced)

Sets Jackson’s ObjectMapper to use for request/reply.

ObjectMapper

proxyAuthorizationPolicy (advanced)

To configure proxy authentication.

ProxyAuthorizationPolicy

retrieveTargetRecordOnImport (advanced)

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

false

Boolean

timeFormat (advanced)

The time format used for Json serialization/deserialization.

HH:mm:ss

String

proxyHost (proxy)

The proxy host name.

String

proxyPort (proxy)

The proxy port number.

Integer

apiUrl (security)

The ServiceNow REST API url.

String

oauthClientId (security)

OAuth2 ClientID.

String

oauthClientSecret (security)

OAuth2 ClientSecret.

String

oauthTokenUrl (security)

OAuth token Url.

String

password (security)

Required ServiceNow account password, MUST be provided.

String

proxyPassword (security)

Password for proxy authentication.

String

proxyUserName (security)

Username for proxy authentication.

String

sslContextParameters (security)

To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html.

SSLContextParameters

userName (security)

Required ServiceNow user account name, MUST be provided.

String

Message Headers

The ServiceNow component supports 63 message header(s), which is/are listed below:

Name Description Default Type

CamelServiceNowResource (producer)

Constant: RESOURCE

The resource to access.

String

CamelServiceNowAction (producer)

Constant: ACTION

The action to perform.

String

CamelServiceNowActionSubject (producer)

Constant: ACTION_SUBJECT

The action subject.

String

CamelServiceNowModel (producer)

Constant: MODEL

The data model.

Class

CamelServiceNowRequestModel (producer)

Constant: REQUEST_MODEL

The request data model.

Class

CamelServiceNowResponseModel (producer)

Constant: RESPONSE_MODEL

The response data model.

Class

CamelServiceNowContentType (producer)

Constant: CONTENT_TYPE

The content type.

String

CamelServiceNowContentMeta (producer)

Constant: CONTENT_META

The content meta.

Map

CamelServiceNowResponseMeta (producer)

Constant: RESPONSE_META

The response meta.

Map

CamelServiceNowApiVersion (producer)

Constant: API_VERSION

The REST API version.

String

CamelServiceNowResponseType (producer)

Constant: RESPONSE_TYPE

The type of the response.

Class

CamelServiceNowRetrieveTargetRecord (producer)

Constant: RETRIEVE_TARGET_RECORD

Set this parameter to true to retrieve the target record.

Boolean

CamelServiceNowTable (producer)

Constant: PARAM_TABLE_NAME

The default table.

String

CamelServiceNowSysId (producer)

Constant: PARAM_SYS_ID

The sys id.

String

CamelServiceNowUserSysId (producer)

Constant: PARAM_USER_SYS_ID

The user sys id.

String

CamelServiceNowUserId (producer)

Constant: PARAM_USER_ID

The user id.

String

CamelServiceNowCartItemId (producer)

Constant: PARAM_CART_ITEM_ID

The cart item id.

String

CamelServiceNowFileName (producer)

Constant: PARAM_FILE_NAME

The file name.

String

CamelServiceNowTableSysId (producer)

Constant: PARAM_TABLE_SYS_ID

The table sys id.

String

CamelServiceNowEncryptionContext (producer)

Constant: PARAM_ENCRYPTION_CONTEXT

The encryption context.

String

CamelServiceNowCategory (producer)

Constant: SYSPARM_CATEGORY

The sys param category.

String

CamelServiceNowType (producer)

Constant: SYSPARM_TYPE

The sys param type.

String

CamelServiceNowCatalog (producer)

Constant: SYSPARM_CATALOG

The sys param catalog.

String

CamelServiceNowQuery (producer)

Constant: SYSPARM_QUERY

The sys param query.

String

CamelServiceNowDisplayValue (producer)

Constant: SYSPARM_DISPLAY_VALUE

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

false

String

CamelServiceNowInputDisplayValue (producer)

Constant: SYSPARM_INPUT_DISPLAY_VALUE

True to set raw value of input fields.

false

Boolean

CamelServiceNowExcludeReferenceLink (producer)

Constant: SYSPARM_EXCLUDE_REFERENCE_LINK

True to exclude Table API links for reference fields.

false

Boolean

CamelServiceNowFields (producer)

Constant: SYSPARM_FIELDS

The sys param fields.

String

CamelServiceNowLimit (producer)

Constant: SYSPARM_LIMIT

The sys param limit.

Integer

CamelServiceNowText (producer)

Constant: SYSPARM_TEXT

The sys param text.

String

CamelServiceNowOffset (producer)

Constant: SYSPARM_OFFSET

The sys param offset.

Integer

CamelServiceNowView (producer)

Constant: SYSPARM_VIEW

The sys param view.

String

CamelServiceNowSuppressAutoSysField (producer)

Constant: SYSPARM_SUPPRESS_AUTO_SYS_FIELD

True to suppress auto generation of system fields.

false

Boolean

CamelServiceNowSuppressPaginationHeader (producer)

Constant: SYSPARM_SUPPRESS_PAGINATION_HEADER

Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit.

Boolean

CamelServiceNowMinFields (producer)

Constant: SYSPARM_MIN_FIELDS

The sys param min fields.

String

CamelServiceNowMaxFields (producer)

Constant: SYSPARM_MAX_FIELDS

The sys param max fields.

String

CamelServiceNowSumFields (producer)

Constant: SYSPARM_SUM_FIELDS

The sys param sum fields.

String

CamelServiceNowAvgFields (producer)

Constant: SYSPARM_AVG_FIELDS

The sys param avg fields.

String

CamelServiceNowCount (producer)

Constant: SYSPARM_COUNT

The sys param count.

Boolean

CamelServiceNowGroupBy (producer)

Constant: SYSPARM_GROUP_BY

The sys param group by.

String

CamelServiceNowOrderBy (producer)

Constant: SYSPARM_ORDER_BY

The sys param order by.

String

CamelServiceNowHaving (producer)

Constant: SYSPARM_HAVING

The sys param having.

String

CamelServiceNowUUID (producer)

Constant: SYSPARM_UUID

The sys param UUID.

String

CamelServiceNowBreakdown (producer)

Constant: SYSPARM_BREAKDOWN

The sys param breakdown.

String

CamelServiceNowIncludeScores (producer)

Constant: SYSPARM_INCLUDE_SCORES

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

Boolean

CamelServiceNowIncludeScoreNotes (producer)

Constant: SYSPARM_INCLUDE_SCORE_NOTES

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

Boolean

CamelServiceNowIncludeAggregates (producer)

Constant: SYSPARM_INCLUDE_AGGREGATES

Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

Boolean

CamelServiceNowIncludeAvailableBreakdowns (producer)

Constant: SYSPARM_INCLUDE_AVAILABLE_BREAKDOWNS

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

Boolean

CamelServiceNowIncludeAvailableAggregates (producer)

Constant: SYSPARM_INCLUDE_AVAILABLE_AGGREGATES

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

Boolean

CamelServiceNowFavorites (producer)

Constant: SYSPARM_FAVORITES

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

Boolean

CamelServiceNowKey (producer)

Constant: SYSPARM_KEY

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

Boolean

CamelServiceNowTarget (producer)

Constant: SYSPARM_TARGET

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

Boolean

CamelServiceNowDisplay (producer)

Constant: SYSPARM_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 Display field value.

true

String

CamelServiceNowPerPage (producer)

Constant: SYSPARM_PER_PAGE

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

10

Integer

CamelServiceNowSortBy (producer)

Constant: SYSPARM_SORT_BY

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

String

CamelServiceNowSortDir (producer)

Constant: SYSPARM_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.

String

CamelServiceNowContains (producer)

Constant: SYSPARM_CONTAINS

The sys param contains.

String

CamelServiceNowTags (producer)

Constant: SYSPARM_TAGS

The sys param tags.

String

CamelServiceNowPage (producer)

Constant: SYSPARM_PAGE

The sys param page.

String

CamelServiceNowElementsFilter (producer)

Constant: SYSPARM_ELEMENTS_FILTER

The sys param elements filter.

String

CamelServiceNowBreakdownRelation (producer)

Constant: SYSPARM_BREAKDOWN_RELATION

The sys param breakdown relation.

String

CamelServiceNowDataSource (producer)

Constant: SYSPARM_DATA_SOURCE

The sys param data source.

String

CamelServiceNowTopLevelOnly (producer)

Constant: SYSPARM_TOP_LEVEL_ONLY

Gets only those categories whose parent is a catalog.

Boolean
Table 1. API Mapping
CamelServiceNowResource CamelServiceNowAction Method API URI

TABLE

RETRIEVE

GET

/api/now/v1/table/{table_name}/{sys_id}

CREATE

POST

/api/now/v1/table/{table_name}

MODIFY

PUT

/api/now/v1/table/{table_name}/{sys_id}

DELETE

DELETE

/api/now/v1/table/{table_name}/{sys_id}

UPDATE

PATCH

/api/now/v1/table/{table_name}/{sys_id}

AGGREGATE

RETRIEVE

GET

/api/now/v1/stats/{table_name}

IMPORT

RETRIEVE

GET

/api/now/import/{table_name}/{sys_id}

CREATE

POST

/api/now/import/{table_name}

Fuji REST API Documentation
Table 2. API Mapping
CamelServiceNowResource CamelServiceNowAction CamelServiceNowActionSubject Method API URI

TABLE

RETRIEVE

GET

/api/now/v1/table/{table_name}/{sys_id}

CREATE

POST

/api/now/v1/table/{table_name}

MODIFY

PUT

/api/now/v1/table/{table_name}/{sys_id}

DELETE

DELETE

/api/now/v1/table/{table_name}/{sys_id}

UPDATE

PATCH

/api/now/v1/table/{table_name}/{sys_id}

AGGREGATE

RETRIEVE

GET

/api/now/v1/stats/{table_name}

IMPORT

RETRIEVE

GET

/api/now/import/{table_name}/{sys_id}

CREATE

POST

/api/now/import/{table_name}

ATTACHMENT

RETRIEVE

GET

/api/now/api/now/attachment/{sys_id}

CONTENT

GET

/api/now/attachment/{sys_id}/file

UPLOAD

POST

/api/now/api/now/attachment/file

DELETE

DELETE

/api/now/attachment/{sys_id}

SCORECARDS

RETRIEVE

PERFORMANCE_ANALYTICS

GET

/api/now/pa/scorecards

MISC

RETRIEVE

USER_ROLE_INHERITANCE

GET

/api/global/user_role_inheritance

CREATE

IDENTIFY_RECONCILE

POST

/api/now/identifyreconcile

SERVICE_CATALOG

RETRIEVE

GET

/sn_sc/servicecatalog/catalogs/{sys_id}

RETRIEVE

CATEGORIES

GET

/sn_sc/servicecatalog/catalogs/{sys_id}/categories

SERVICE_CATALOG_ITEMS

RETRIEVE

GET

/sn_sc/servicecatalog/items/{sys_id}

RETRIEVE

SUBMIT_GUIDE

POST

/sn_sc/servicecatalog/items/{sys_id}/submit_guide

RETRIEVE

CHECKOUT_GUIDE

POST

/sn_sc/servicecatalog/items/{sys_id}/checkout_guide

CREATE

SUBJECT_CART

POST

/sn_sc/servicecatalog/items/{sys_id}/add_to_cart

CREATE

SUBJECT_PRODUCER

POST

/sn_sc/servicecatalog/items/{sys_id}/submit_producer

SERVICE_CATALOG_CARTS

RETRIEVE

GET

/sn_sc/servicecatalog/cart

RETRIEVE

DELIVERY_ADDRESS

GET

/sn_sc/servicecatalog/cart/delivery_address/{user_id}

RETRIEVE

CHECKOUT

POST

/sn_sc/servicecatalog/cart/checkout

UPDATE

POST

/sn_sc/servicecatalog/cart/{cart_item_id}

UPDATE

CHECKOUT

POST

/sn_sc/servicecatalog/cart/submit_order

DELETE

DELETE

/sn_sc/servicecatalog/cart/{sys_id}/empty

SERVICE_CATALOG_CATEGORIES

RETRIEVE

GET

/sn_sc/servicecatalog/categories/{sys_id}

Helsinki REST API Documentation

Usage examples:

Retrieve 10 Incidents
context.addRoutes(new RouteBuilder() {
    public void configure() {
       from("direct:servicenow")
           .to("servicenow:{{env:SERVICENOW_INSTANCE}}"
               + "?userName={{env:SERVICENOW_USERNAME}}"
               + "&password={{env:SERVICENOW_PASSWORD}}"
               + "&oauthClientId={{env:SERVICENOW_OAUTH2_CLIENT_ID}}"
               + "&oauthClientSecret={{env:SERVICENOW_OAUTH2_CLIENT_SECRET}}"
           .to("mock:servicenow");
    }
});

FluentProducerTemplate.on(context)
    .withHeader(ServiceNowConstants.RESOURCE, "table")
    .withHeader(ServiceNowConstants.ACTION, ServiceNowConstants.ACTION_RETRIEVE)
    .withHeader(ServiceNowConstants.SYSPARM_LIMIT.getId(), "10")
    .withHeader(ServiceNowConstants.TABLE, "incident")
    .withHeader(ServiceNowConstants.MODEL, Incident.class)
    .to("direct:servicenow")
    .send();

Spring Boot Auto-Configuration

When using servicenow with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-servicenow-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 49 options, which are listed below.

Name Description Default Type

camel.component.servicenow.api-url

The ServiceNow REST API url.

String

camel.component.servicenow.api-version

The ServiceNow REST API version, default latest.

String

camel.component.servicenow.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.servicenow.configuration

Component configuration. The option is a org.apache.camel.component.servicenow.ServiceNowConfiguration type.

ServiceNowConfiguration

camel.component.servicenow.date-format

The date format used for Json serialization/deserialization.

yyyy-MM-dd

String

camel.component.servicenow.date-time-format

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

yyyy-MM-dd HH:mm:ss

String

camel.component.servicenow.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 Display field value. This parameter is true by default.

true

String

camel.component.servicenow.display-value

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

false

String

camel.component.servicenow.enabled

Whether to enable auto configuration of the servicenow component. This is enabled by default.

Boolean

camel.component.servicenow.exclude-reference-link

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

Boolean

camel.component.servicenow.favorites

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

Boolean

camel.component.servicenow.http-client-policy

To configure http-client. The option is a org.apache.cxf.transports.http.configuration.HTTPClientPolicy type.

HTTPClientPolicy

camel.component.servicenow.include-aggregates

Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates.

Boolean

camel.component.servicenow.include-available-aggregates

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

Boolean

camel.component.servicenow.include-available-breakdowns

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

Boolean

camel.component.servicenow.include-score-notes

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

Boolean

camel.component.servicenow.include-scores

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

Boolean

camel.component.servicenow.input-display-value

True to set raw value of input fields (default: false).

Boolean

camel.component.servicenow.instance-name

The ServiceNow instance name.

String

camel.component.servicenow.key

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

Boolean

camel.component.servicenow.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.servicenow.mapper

Sets Jackson’s ObjectMapper to use for request/reply. The option is a com.fasterxml.jackson.databind.ObjectMapper type.

ObjectMapper

camel.component.servicenow.models

Defines both request and response models.

Map

camel.component.servicenow.oauth-client-id

OAuth2 ClientID.

String

camel.component.servicenow.oauth-client-secret

OAuth2 ClientSecret.

String

camel.component.servicenow.oauth-token-url

OAuth token Url.

String

camel.component.servicenow.password

ServiceNow account password, MUST be provided.

String

camel.component.servicenow.per-page

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

10

Integer

camel.component.servicenow.proxy-authorization-policy

To configure proxy authentication. The option is a org.apache.cxf.configuration.security.ProxyAuthorizationPolicy type.

ProxyAuthorizationPolicy

camel.component.servicenow.proxy-host

The proxy host name.

String

camel.component.servicenow.proxy-password

Password for proxy authentication.

String

camel.component.servicenow.proxy-port

The proxy port number.

Integer

camel.component.servicenow.proxy-user-name

Username for proxy authentication.

String

camel.component.servicenow.release

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

ServiceNowRelease

camel.component.servicenow.request-models

Defines the request model.

Map

camel.component.servicenow.resource

The default resource, can be overridden by header CamelServiceNowResource.

String

camel.component.servicenow.response-models

Defines the response model.

Map

camel.component.servicenow.retrieve-target-record-on-import

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

false

Boolean

camel.component.servicenow.sort-by

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

String

camel.component.servicenow.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.

String

camel.component.servicenow.ssl-context-parameters

To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html. The option is a org.apache.camel.support.jsse.SSLContextParameters type.

SSLContextParameters

camel.component.servicenow.suppress-auto-sys-field

True to suppress auto generation of system fields (default: false).

Boolean

camel.component.servicenow.suppress-pagination-header

Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit.

Boolean

camel.component.servicenow.table

The default table, can be overridden by header CamelServiceNowTable.

String

camel.component.servicenow.target

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

Boolean

camel.component.servicenow.time-format

The time format used for Json serialization/deserialization.

HH:mm:ss

String

camel.component.servicenow.top-level-only

Gets only those categories whose parent is a catalog.

Boolean

camel.component.servicenow.use-global-ssl-context-parameters

Enable usage of global SSL context parameters.

false

Boolean

camel.component.servicenow.user-name

ServiceNow user account name, MUST be provided.

String
Back to top