Zendesk Connector 1.1 リファレンス - Mule 4

設定


設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

MINUTES (分)

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が ​AUTO​ に設定されている場合、最適な戦略は要求の内容に基づいて自動的に決定されます。

AUTO

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。

接続種別

Api Token Connection Provider (API トークン接続プロバイダー)
パラメーター
名前 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Query Parameters (クエリパラメーター)

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立する場合のタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト) の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間を表すタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

接続アイドルタイムアウトの時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする (すべてのヘッダーが解析されたらすぐに処理を続行し、本文が受信されたらストリーミングする) 必要があるかどうか。設定されたバッファサイズによっては、応答がメモリに収まらず、容量が空くまで処理が停止する可能性もあるため、これが有効になっている場合は徐々に応答を読み取る必要があります。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの容量 (バイト)。

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントには独自のベース URI があります。

https://{subdomain}.zendesk.comLeaving the Site

Authorization (認証)

String (文字列)

Authorization (認証)

API version (API バージョン)

String (文字列)

使用する API バージョン。

v2

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Basic Authentication Connection Provider (基本認証接続プロバイダー)
パラメーター
名前 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Query Parameters (クエリパラメーター)

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立する場合のタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト) の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間を表すタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

接続アイドルタイムアウトの時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする (すべてのヘッダーが解析されたらすぐに処理を続行し、本文が受信されたらストリーミングする) 必要があるかどうか。設定されたバッファサイズによっては、応答がメモリに収まらず、容量が空くまで処理が停止する可能性もあるため、これが有効になっている場合は徐々に応答を読み取る必要があります。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの容量 (バイト)。

-1

Username (ユーザー名)

String (文字列)

要求を認証するためのユーザー名。

Password (パスワード)

String (文字列)

要求を認証するためのパスワード。

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントには独自のベース URI があります。

https://{subdomain}.zendesk.comLeaving the Site

API version (API バージョン)

String (文字列)

使用する API バージョン。

v2

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Oauth2 Access Code Connection Provider (Oauth2 アクセスコード接続プロバイダー)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

パラメーター
名前 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

Query Parameters (クエリパラメーター)

Connection Timeout (接続タイムアウト)

Number (数値)

リモートサービスへの接続を確立する場合のタイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

Connection Timeout (接続タイムアウト) の時間単位。

SECONDS (秒)

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間を表すタイムアウト。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

接続アイドルタイムアウトの時間単位。

SECONDS (秒)

Proxy Config (プロキシ設定)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする (すべてのヘッダーが解析されたらすぐに処理を続行し、本文が受信されたらストリーミングする) 必要があるかどうか。設定されたバッファサイズによっては、応答がメモリに収まらず、容量が空くまで処理が停止する可能性もあるため、これが有効になっている場合は徐々に応答を読み取る必要があります。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの容量 (バイト)。

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントには独自のベース URI があります。

https://{subdomain}.zendesk.comLeaving the Site

API version (API バージョン)

String (文字列)

使用する API バージョン。

v2

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Consumer Key (コンシューマーキー)

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーキー。

x

