299.2. オプション
ServiceNow コンポーネントは、以下に示す 14 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
instanceName (advanced) | ServiceNow インスタンス名 | String | |
configuration (advanced) | ServiceNow のデフォルト設定 | ServiceNowConfiguration | |
apiUrl (producer) | ServiceNow REST API URL | String | |
userName (security) | ServiceNow ユーザーアカウント名 | String | |
password (security) | ServiceNow アカウントのパスワード | String | |
oauthClientId (security) | OAuth2 ClientID | String | |
oauthClientSecret (security) | OAuth2 ClientSecret | String | |
oauthTokenUrl (security) | OAuth トークンの URL | String | |
proxyHost (advanced) | プロキシーホスト名 | String | |
proxyPort (advanced) | プロキシーポート番号 | Integer | |
proxyUserName (security) | プロキシー認証用のユーザー名 | String | |
proxyPassword (security) | プロキシー認証のパスワード | String | |
useGlobalSslContext Parameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
ServiceNow エンドポイントは、URI 構文を使用して設定されます。
servicenow:instanceName
パスおよびクエリーパラメーターを使用します。
299.2.1. パスパラメーター (1 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
instanceName | 必須 ServiceNow インスタンス名 | String |
299.2.2. クエリーパラメーター(44 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
display (producer) | このパラメーターを true に設定すると、インジケーターの 表示 フィールドが選択されているスコアカードのみが返されます。このパラメーターを all に設定すると、任意の表示フィールド値を持つスコアカードが返されます。このパラメーターはデフォルトで true です。 | true | String |
displayValue (producer) | 参照フィールドの表示値 (true)、実際の値 (false)、またはその両方 (すべて) を返します (デフォルト: false) | false | String |
excludeReferenceLink (producer) | 参照フィールドのテーブル API リンクを除外する場合は True (デフォルト: false) | Boolean | |
favorites (producer) | このパラメーターを true に設定すると、クエリーを実行しているユーザーのお気に入りのスコアカードのみが返されます。 | Boolean | |
includeAggregates (producer) | このパラメーターを true に設定すると、集計がすでに適用されている場合を含め、インジケーターで使用可能なすべての集計が常に返されます。値が指定されていない場合、このパラメーターはデフォルトで false になり、集計は返されません。 | Boolean | |
includeAvailableAggregates (producer) | このパラメーターを true に設定すると、集計が適用されていない場合に、インジケーターに使用可能なすべての集計が返されます。値が指定されていない場合、このパラメーターはデフォルトで false になり、集計は返されません。 | Boolean | |
includeAvailableBreakdowns (producer) | このパラメーターを true に設定すると、インジケーターで利用可能なすべての内訳が返されます。値が指定されていない場合、このパラメーターはデフォルトで false になり、ブレークダウンは返されません。 | Boolean | |
includeScoreNotes (producer) | スコアに関連付けられたすべての音符を返すには、このパラメーターを true に設定します。note 要素には、メモテキストのほか、メモが追加されたときの作成者とタイムスタンプが含まれます。 | Boolean | |
includeScores (producer) | スコアカードのすべてのスコアを返すには、このパラメーターを true に設定します。値が指定されていない場合、このパラメーターはデフォルトで false に設定され、最新のスコア値のみが返されます。 | Boolean | |
inputDisplayValue (producer) | 入力フィールドの生の値を設定する場合は True (デフォルト: false) | Boolean | |
key (producer) | キーインジケーターのスコアカードのみを返すには、このパラメーターを true に設定します。 | Boolean | |
models (producer) | リクエストモデルとレスポンスモデルの両方を定義する | String | |
perPage (producer) | 各クエリーが返すことができるスコアカードの最大数を入力します。デフォルトでは、この値は 10 で、最大値は 100 です。 | 10 | Integer |
release (producer) | ターゲットとする ServiceNow リリース、デフォルトは Helsinki https://docs.servicenow.com を参照 | HELSINKI | ServiceNowRelease |
requestModels (producer) | リクエストモデルを定義します | String | |
resource (producer) | デフォルトのリソースは、ヘッダー CamelServiceNowResource でオーバーライドできます | String | |
responseModels (producer) | レスポンスモデルを定義します | String | |
sortBy (producer) | 結果を並べ替えるときに使用する値を指定します。デフォルトでは、クエリーはレコードを値で並べ替えます。 | String | |
sortDir (producer) | 昇順または降順のソート方向を指定します。デフォルトでは、クエリーはレコードを降順で並べ替えます。昇順でソートするには、sysparm_sortdir=asc を使用します。 | String | |
suppressAutoSysField (producer) | システムフィールドの自動生成を抑制する場合は True (デフォルト: false) | Boolean | |
suppressPaginationHeader (producer) | レスポンスから Link ヘッダーを削除するには、この値を true に設定します。Link ヘッダーを使用すると、クエリーに一致するレコードの数がクエリーの制限を超えた場合に、データの追加ページをリクエストできます | Boolean | |
table (producer) | デフォルトのテーブルは、ヘッダー CamelServiceNowTable でオーバーライドできます | String | |
target (producer) | ターゲットを持つスコアカードのみを返すには、このパラメーターを true に設定します。 | Boolean | |
topLevelOnly (producer) | 親がカタログであるカテゴリーのみを取得します。 | Boolean | |
apiVersion (advanced) | ServiceNow REST API バージョン、デフォルトは最新 | String | |
dateFormat (advanced) | Json シリアライゼーション/デシリアライゼーションに使用される日付形式 | yyyy-MM-dd | String |
dateTimeFormat (advanced) | Json シリアライゼーション/デシリアライゼーションに使用される日時形式 | yyyy-MM-dd HH:mm:ss | String |
httpClientPolicy (advanced) | http クライアントを設定するには | HTTPClientPolicy | |
mapper (advanced) | リクエスト/レスポンスに使用する Jackson の ObjectMapper を設定します | ObjectMapper | |
proxyAuthorizationPolicy (advanced) | プロキシー認証を設定するには | ProxyAuthorization ポリシー | |
retrieveTargetRecordOn Import (advanced) | インポートセット API を使用する場合に対象レコードを取得するには、このパラメーターを true に設定します。インポートセットの結果は、ターゲットレコードに置き換えられます。 | false | Boolean |
synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |
timeFormat (advanced) | Json シリアル化/逆シリアル化に使用される時刻形式 | HH:mm:ss | String |
proxyHost (proxy) | プロキシーホスト名 | String | |
proxyPort (proxy) | プロキシーポート番号 | Integer | |
apiUrl (security) | ServiceNow REST API URL | String | |
oauthClientId (security) | OAuth2 ClientID | String | |
oauthClientSecret (security) | OAuth2 ClientSecret | String | |
oauthTokenUrl (security) | OAuth トークンの URL | String | |
password (security) | 必須 ServiceNow アカウントのパスワード。入力する必要があります。 | String | |
proxyPassword (security) | プロキシー認証のパスワード | String | |
proxyUserName (security) | プロキシー認証用のユーザー名 | String | |
sslContextParameters (security) | SSLContextParameters を使用してセキュリティーを設定する場合。See http://camel.apache.org/camel-configuration-utilities.html | SSLContextParameters | |
userName (security) | 必須 ServiceNow ユーザーアカウント名。入力する必要があります。 | String |