1. ホームページ
  2. Smartsheet Connector

  3. Smartsheet Connector リファレンス

All Connectors

Smartsheet Connector 1.2 リファレンス - Mule 4

Smartsheet 用 Anypoint Connector (Smartsheet Connector) を使用すると、Smartsheet API を直接操作することなく Smartsheet プラットフォームに接続できます。

設定

設定

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

Oauth 2.0 Connection Provider (Oauth 2.0 接続プロバイダー)

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

x

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

Number (数値)

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

60

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

SECONDS (秒)

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

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

  • AUTO

  • ALWAYS

  • NEVER

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

AUTO

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

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

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

接続種別

Oauth2 0 Connection Provider (Oauth2 接続プロバイダー)

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

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

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

Default Header (デフォルトヘッダー)​ の配列

クエリパラメーター

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

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 (プロキシ設定)

Proxy (プロキシ)

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

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

Boolean (ブール)

受信応答をストリーミングする (すべてのヘッダーが解析されたらすぐに処理を続行し、本文が受信されたらストリーミングする) 必要があるかどうか。

false

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

Number (数値)

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

-1

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は HTTP と HTTPS です。

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

Reconnection (再接続)

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

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

String (文字列)

サービスプロバイダーに登録されている OAuth consumerKey。

x

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

String (文字列)

サービスプロバイダーに登録されている OAuth consumerSecret。

x

Authorization Url (認証 URL)

String (文字列)

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

https://app.smartsheet.com/b/authorizeLeaving the Site

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

String (文字列)

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

https://api.smartsheet.com/2.0/token

Scopes (スコープ)

String (文字列)

ダンス時に要求する OAuth スコープ。指定されていない場合、デフォルトとしてアノテーション内のスコープが使用されます。

ADMIN_SHEETS

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

String (文字列)

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

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 が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

サポートされている操作

関連付けられたソース

操作

Create Sheet

<smartsheet:create-sheets>

新しいシートをユーザーの Sheets フォルダー内に作成します。この操作では、​/sheets​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Copy Sheet

<smartsheet:create-sheets-copy-by-sheet-id>

指定されたシートのコピーを作成します。この操作では、​/sheets/{sheetId}/copy​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

include (含める)

String (文字列)

コピーする要素のカンマ区切りのリスト。

exclude (除外)

String (文字列)

応答からシートのハイパーリンクを除外します。

Body (本文)

Any (任意)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Add Comment

<smartsheet:create-sheets-discussions-comments-by-sheet-id-discussion-id>

ディスカッションにコメントを追加します。この操作では、​/sheets/{sheetId}/discussions/{discussionId}/comments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Discussion Id (ディスカッション ID)

String (文字列)

ディスカッション ID。

x

Body (本文)

Any (任意)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Add File to Row

<smartsheet:create-sheets-rows-attachments-by-sheet-id-row-id>

ファイルを指定された行に添付します。この操作では、​/sheets/{sheetId}/rows/{rowId}/attachments​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Row Id (行 ID)

String (文字列)

行 ID。

x

Content Disposition (内容の配置)

String (文字列)

Content disposition (内容配置)

Content-Type (コンテンツの種類)

String (文字列)

コンテンツの種類

Content Length (内容の長さ)

Number (数値)

Content length (内容の長さ)

Body (本文)

Binary (バイナリ)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Add Rows

<smartsheet:create-sheets-rows-by-sheet-id>

指定されたシートに 1 つ以上の行を挿入します。この操作では、​/sheets/{sheetId}/rows​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Allow Partial Success (部分的な成功を許可)

Boolean (ブール)

true​ の場合、この項目により、Add Row 操作の部分的な成功が有効になります。

false

Override Validation (検証を上書き)

Boolean (ブール)

true​ の場合、この項目により、セル値を検証の制限外の値にすることができます。値種別のチェックをバイパスするには、この値を ​false​ に設定します。

false

Body (本文)

Any の配列

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Copy Rows to Another Sheet

<smartsheet:create-sheets-rows-copy-by-sheet-id>

指定されたシートから別のシートの一番下に行をコピーします。この操作では、​/sheets/{sheetId}/rows/copy​ エンドポイントに HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