Consumer Secret (コンシューマーシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーシークレット。

x

Authorization Url (認証 URL)

String (文字列)

サービスプロバイダーの認証エンドポイント URL。

https://{subdomain}.zendesk.com/oauth/authorizations/newLeaving the Site

Access Token Url (アクセストークン URL)

String (文字列)

サービスプロバイダーのアクセストークンエンドポイント URL。

https://{subdomain}.zendesk.com/oauth/tokensLeaving the Site

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。指定しない場合、デフォルトのアノテーションの範囲になります

read write (読み書き)

Resource Owner Id (リソースオーナー ID)

String (文字列)

各コンポーネントが他から参照されない場合に使用する必要があるリソースオーナー ID。

Before (前)

String (文字列)

OAuth ダンスを開始する前に実行するフローの名前。

After (後)

String (文字列)

accessToken が受信された直後に実行するフローの名前。

リスナー設定

String (文字列)

アクセストークンコールバックエンドポイントをキャッチするリスナーの作成に使用する ​<http:listener-config />​ への参照。

x

Callback Path (コールバックパス)

String (文字列)

アクセストークンコールバックエンドポイントのパス。

x

Authorize Path (認証パス)

String (文字列)

OAuth ダンスをトリガーするローカル http エンドポイントのパス。

x

External Callback Url (外部コールバック URL)

String (文字列)

コールバックエンドポイントがプロキシの背後にあるか、間接 URL でアクセスする必要がある場合、このパラメーターを使用して OAuth プロバイダーに、コールバックへのアクセスに使用すべき URL を指示します。

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナー ID のデータの保存に使用されるオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

操作

Upsert an organization

<zendesk:create-organizations-create-or-updatejson>

まだ存在していない場合に組織を作成するか、ID または外部 ID で識別される既存の組織を更新します。この操作では、/organizations/create_or_update.json エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

organizationToUpsert

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

* AUTO​ (デフォルト)

コネクタは、要求内容に基づいて自動的に最適なストリーミング戦略を使用します。

* ALWAYS

コネクタは、常に要求内容をストリーミングします。

* NEVER

コネクタは、要求内容をストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:RETRY_EXHAUSTED

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Create a ticket

<zendesk:create-ticketsjson>

新しいチケットを作成します。この操作では、​/tickets.json​ エンドポイントに HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ticket Create Content (チケット作成コンテンツ)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が ​AUTO​ に設定されている場合、最適な戦略は要求の内容に基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:RETRY_EXHAUSTED

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Upsert a user

<zendesk:create-users-create-or-updatejson>

まだ存在していない場合にユーザーを作成するか、メールアドレスまたは外部 ID で識別される既存のユーザーを更新します。この操作では、/users/create_or_update.json エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

userToUpsert

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

* AUTO​ (デフォルト)

コネクタは、要求内容に基づいて自動的に最適なストリーミング戦略を使用します。

* ALWAYS

コネクタは、常に要求内容をストリーミングします。

* NEVER

コネクタは、要求内容をストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:RETRY_EXHAUSTED

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Create a user

<zendesk:create-usersjson>

新規ユーザーを作成します。この操作では、​/users.json​ エンドポイントに HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

newUser

Any (任意)

新規ユーザーの情報が含まれるコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が ​AUTO​ に設定されている場合、最適な戦略は要求の内容に基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:RETRY_EXHAUSTED

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Search

<zendesk:get-searchjson>

ユーザーの検索語に基づいてチケット、ユーザー、組織を検索し、検索語に一致する項目のリストを返します。この操作では、/search.json エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

query (クエリ)

String (文字列)

検索クエリ。

x

Sort by (並び替え基準)

String (文字列)

次のオプションのいずれかで並び替えます。指定しない場合、操作は関連性で並び替えられます。

* updated_at

* created_at

* priority

* status

* ticket_type

Sort order (並び替え順)

String (文字列)

* asc

* desc

desc

Initial Page Number (初期ページ番号)

Number (数値)

最初の要求の初期ページ番号。

1

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

  • RepeatableInMemoryIterable

  • RepeatableFileStoreIterable

  • non-repeatable-iterable

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

* AUTO​ (デフォルト)

コネクタは、要求内容に基づいて自動的に最適なストリーミング戦略を使用します。

* ALWAYS

コネクタは、常に要求内容をストリーミングします。

* NEVER

コネクタは、要求内容をストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any の配列

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<zendesk:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、OAuth ダンスが実行されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Resource Owner Id (リソースオーナー ID)

String (文字列)

アクセスの無効化が必要なリソースオーナーの ID。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

次の設定の場合

Update a ticket

<zendesk:update-tickets-idjson>

チケットを更新します。この操作では、​/tickets/{id}.json​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ID

String (文字列)

更新するチケットの ID。

x

Ticket Update Content (チケット更新コンテンツ)

Any (任意)

更新情報が含まれるコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

リモートサービスへの要求のタイムアウト。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout (応答タイムアウト)] 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

ストリーミングを使用して要求を送信するかどうかを定義します。値が ​AUTO​ に設定されている場合、最適な戦略は要求の内容に基づいて自動的に決定されます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • ZENDESK:BAD_REQUEST

  • ZENDESK:CLIENT_ERROR

  • ZENDESK:CONNECTIVITY

  • ZENDESK:INTERNAL_SERVER_ERROR

  • ZENDESK:NOT_ACCEPTABLE

  • ZENDESK:NOT_FOUND

  • ZENDESK:RETRY_EXHAUSTED

  • ZENDESK:SERVER_ERROR

  • ZENDESK:SERVICE_UNAVAILABLE

  • ZENDESK:TIMEOUT

  • ZENDESK:TOO_MANY_REQUESTS

  • ZENDESK:UNAUTHORIZED

  • ZENDESK:UNSUPPORTED_MEDIA_TYPE

Sources (ソース)

New ticket created

<zendesk:on-new-ticket-trigger>

Zendesk で新しいチケットが作成されたときに Mule フローを実行します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Created (作成済み)

String (文字列)

新しいチケットを検出するための下限となる日時値 (例: 2020-06-30T12:41:53Z​)。この値より前に追加されたチケットは New Ticket Created のソースによって検出されません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

New user created

<zendesk:on-new-user-trigger>

Zendesk で新しいユーザーが作成されたときに Mule フローを実行します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

created (作成済み)

String (文字列)

新しいユーザーを検出するための下限となる日時値 (例: 2020-06-30T12:41:53Z​)。この値より前に追加されたユーザーは New User Created のソースによって検出されません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

Existing ticket updated

<zendesk:on-updated-ticket-trigger>

Zendesk で既存のチケットが更新されたときに Mule フローを開始します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Updated (更新済み)

String (文字列)

更新されたチケットを検出するための下限となる日時値 (例: 2020-06-30T12:41:53Z​)。この値より前に更新されたチケットは Existing Ticket Updated のソースによって検出されません。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能ストリーム機能を無効にして反復不可能ストリームを使用します。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが抑えられます。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

Default Header (デフォルトヘッダー)

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Default Query Param (デフォルトクエリパラメーター)

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Proxy (プロキシ)

項目 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Non Proxy Hosts (非プロキシホスト)

String (文字列)

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom Ocsp Responder (カスタム Ocsp レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

Crl File (Crl ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

Http Response Attributes (HTTP 応答属性)

項目 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

ファイルストアの反復可能なストリームにはバッファが必要であり、さまざまなバッファ戦略があります。Mule はコンテンツの一部をメモリに保持します。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

項目 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクのコンテンツがバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Redelivery Policy (再配信ポリシー)

項目 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガーされるまでにメッセージを再配信できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Message Identifier (メッセージ識別子)

メッセージを識別するために使用する戦略を定義します。

Object Store (オブジェクトストア)

ObjectStore

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

項目 説明 デフォルト値 必須

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。