include (含める)

String (文字列)

コピーする行要素のカンマ区切りのリスト。このコネクタでは、セルデータに加えてこれらの行がコピーされます。

Ignore Rows Not Found (見つからない行を無視)

Boolean (ブール)

true​ の場合、コピー元シート内に存在しない行 ID を指定してもエラー応答になりません。省略するか ​false​ に設定した場合、コピー元シート内に存在しない行 ID を指定するとエラー応答になり、行はコピーされません。

false

Body (本文)

Any (任意)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Delete Sheet

<smartsheet:delete-sheets-by-sheet-id>

指定されたシートを削除します。この操作では、​/sheets/{sheetId}​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Delete Rows

<smartsheet:delete-sheets-rows-by-sheet-id>

指定されたシートから 1 つ以上の行を削除します。この操作では、​/sheets/{sheetId}/rows​ エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

ids (ID)

String (文字列)

行 ID のカンマ区切りのリスト。

x

Ignore Rows Not Found (見つからない行を無視)

Boolean (ブール)

false​ で指定された行 ID がいずれも見つからない場合、行は削除されません。

false

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Search Sheet

<smartsheet:get-search-sheets-by-sheet-id>

指定されたテキストのシートを検索します。この操作では、​/search/sheets/{sheetId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

query (クエリ)

String (文字列)

検索するテキスト。完全一致検索を行うには二重引用符を使用します。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Get Sheet

<smartsheet:get-sheets-by-sheet-id>

指定されたシートを返し、必要に応じてディスカッションと添付ファイルオブジェクトを入力します。この操作では、​/sheets/{sheetId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

include (含める)

String (文字列)

応答に含める要素のカンマ区切りのリスト。

exclude (除外)

String (文字列)

応答から除外する要素のカンマ区切りのリスト。

Column Ids (列 ID)

String (文字列)

列 ID のカンマ区切りのリスト。

Filter Id (検索条件 ID)

String (文字列)

include 項目の値をここで指定した値で上書きします。

level (レベル)

Number (数値)

MULTI_CONTACT_LIST​ や MULTI-PICK-LIST などの新しい列の型のデータが後方互換性のあるテキスト形式で返されるか複合オブジェクトとして返されるかを示します。有効な値:

* 0 - 後方互換性のあるテキスト形式でデータを返します。 * 1 - 複数の連絡先データを複合オブジェクトとして返します。 * 2 - 複数の選択リストデータを複合オブジェクトとして返します。

If Version After (次のバージョン以降の場合) (非推奨)

Boolean (ブール)

(非推奨) このパラメーターは今後のリリースで削除される予定です。代わりに整数値を使用する ​[If Version After (次のバージョン以降の場合)]​ 項目を使用してください。

false

If Version After (次のバージョン以降の場合)

Number (数値)

返すシートのバージョンを指定します。

page (ページ)

Number (数値)

返すページ番号 (1 から始まる) を指定します。指定されていない場合、デフォルト値は ​1​ です。ページ番号が指定されている合計ページ数より大きい場合、最後のページが返されます。

Page Size (ページサイズ)

Number (数値)

シートに含めるページごとの行数。ページサイズとページのいずれも指定されていない場合、コネクタによってシートのすべての行が返されます。ページのみが指定されている場合、コネクタにより、デフォルトのページサイズは ​100​ になります。

Row Ids (行 ID)

String (文字列)

結果に含まれる行を絞り込む基準となる行 ID のカンマ区切りのリスト。

Row Numbers (行番号)

String (文字列)

結果に含まれる行を絞り込む基準となる行番号のカンマ区切りのリスト。存在しない行番号は無視されます。

Rows Modified Since (行変更基準日)

String (文字列)

指定された日時以降に変更された行のみを返します。日付には ISO-8601 形式を使用します。

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Get Row

<smartsheet:get-sheets-rows-by-sheet-id-row-id>

指定された行を返します。この操作では、​/sheets/{sheetId}/rows/{rowId}​ エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Row Id (行 ID)

String (文字列)

行 ID。

x

include (含める)

String (文字列)

応答に含める要素のカンマ区切りのリスト。

exclude (除外)

String (文字列)

応答から除外する要素のカンマ区切りのリスト。

level (レベル)

Number (数値)

MULTI_CONTACT_LIST​ や MULTI-PICK-LIST などの新しい列の型のデータが後方互換性のあるテキスト形式で返されるか複合オブジェクトとして返されるかを示します。有効な値:

* 0 - 後方互換性のあるテキスト形式でデータを返します。 * 1 - 複数の連絡先データを複合オブジェクトとして返します。 * 2 - 複数の選択リストデータを複合オブジェクトとして返します。

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

List Sheets

<smartsheet:get-sheets>

ユーザーがアクセスできるすべてのシートのリストを取得します。リストには、各シートの短縮された Sheet オブジェクトが含まれます。この操作では、/sheets エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

include (含める)

String (文字列)

応答に含める省略可能な要素のカンマ区切りリスト。

Modified Since (変更基準日)

String (文字列)

日時値と共に指定した場合、応答には、指定した日時以降に変更されたオブジェクトのみが含まれます。

Numeric Dates (数値日付)

Boolean (ブール)

受信および送信の数値形式の日付または時刻 (UNIX エポックからのミリ秒単位)。

false

page (ページ)

Number (数値)

ページ番号。

1

Page Size (ページサイズ)

Number (数値)

ページのサイズ。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

x

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 の配列

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<smartsheet:unauthorize>

指定されたリソースオーナー ID に関連付けられたアクセストークン情報を削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

x

次の設定の場合

Update Sheet

<smartsheet:update-sheets-by-sheet-id>

各ユーザーのシート設定を更新します。リクエストボディに userSettings 属性しか含まれていない場合、この操作はユーザーがシートに対する参照のみアクセス権しか持たない場合でも実行される場合があります (たとえば、ユーザーが閲覧者権限を持っているか、シートが読み取り専用である場合など)。この操作では、/sheets/{sheetId} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Body (本文)

Any (任意)

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Update Rows

<smartsheet:update-sheets-rows-by-sheet-id>

指定された行のセル値を更新します。この操作では、​/sheets/{sheetId}/rows​ エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シート ID。

x

Allow Partial Success (部分的な成功を許可)

Boolean (ブール)

true​ の場合、この項目により、Update Rows 操作の結果を部分的に成功にできます。

false

Override Validation (検証を上書き)

Boolean (ブール)

true​ の場合、この項目により、セル値を検証の制限外の値にすることができます。値種別のチェックをバイパスするには、この値を ​false​ に設定します。

false

Body (本文)

Any の配列

使用する内容

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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 (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • SMARTSHEET:BAD_REQUEST

  • SMARTSHEET:CLIENT_ERROR

  • SMARTSHEET:CONNECTIVITY

  • SMARTSHEET:INTERNAL_SERVER_ERROR

  • SMARTSHEET:NOT_ACCEPTABLE

  • SMARTSHEET:NOT_FOUND

  • SMARTSHEET:RETRY_EXHAUSTED

  • SMARTSHEET:SERVER_ERROR

  • SMARTSHEET:SERVICE_UNAVAILABLE

  • SMARTSHEET:TIMEOUT

  • SMARTSHEET:TOO_MANY_REQUESTS

  • SMARTSHEET:UNAUTHORIZED

  • SMARTSHEET:UNSUPPORTED_MEDIA_TYPE

Sources (ソース)

On New Or Updated Row In Sheet Trigger

<smartsheet:on-new-or-updated-row-in-sheet-trigger>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Sheet Id (シート ID)

String (文字列)

シートの一意の識別子。

x

Rows Modified Since (行変更基準日)

String (文字列)

指定された日時以降に変更された行のみを返すように絞り込みます。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Boolean (ブール)

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

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

scheduling-strategy

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

x

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

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

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

型

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

型

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

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (トラストストア)

トラストストア

Key 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 (反復可能なファイルストアストリーム)

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

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 (メッセージ識別子)

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

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

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

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストア。

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

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

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

Boolean (ブール)

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

Id Expression (ID 式)

String (文字列)

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

関連情報