1. Homepage
  2. Box Connector (5.2)

  3. Box Connector リファレンス

All Connectors

Box Connector リファレンス 5.2 - Mule 4

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

Box 用 Anypoint Connector (Box Connector) では、独自のアプリケーションで使用する安全なコンテンツ管理およびコンテンツ操作機能が Box コンテンツ API に提供されます。このコネクタは RESTful であり、Box Web インターフェースからの使い慣れた主なリソースを中心にして整理されています。

設定

パラメーター

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

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 (有効期限ポリシー)

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

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

接続種別

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

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

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

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

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 (日)

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

SECONDS (秒)

Proxy Config (プロキシ設定)

Proxy (プロキシ)

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

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

Boolean (ブール)

受信応答をストリーミングする必要があるかどうか。

false

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

Number (数値)

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

-1

Client ID (クライアント ID)

String (文字列)

X

Client Secret (クライアントシークレット)

String (文字列)

X

Public Key Id (公開キー ID)

String (文字列)

アプリケーションを認証するために Box インスタンスで設定された公開キーの ID。

X

Entity Id (エンティティ ID)

String (文字列)

エンティティ ID の種別: EnterpriseId または UserId

X

Box Sub Type (Box サブ種別)

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

  • ENTERPRISE

  • USER

Box のサブ種別: enterprise または user

X

Algorithm (アルゴリズム)

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

  • RS256

  • RS384

  • RS512

非公開キーの暗号化に使用される RSA 暗号化アルゴリズム。

X

Keystore (キーストア)

String (文字列)

キーストアへのパス。

X

Keystore Type (キーストア種別)

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

  • JKS

  • PKCS12

キーストア種別: JKS または PKCS12

X

Store Password (ストアのパスワード)

String (文字列)

キーストアのパスワード

X

Key Alias (キーの別名)

String (文字列)

キーを識別する別名。

X

Key Password (キーパスワード)

String (文字列)

Key password (キーパスワード)

X

Reconnection (再接続)

Reconnection (再接続)

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

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

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

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

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

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

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 (日)

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

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://account.box.com/api/oauth2/authorize

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

String (文字列)

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

https://api.box.com/oauth2/token

Scopes (スコープ)

String (文字列)

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

  • root_readwrite

  • manage_app_users

  • manage_managed_users

  • manage_groups

  • manage_webhook

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

String (文字列)

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

Before (前)

String (文字列)

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

After (後)

String (文字列)

アクセストークンが受信された直後に実行するフローの名前。

Listener Config (リスナー設定)

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

関連操作

関連付けられたソース

操作

Add domain to list of allowed collaboration domains

<box:create-collaboration-whitelist-entries>

コラボレーションが許可されているドメインのリストに新しいエントリを作成します。この操作では、/collaboration_whitelist_entries エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user exemption from collaboration domain restrictions

<box:create-collaboration-whitelist-exempt-targets>

コラボレーションが許可されたドメインのリストで設定された制限からユーザーを除外します。この操作では、/collaboration_whitelist_exempt_targets エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create collaboration

<box:create-collaborations>

1 人のユーザーまたは 1 つのグループのコラボレーションをファイルまたはフォルダーに追加します。コラボレーションは、メールアドレス、ユーザー ID、またはグループ ID を使用して作成できます。グループのコラボレーションが作成されている場合、このエンドポイントへのアクセスはグループが招待可能かどうかに依存します。この操作では、/collaborations エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

notify (通知)

Boolean (ブール)

実行されたアクションのメール通知をユーザーが受信するかどうかを決定します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create comment

<box:create-comments>

ユーザーによるコメントを特定のファイルに追加するか、他のコメントへの返信として追加します。この操作では、/comments エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy file request

<box:create-file-requests-copy-by-file-request-id>

1 つのフォルダー内に存在する既存のファイル要求をコピーし、それを別のフォルダーに適用します。この操作では、/file_requests/{file_request_id}/copy エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File request id (ファイル要求 ID)

String (文字列)

ファイル要求を表す一意の識別子。ファイル要求の ID は、Web アプリケーションのファイル要求ビルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/filerequest/123​ の場合、​file_request_id​ は ​123​ です。

X

Body (本文)

String (文字列)

使用するコンテンツ

#[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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore file

<box:create-files-by-file-id>

ゴミ箱に移動されたファイルを復元します。元のフォルダーが削除された場合にファイルを復元するために、必要に応じて新しい親 ID を指定できます。この操作では、/files/{file_id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Upload file

<box:create-files-content>

小さいファイルを Box にアップロードします。ファイルサイズが 50 MB を超える場合は、チャンクアップロード API を使用します。

リクエストボディで、本文の ​attributes​ 部分は ​file​ 部分より​前​にある必要があります。ファイルのアップロード時にこの形式に従っていない要求は、​metadata_after_file_contents​ エラーコードと共に HTTP ​400​ エラーを受け取ります。

この操作では、/files/content エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

Content md5 (コンテンツ MD5)

String (文字列)

ファイルが転送中に破損していないことを確認するファイルの SHA1 ハッシュを含むヘッダー (省略可能)。

Attributes - Body (属性 - 本文)

Any (任意)

「attributes」部分のコンテンツ。

#[payload]

File - Body (ファイル - 本文)

String (文字列)

「file」部分のコンテンツ。

X

file Filename (ファイルのファイル名)

String (文字列)

「file」部分のファイル名 (ファイル名のみ、パスを含まない)。

X

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Upload file version

<box:create-files-content-by-file-id>

ファイルのコンテンツを更新します。ファイルサイズが 50 MB を超える場合は、チャンクアップロード API を使用します。

リクエストボディの順序で、本文の ​attributes​ 部分は ​file​ 部分より​前​にある必要があります。ファイルのアップロード時にこの形式に従っていない要求は、​metadata_after_file_contents​ エラーコードと共に HTTP ​400​ エラーを受け取ります。

この操作では、/files/{file_id}/content エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

Content MD5 (コンテンツ MD5)

String (文字列)

ファイルが転送中に破損していないことを確認するファイルの SHA1 ハッシュを含むヘッダー (省略可能)。

Attributes - Body (属性 - 本文)

Any (任意)

「attributes」部分のコンテンツ。

#[payload]

File - Body (ファイル - 本文)

String (文字列)

「file」部分のコンテンツ。

X

file Filename (ファイルのファイル名)

String (文字列)

「file」部分のファイル名。パスは含めず、ファイル名のみを使用します。

X

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy file

<box:create-files-copy-by-file-id>

ファイルのコピーを作成します。この操作では、/files/{file_id}/copy エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata instance on file

<box:create-files-metadata-by-file-id-scope-template-key>

メタデータテンプレートのインスタンスをファイルに適用します。ほとんどの場合、メタデータテンプレートに存在する値のみが受け入れられます。ただし、​global.properties​ テンプレートはすべてのキーと値のペアを受け入れます。

この操作では、/files/{file_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add classification to file

<box:create-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>

追加する分類の表示ラベルを指定して、ファイルに分類を追加します。 この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /files/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。

この操作では、/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create Box Skill cards on file

<box:create-files-metadata-global-box-skills-cards-by-file-id>

1 つ以上の Box Skills メタデータカードをファイルに適用します。この操作では、/files/{file_id}/metadata/global/boxSkillsCards エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create upload session

<box:create-files-upload-sessions>

新しいファイルのアップロードセッションを作成します。この操作では、/files/upload_sessions エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create upload session for existing file

<box:create-files-upload-sessions-by-file-id>

既存のファイルのアップロードセッションを作成します。この操作では、/files/{file_id}/upload_sessions エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Commit upload session

<box:create-files-upload-sessions-commit-by-upload-session-id>

アップロードセッションを終了し、アップロードされたチャンクからファイルを作成します。この操作では、/files/upload_sessions/{upload_session_id}/commit エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Upload session id (アップロードセッション ID)

String (文字列)

アップロードセッションの ID。

X

ダイジェスト

String (文字列)

ファイル全体の [RFC3230][1] メッセージダイジェスト。SHA1 のみがサポートされています。SHA1 ダイジェストは Base64 でエンコードされている必要があります。このヘッダーの形式は ​sha=BASE64_ENCODED_DIGEST​ です。[1]: https://tools.ietf.org/html/rfc3230

X

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

If none match (一致しない合)

String (文字列)

項目が変更された場合にのみ項目が返されるようにします。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されていない場合、エンドポイントは ​304 Not Modified​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Revert file version

<box:create-files-versions-current-by-file-id>

ファイルの以前のバージョンに戻します。以前のバージョンが存在する場合、このメソッドを使用して、古いバージョンの 1 つをバージョン履歴の先頭に昇格できます。これにより、古いバージョンのファイルの新しいコピーが作成され、バージョン履歴の一番上に配置されます。ファイルのコンテンツは古いバージョンとまったく同じで、ハッシュダイジェスト、​etag​、名前は元のバージョンと同じです。コメントなどの他のプロパティは、以前の値に更新されません。

この操作では、/files/{file_id}/versions/current エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create folder lock on folder

<box:create-folder-locks>

フォルダーのフォルダーロックを作成し、フォルダーの移動や削除を実行できないようにします。この操作では、/folder_locks エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create folder

<box:create-folders>

特定の親フォルダー内に新しい空のフォルダーを作成します。この操作では、/folders エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore folder

<box:create-folders-by-folder-id>

ゴミ箱に移動されたフォルダーを復元します。元のフォルダーが削除された場合にフォルダーを復元するために、必要に応じて新しい親 ID を指定できます。

フォルダーのロック

この操作中、ファイルツリーの一部、主にソースフォルダーとそのすべての子孫、および宛先フォルダーがロックされます。操作中は、ロックされたフォルダーに対して他の移動、コピー、削除、または復元操作を実行することはできません。

この操作では、/folders/{folder_id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Copy folder

<box:create-folders-copy-by-folder-id>

宛先フォルダー内にフォルダーのコピーを作成します。元のフォルダーは変更されません。この操作では、/folders/{folder_id}/copy エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

コピーするフォルダーの一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。ID ​0​ のルートフォルダーはコピーできません。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata instance on folder

<box:create-folders-metadata-by-folder-id-scope-template-key>

メタデータテンプレートのインスタンスをフォルダーに適用します。ほとんどの場合、メタデータテンプレートに存在する値のみが受け入れられます。ただし、​global.properties​ テンプレートはすべてのキーと値のペアを受け入れます。

Box Web アプリケーションでメタデータテンプレートを表示するには、管理コンソールでユーザーに対して​カスケードフォルダーレベルのメタデータ​を有効にするようにエンタープライズを設定する必要があります。

この操作では、/folders/{folder_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add classification to folder

<box:create-folders-metadata-enterprise-security-classification6vmvochwUwo-by-folder-id>

追加する分類の表示ラベルを指定して、フォルダーに分類を追加します。 この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。

この操作では、/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add user to group

<box:create-group-memberships>

グループメンバーシップを作成します。管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/group_memberships エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create group

<box:create-groups>

エンタープライズにユーザーの新しいグループを作成します。管理者権限を持つユーザーのみが新しいグループを作成できます。この操作では、/groups エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user invite

<box:create-invites>

既存の外部ユーザーをエンタープライズに招待します。既存のユーザーは別のエンタープライズに参加することはできず、すでに Box アカウントを持っている必要があります。招待されたユーザーはメールを受信し、Box Web アプリケーション内で招待を受け入れるように求められます。このメソッドでは、アプリケーションで [Manage An Enterprise (エンタープライズの管理)] スコープを有効にする必要があります。これは、開発者コンソール内で有効にできます。この操作では、/invites エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create legal hold policy

<box:create-legal-hold-policies>

リーガルホールドポリシーを作成します。この操作では、/legal_hold_policies エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign legal hold policy

<box:create-legal-hold-policy-assignments>

ファイル、ファイルバージョン、フォルダー、またはユーザーにリーガルホールドを割り当てます。この操作では、/legal_hold_policy_assignments エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata cascade policy

<box:create-metadata-cascade-policies>

特定のメタデータテンプレートを特定のフォルダーに適用し、それをそのフォルダー内の任意のファイルに自動的にカスケードする、新しいメタデータカスケードポリシーを作成します。ポリシーを適用するには、最初にポリシーを適用するフォルダーにメタデータインスタンスを適用する必要があります。この操作では、/metadata_cascade_policies エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Force-apply metadata cascade policy to folder

<box:create-metadata-cascade-policies-apply-by-metadata-cascade-policy-id>

メタデータカスケードポリシーが適用されたフォルダーのメタデータをそのすべての子に強制的に適用します。新しいカスケードポリシーを作成した後にこれを使用して、メタデータをそのフォルダー内の既存のすべてのファイルにカスケードできます。

この操作では、/metadata_cascade_policies/{metadata_cascade_policy_id}/apply エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Metadata cascade policy 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Query files and folders by metadata

<box:create-metadata-queries-execute-read>

SQL のような構文を使用して検索を作成し、特定のメタデータに一致する項目を返します。デフォルトでは、このエンドポイントはクエリが照合する項目に関する最も基本的な情報のみを返します。メタデータを含む、各項目の追加項目を取得するには、クエリで ​fields​ 属性を使用します。この操作では、/metadata_queries/execute_read エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create metadata template

<box:create-metadata-templates-schema>

ファイルとフォルダーに適用できる新しいメタデータテンプレートを作成します。この操作では、/metadata_templates/schema エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add initial classifications

<box:create-metadata-templates-schemaclassifications>

エンタープライズにまだ分類がない場合、この API コールは分類の初期セットを使用して分類テンプレートを初期化します。エンタープライズにすでに分類がある場合、テンプレートはすでに存在します。代わりに、API コールを使用して分類を追加します。

この操作では、/metadata_templates/schema#classifications エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create retention policy

<box:create-retention-policies>

保持ポリシーを作成します。この操作では、/retention_policies エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign retention policy

<box:create-retention-policy-assignments>

項目に保持ポリシーを追加します。この操作では、/retention_policy_assignments エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign storage policy

<box:create-storage-policy-assignments>

エンタープライズまたはユーザーのストレージポリシー割り当てを作成します。この操作では、/storage_policy_assignments エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Assign task

<box:create-task-assignments>

ユーザーにタスクを割り当てます。タスクを複数のユーザーに割り当てるには、複数の割り当てを作成します。この操作では、/task_assignments エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create task

<box:create-tasks>

ファイルの 1 つのタスクを作成します。このタスクはどのユーザーにも割り当てられていないため、個別に割り当てる必要があります。この操作では、/tasks エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create terms of service status for new user

<box:create-terms-of-service-user-statuses>

ユーザーのサービス利用規約の状況を設定します。この操作では、/terms_of_service_user_statuses エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create terms of service

<box:create-terms-of-services>

特定のエンタープライズとユーザー種別のサービス利用規約を作成します。この操作では、/terms_of_services エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create user

<box:create-users>

エンタープライズに新しい管理対象ユーザーを作成します。このエンドポイントは、適切な管理者権限を持つユーザーとアプリケーションのみが使用できます。この操作では、/users エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create email alias

<box:create-users-email-aliases-by-user-id>

新しいメール別名をユーザーアカウントに追加します。この操作では、/users/{user_id}/email_aliases エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

<box:create-web-links>

フォルダー内に Web リンクオブジェクトを作成します。この操作では、/web_links エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Restore web link

<box:create-web-links-by-web-link-id>

ゴミ箱に移動された Web リンクを復元します。元のフォルダーが削除された場合に Web リンクを復元するために、必要に応じて新しい親 ID を指定できます。

この操作では、/web_links/{web_link_id} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの ID。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create webhook

<box:create-webhooks>

Web フックを作成します。この操作では、/webhooks エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Create zip download

<box:create-zip-downloads>

複数のファイルとフォルダーを 1 つの ​zip​ アーカイブファイルとしてダウンロードする要求を作成します。この API はアーカイブを返しませんが、代わりにすべてのチェックを実行して、ユーザーがすべての項目にアクセスできることを確認してから、アーカイブのダウンロードに使用できる ​download_url​ と ​status_url​ を返します。アーカイブの制限は、32 GB または 10,000 ファイルのいずれかの最初に到達した制限が適用されます。

この操作では、/zip_downloads エンドポイントに対する 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove domain from list of allowed collaboration domains

<box:delete-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>

現在のエンタープライズ内でコラボレーションを作成するのに安全であるとみなされたドメインのリストから、ドメインを削除します。この操作では、/collaboration_whitelist_entries/{collaboration_whitelist_entry_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration whitelist entry 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove user from list of users exempt from domain restrictions

<box:delete-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>

コラボレーションが許可されたドメインのリストで設定された制限からのユーザーの除外を削除します。この操作では、/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration whitelist exempt target 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove collaboration

<box:delete-collaborations-by-collaboration-id>

1 つのコラボレーションを削除します。この操作では、/collaborations/{collaboration_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove comment

<box:delete-comments-by-comment-id>

コメントを完全に削除します。この操作では、/comments/{comment_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Comment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove device pin

<box:delete-device-pinners-by-device-pinner-id>

個々のデバイスピンを削除します。この操作では、/device_pinners/{device_pinner_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Device pinner id (Device Pinner 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete file request

<box:delete-file-requests-by-file-request-id>

ファイル要求を完全に削除します。この操作では、/file_requests/{file_request_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File request id (ファイル要求 ID)

String (文字列)

ファイル要求を表す一意の識別子。ファイル要求の ID は、Web アプリケーションのファイル要求ビルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/filerequest/123​ の場合、​file_request_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete file

<box:delete-files-by-file-id>

ファイルを完全に削除するか、ゴミ箱に移動します。エンタープライズ設定により、項目を Box から完全に削除するか、ゴミ箱に移動するかが決まります。

この操作では、/files/{file_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata instance from file

<box:delete-files-metadata-by-file-id-scope-template-key>

ファイルメタデータの一部を削除します。この操作では、/files/{file_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove classification from file

<box:delete-files-metadata-enterprise-security-classification-by-file-id>

ファイルから分類を削除します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /files/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。

この操作では、/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove Box Skill cards from file

<box:delete-files-metadata-global-box-skills-cards-by-file-id>

Box Skills カードのメタデータをファイルから削除します。この操作では、/files/{file_id}/metadata/global/boxSkillsCards エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove file

<box:delete-files-trash-by-file-id>

ゴミ箱にあるファイルを完全に削除します。このアクションは元に戻せません。この操作では、/files/{file_id}/trash エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove upload session

<box:delete-files-upload-sessions-by-upload-session-id>

アップロードセッションを中止し、アップロードされたすべてのデータを破棄します。これは元に戻せません。この操作では、/files/upload_sessions/{upload_session_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Upload session 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove file version

<box:delete-files-versions-by-file-id-file-version-id>

ファイルバージョンをゴミ箱に移動します。バージョンは、プレミアムアカウントを持つ Box ユーザーに対してのみ追跡されます。この操作では、/files/{file_id}/versions/{file_version_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

File version id (ファイルバージョン ID)

String (文字列)

ファイルバージョンの ID。

X

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove watermark from file

<box:delete-files-watermark-by-file-id>

ファイルからウォーターマークを削除します。この操作では、/files/{file_id}/watermark エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete folder lock

<box:delete-folder-locks-by-folder-lock-id>

特定のフォルダーのフォルダーロックを削除します。この操作では、/folder_locks/{folder_lock_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder lock 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete folder

<box:delete-folders-by-folder-id>

フォルダーを完全に削除するか、ゴミ箱に移動します。この操作では、/folders/{folder_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

recursive (再帰)

Boolean (ブール)

フォルダーとそのすべてのコンテンツを再帰的に削除して、空でないフォルダーを削除します。

false

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata instance from folder

<box:delete-folders-metadata-by-folder-id-scope-template-key>

フォルダーメタデータの一部を削除します。この操作では、/folders/{folder_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove classification from folder

<box:delete-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>

フォルダーから分類を削除します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。

この操作では、/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove folder

<box:delete-folders-trash-by-folder-id>

ゴミ箱にあるフォルダーを完全に削除します。このアクションは元に戻せません。この操作では、/folders/{folder_id}/trash エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove watermark from folder

<box:delete-folders-watermark-by-folder-id>

フォルダーからウォーターマークを削除します。この操作では、/folders/{folder_id}/watermark エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove user from group

<box:delete-group-memberships-by-group-membership-id>

特定のグループメンバーシップを削除します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/group_memberships/{group_membership_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group membership 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove group

<box:delete-groups-by-group-id>

グループを完全に削除します。管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/groups/{group_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove legal hold policy

<box:delete-legal-hold-policies-by-legal-hold-policy-id>

既存のリーガルホールドポリシーを削除します。これは非同期プロセスです。応答が返されたときに、ポリシーはまだ完全には削除されません。この操作では、/legal_hold_policies/{legal_hold_policy_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign legal hold policy

<box:delete-legal-hold-policy-assignments-by-legal-hold-policy-assignment-id>

項目からリーガルホールドを削除します。これは非同期プロセスです。応答が返されたときに、ポリシーはまだ完全には削除されません。この操作では、/legal_hold_policy_assignments/{legal_hold_policy_assignment_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata cascade policy

<box:delete-metadata-cascade-policies-by-metadata-cascade-policy-id>

メタデータカスケードポリシーを削除します。この操作では、/metadata_cascade_policies/{metadata_cascade_policy_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Metadata cascade policy 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete all classifications

<box:delete-metadata-templates-enterprise-security-classification6vmvochw-uwo-schema>

分類メタデータテンプレートを削除して、すべての分類を削除します。この操作では、/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove metadata template

<box:delete-metadata-templates-schema-by-scope-template-key>

メタデータテンプレートとそのインスタンスを削除します。この削除は永続的であり、元に戻すことはできません。この操作では、/metadata_templates/{scope}/{template_key}/schema エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign storage policy

<box:delete-storage-policy-assignments-by-storage-policy-assignment-id>

ストレージポリシー割り当てを削除します。ユーザーのストレージポリシー割り当てを削除すると、ユーザーはエンタープライズのデフォルトのストレージポリシーを継承します。このエンドポイントのコールには、24 時間以内にユーザーあたり 2 回のみのレート制限があります。この操作では、/storage_policy_assignments/{storage_policy_assignment_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Storage policy assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unassign task

<box:delete-task-assignments-by-task-assignment-id>

特定のタスク割り当てを削除します。この操作では、/task_assignments/{task_assignment_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove task

<box:delete-tasks-by-task-id>

ファイルからタスクを削除します。この操作では、/tasks/{task_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete user

<box:delete-users-by-user-id>

ユーザーを削除します。デフォルトでは、ユーザーがまだコンテンツを所有している場合、この操作は失敗します。続行する前にユーザーが所有するコンテンツを移動するか、​force​ 項目を使用してユーザーとそのファイルを削除してください。この操作では、/users/{user_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

notify (通知)

Boolean (ブール)

ユーザーが削除のメール通知を受信するかどうか。

false

force (強制)

Boolean (ブール)

このユーザーがまだファイルを所有している場合でも、ユーザーを削除するかどうか。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove email alias

<box:delete-users-email-aliases-by-user-id-email-alias-id>

ユーザーからメール別名を削除します。この操作では、/users/{user_id}/email_aliases/{email_alias_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

Email alias 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove web link

<box:delete-web-links-by-web-link-id>

Web リンクを削除します。この操作では、/web_links/{web_link_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Permanently remove web link

<box:delete-web-links-trash-by-web-link-id>

ゴミ箱にある Web リンクを完全に削除します。このアクションは元に戻せません。この操作では、/web_links/{web_link_id}/trash エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove webhook

<box:delete-webhooks-by-webhook-id>

Web フックを削除します。この操作では、/webhooks/{webhook_id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Webhook id (Web フック ID)

String (文字列)

Web フックの 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List allowed collaboration domains

<box:get-collaboration-whitelist-entries>

現在のエンタープライズ内でコラボレーションを作成するのに安全であるとみなされたドメインのリストを返します。この操作では、/collaboration_whitelist_entries エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get allowed collaboration domain

<box:get-collaboration-whitelist-entries-by-collaboration-whitelist-entry-id>

現在のエンタープライズ内でコラボレーションを作成するのに安全であるとみなされたドメインを返します。この操作では、/collaboration_whitelist_entries/{collaboration_whitelist_entry_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration whitelist entry 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List users exempt from collaboration domain restrictions

<box:get-collaboration-whitelist-exempt-targets>

コラボレーションドメインの制限から除外されているユーザーのリストを返します。この操作では、/collaboration_whitelist_exempt_targets エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get user exempt from collaboration domain restrictions

<box:get-collaboration-whitelist-exempt-targets-by-collaboration-whitelist-exempt-target-id>

コラボレーションドメインの制限から除外されているユーザーを返します。

この操作では、/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration whitelist exempt target 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List pending collaborations

<box:get-collaborations>

このユーザーの保留中のすべてのコラボレーション招待のリストを取得します。この操作では、/collaborations エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

status (状況)

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

  • PENDING

取得するコラボレーションの状況。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get collaboration

<box:get-collaborations-by-collaboration-id>

1 つのコラボレーションを取得します。この操作では、/collaborations/{collaboration_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration id (コラボレーション ID)

String (文字列)

コラボレーションの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all collections

<box:get-collections>

特定のユーザーのすべてのコレクションのリストを取得します。現在、​favorites​ コレクションのみがサポートされています。この操作では、/collections エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List collection items

<box:get-collections-items-by-collection-id>

このコレクションに含まれるファイルとフォルダーを取得します。この操作では、/collections/{collection_id}/items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collection id (コレクション ID)

String (文字列)

コレクションの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列 * Any (任意) * Any (任意)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get comment

<box:get-comments-by-comment-id>

特定のコメントのメッセージとメタデータ、およびコメントを作成したユーザーに関する情報を取得します。この操作では、/comments/{comment_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Comment id (コメント ID)

String (文字列)

コメントの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get device pin

<box:get-device-pinners-by-device-pinner-id>

個々のデバイスピンに関する情報を取得します。この操作では、/device_pinners/{device_pinner_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Device pinner id (Device Pinner 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List enterprise device pins

<box:get-enterprises-device-pinners-by-enterprise-id>

エンタープライズ内のすべてのデバイスピンのリストを取得します。ユーザーには管理者権限が必要であり、アプリケーションにはこのコールを行うための ​manage enterprise​ スコープが必要です。この操作では、/enterprises/{enterprise_id}/device_pinners エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Enterprise id (Enterprise ID)

String (文字列)

エンタープライズの ID。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

direction (方向)

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

  • ASC

  • DESC

結果を並び替える方向。 アルファベットの昇順 (​ASC​) または降順 (​DESC​) のいずれかを指定できます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List user and enterprise events

<box:get-events>

特定のユーザーまたはエンタープライズ全体の過去 1 年間のイベントを返します。デフォルトでは、認証済みユーザーのイベントが返されます。エンタープライズ全体のイベントを取得するには、​stream_type​ を ​admin_logs​ に設定します。API コールを行うユーザーには管理者権限が必要であり、アプリケーションにはイベントフィードにアクセスしてエンタープライズイベントフィードを取得する権限が必要です。この操作では、/events エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Stream type (ストリーム種別)

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

  • ALL (すべて)

  • CHANGES

  • SYNC

  • ADMIN_LOGS

返されるイベントの種別を定義します。* ​all​ はユーザーのすべてのイベントを返します。これがデフォルトです。 * ​changes​ は、ファイルの更新やコラボレーションなどのファイルツリーの変更が発生する可能性のあるイベントを返します。 *​sync​ は ​changes​ と似ていますが、同期されたフォルダーにのみ適用されます。 * ​admin_logs​ は、エンタープライズ全体のすべてのイベントを返し、API コールを行うユーザーには管理者権限が必要です。

ALL (すべて)

Stream position (ストリーム位置)

String (文字列)

イベントの受信を開始するイベントストリーム内の位置。 *​now​ は空のイベントリストと初期化のためのストリーム内の最新の位置を返します。 *​0​ または ​null​ は、すべてのイベントを返します。

limit (制限)

Number (数値)

返されるイベントの数を制限します。

100

Event type (イベント種別)

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

  • ACCESS_GRANTED​

  • ACCESS_REVOKED​

  • ADD_DEVICE_ASSOCIATION​

  • ADD_LOGIN_ACTIVITY_DEVICE​

  • ADMIN_LOGIN​

  • APPLICATION_CREATED​

  • APPLICATION_PUBLIC_KEY_ADDED​

  • APPLICATION_PUBLIC_KEY_DELETED​

  • CHANGE_ADMIN_ROLE​

  • CHANGE_FOLDER_PERMISSION​

  • COLLABORATION_ACCEPT​

  • COLLABORATION_EXPIRATION​

  • COLLABORATION_INVITE​

  • COLLABORATION_REMOVE​

  • COLLABORATION_ROLE_CHANGE​

  • COMMENT_CREATE​

  • COMMENT_DELETE​

  • CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY​

  • CONTENT_WORKFLOW_AUTOMATION_ADD​

  • CONTENT_WORKFLOW_AUTOMATION_DELETE​

  • CONTENT_WORKFLOW_POLICY_ADD​

  • CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION​

  • CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION​

  • COPY

  • DATA_RETENTION_CREATE_RETENTION​

  • DATA_RETENTION_REMOVE_RETENTION​

  • DELETE

  • DELETE_USER​

  • DEVICE_TRUST_CHECK_FAILED​

  • DOWNLOAD

  • EDIT

  • EDIT_USER​

  • EMAIL_ALIAS_CONFIRM​

  • EMAIL_ALIAS_REMOVE​

  • ENTERPRISE_APP_AUTHORIZATION_UPDATE​

  • EXTERNAL_COLLAB_SECURITY_SETTINGS​

  • FAILED_LOGIN​

  • FILE_MARKED_MALICIOUS​

  • FILE_WATERMARKED_DOWNLOAD​

  • GROUP_ADD_ITEM​

  • GROUP_ADD_USER​

  • GROUP_CREATION​

  • GROUP_DELETION​

  • GROUP_EDITED​

  • GROUP_REMOVE_ITEM​

  • GROUP_REMOVE_USER​

  • ITEM_MODIFY​

  • ITEM_OPEN​

  • ITEM_SHARED_UPDATE​

  • ITEM_SYNC​

  • ITEM_UNSYNC​

  • LEGAL_HOLD_ASSIGNMENT_CREATE​

  • LEGAL_HOLD_ASSIGNMENT_DELETE​

  • LEGAL_HOLD_POLICY_CREATE​

  • LEGAL_HOLD_POLICY_DELETE​

  • LEGAL_HOLD_POLICY_UPDATE​

  • LOCK

  • LOGIN

  • METADATA_INSTANCE_CREATE​

  • METADATA_INSTANCE_DELETE​

  • METADATA_INSTANCE_UPDATE​

  • METADATA_TEMPLATE_CREATE​

  • METADATA_TEMPLATE_DELETE​

  • METADATA_TEMPLATE_UPDATE​

  • MOVE

  • NEW_USER​

  • OAUTH2_ACCESS_TOKEN_REVOKE​

  • PREVIEW

  • REMOVE_DEVICE_ASSOCIATION​

  • REMOVE_LOGIN_ACTIVITY_DEVICE​

  • RENAME

  • RETENTION_POLICY_ASSIGNMENT_ADD​

  • SHARE

  • SHARE_EXPIRATION​

  • SHIELD_ALERT​

  • STORAGE_EXPIRATION​

  • TASK_ASSIGNMENT_CREATE​

  • TASK_ASSIGNMENT_DELETE​

  • TASK_ASSIGNMENT_UPDATE​

  • TASK_CREATE​

  • TASK_UPDATE​

  • TERMS_OF_SERVICE_ACCEPT​

  • TERMS_OF_SERVICE_REJECT​

  • UNDELETE

  • UNLOCK

  • UNSHARE

  • UPDATE_COLLABORATION_EXPIRATION​

  • UPDATE_SHARE_EXPIRATION​

  • UPLOAD

  • USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE​

  • WATERMARK_LABEL_CREATE​

  • WATERMARK_LABEL_DELETE

絞り込むイベントのカンマ区切りのリスト。これは、​admin_logs​ の ​stream_type​ でイベントを要求する場合にのみ使用できます。その他の ​stream_type​ の場合、この値は無視されます。

Created after (この日付より後に作成)

String (文字列)

イベントを返す下限の日時。これは、​admin_logs​ の ​stream_type​ でイベントを要求する場合にのみ使用できます。その他の ​stream_type​ の場合、この値は無視されます。

Created before (この日付より前に作成)

String (文字列)

イベントを返す上限の日時。これは、​admin_logs​ の ​stream_type​ でイベントを要求する場合にのみ使用できます。その他の ​stream_type​ の場合、この値は無視されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file request

<box:get-file-requests-by-file-request-id>

ファイル要求に関する情報を取得します。この操作では、/file_requests/{file_request_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File request id (ファイル要求 ID)

String (文字列)

ファイル要求を表す一意の識別子。ファイル要求の ID は、Web アプリケーションのファイル要求ビルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/filerequest/123​ の場合、​file_request_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List file version legal holds

<box:get-file-version-legal-holds>

リーガルホールド割り当てでのリーガルホールド時のファイルバージョンのリストを取得します。再設計に取り組み中のため、この API はこのポリシー ID のすべてのファイルバージョンを返さない場合があります。代わりに、この API は従来のアーキテクチャで保持されているファイルバージョンのみを返します。

2 つの新しいエンドポイントを使用して、新しいアーキテクチャで保持されているファイルバージョンを要求できます。新しいアーキテクチャで保持されているファイルバージョンの場合、​GET /legal_hold_policy_assignments/:id/file_versions_on_hold​ API を使用して、このポリシー割り当てに使用できる過去のすべてのファイルバージョンを返すことができます。また、​GET /legal_hold_policy_assignments/:id/files_on_hold​ API を使用して、リーガルホールド中のファイルの現在 (最新) のバージョンを返すことができます。​GET /legal_hold_policy_assignments?policy_id={id}​ API を使用して、特定のポリシー ID のポリシー割り当てのリストを確認できます。再設計が完了したら、この API は非推奨になります。

この操作では、/file_version_legal_holds エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Policy id (ポリシー ID)

String (文字列)

リーガルホールドのファイルバージョンを取得するリーガルホールドポリシーの ID。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file version legal hold

<box:get-file-version-legal-holds-by-file-version-legal-hold-id>

ファイルバージョンに割り当てられたリーガルホールドポリシーに関する情報を取得します。この操作では、/file_version_legal_holds/{file_version_legal_hold_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File version legal hold 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List file version retentions

<box:get-file-version-retentions>

特定のエンタープライズのすべてのファイルバージョン保持を取得します。この操作では、/file_version_retentions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

この ID のファイルで結果を絞り込みます。

File version id (ファイルバージョン ID)

String (文字列)

この ID のファイルバージョンで結果を絞り込みます。

Policy id (ポリシー ID)

String (文字列)

この ID の保持ポリシーで結果を絞り込みます。

Disposition action (配置アクション)

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

  • PERMANENTLY_DELETE​

  • REMOVE_RETENTION

この配置アクションを使用する保持ポリシーで結果を絞り込みます。

Disposition before (この日付より前の配置)

String (文字列)

この日付より前に配置が有効になるファイルで結果を絞り込みます。

Disposition after (この日付より後の配置)

String (文字列)

この日付より後に配置が有効になるファイルで結果を絞り込みます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get retention on file

<box:get-file-version-retentions-by-file-version-retention-id>

ファイルバージョン保持に関する情報を返します。この操作では、/file_version_retentions/{file_version_retention_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File version retention 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file information

<box:get-files-by-file-id>

ファイルに関する詳細を取得します。この操作では、/files/{file_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。さらに、この項目を使用して、​metadata​ 項目および取得するテンプレートのスコープとキーを指定することで、ファイルに適用されるメタデータを照会できます (例: ?field=metadata.enterprise_12345.contractTemplate​)。

If none match (一致しない合)

String (文字列)

項目が変更された場合にのみ項目が返されるようにします。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されていない場合、エンドポイントは ​304 Not Modified​ で失敗します。

boxapi

String (文字列)

この項目の共有リンクの URL、および省略可能なパスワード。このヘッダーを使用して、ユーザーと明示的に共有されていない項目にアクセスできます。形式 ​shared_link=[link]​ を使用するか、パスワードが必要な場合は ​shared_link=[link]&shared_link_password=[password]​ を使用します。このヘッダーは、共有されているファイルまたはフォルダー、および項目内にネストされているファイルまたはフォルダーで使用できます。

X rep hints (X 表現ヒント)

String (文字列)

ファイルの特定の ​representations​ を要求するために必要なヘッダー。これを ​fields​ クエリパラメーターと組み合わせて使用し、特定のファイル表現を要求します。これらの表現の一般的な形式は ​X-Rep-Hints: […​]​ です。ここで、​[…​]​ は形式 ​[fileType?query]​ の 1 つ以上のヒントです。たとえば、​32x32​ および ​94x94​ ピクセルサイズで ​png​ 表現を要求するには、次のヒントを指定します。 X-Rep-Hints: [jpg?dimensions=32x32][jpg?dimensions=94x94]​ さらに、​[extracted_text]​ 表現を使用する Box 内のすべてのドキュメントファイル種別で ​text​ 表現を使用できます。 X-Rep-Hints: [extracted_text]

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List file collaborations

<box:get-files-collaborations-by-file-id>

ファイルの保留中およびアクティブなコラボレーションのリストを取得します。これにより、ファイルへのアクセス権があるか、ファイルに招待されたすべてのユーザーが返されます。この操作では、/files/{file_id}/collaborations エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List file comments

<box:get-files-comments-by-file-id>

ファイルのコメントのリストを取得します。この操作では、/files/{file_id}/comments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Download file

<box:get-files-content-by-file-id>

ファイルのコンテンツをバイナリ形式で返します。この操作では、/files/{file_id}/content エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

version (バージョン)

String (文字列)

ダウンロードするファイルバージョン。

Access token (アクセストークン)

String (文字列)

この要求の事前認証に使用できる省略可能なアクセストークン。これにより、認証の処理方法を説明することなくダウンロードリンクをブラウザーまたはサードパーティのサービスと共有できます。このパラメーターを使用する場合、アクセストークンのスコープが十分に絞り込まれ、他のファイルやフォルダーではなくそのファイルのみへの参照アクセスが許可されているとを確認してください。

range (範囲)

String (文字列)

ダウンロードするコンテンツのバイト範囲。形式 ​{start_byte}-{end_byte}​ を使用して、ファイルのどのセクションをダウンロードするかを指定できます。

boxapi

String (文字列)

この項目の共有リンクの URL、および省略可能なパスワード。このヘッダーを使用して、ユーザーと明示的に共有されていない項目にアクセスできます。形式 ​shared_link=[link]​ を使用するか、パスワードが必要な場合は ​shared_link=[link]&shared_link_password=[password]​ を使用します。このヘッダーは、共有されているファイルまたはフォルダー、および項目内にネストされているファイルまたはフォルダーで使用できます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get shared link for file

<box:get-files-get-shared-link-by-file-id>

ファイル上の共有リンクの情報を取得します。この操作では、/files/{file_id}#get_shared_link エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List metadata instances on file

<box:get-files-metadata-by-file-id>

特定のファイルのすべてのメタデータを取得します。この操作では、/files/{file_id}/metadata エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get metadata instance on file

<box:get-files-metadata-by-file-id-scope-template-key>

ファイルに適用されたメタデータテンプレートのインスタンスを取得します。この操作では、/files/{file_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get classification on file

<box:get-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>

ファイルに適用された分類メタデータインスタンスを取得します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /files/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。この操作では、/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List Box Skill cards on file

<box:get-files-metadata-global-box-skills-cards-by-file-id>

ファイルに添付されている Box Skills メタデータカードをリストします。この操作では、/files/{file_id}/metadata/global/boxSkillsCards エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List tasks on file

<box:get-files-tasks-by-file-id>

ファイルのすべてのタスクのリストを取得します。このエンドポイントはページネーションをサポートしていません。この操作では、/files/{file_id}/tasks エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file thumbnail

<box:get-files-thumbnail-by-file-id-extension>

ファイルのサムネイルまたは小さい画像表現を取得します。​32x32​、​64x64​、​128x128​、​256x256​ のサイズは ​.png​ 形式、​32x32​、​94x94​、​160x160​、​320x320​ のサイズは ​.jpg​ 形式で返すことができます。 Box コミュニティサイト​にリストされている画像および動画ファイル形式のサムネイルを生成できます。

この操作では、/files/{file_id}/thumbnail.{extension} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

extension (拡張子)

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

  • PNG

  • JPG

サムネイルのファイル形式。

X

Min height (最小高さ)

Number (数値)

サムネイルの最小高さ。

Min width (最小幅)

Number (数値)

サムネイルの最小幅。

Max height (最大高さ)

Number (数値)

サムネイルの最大高さ。

Max width (最大幅)

Number (数値)

サムネイルの最大幅。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get trashed file

<box:get-files-trash-by-file-id>

ゴミ箱に移動されたファイルを取得します。ファイル自体をゴミ箱に移動した場合にのみ、ファイルを取得できます。代わりにその親フォルダーの 1 つがゴミ箱に移動された場合、[​GET /folders/:id/trash​](e://get_folders_id_trash) API を使用してそのフォルダーのみを検査できます。ゴミ箱に移動されたすべての項目をリストするには、[​GET /folders/trash/items​](e://get-folders-trash-items/) API を使用します。

この操作では、/files/{file_id}/trash エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get upload session

<box:get-files-upload-sessions-by-upload-session-id>

アップロードセッションに関する情報を返します。この操作では、/files/upload_sessions/{upload_session_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Upload session 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List parts

<box:get-files-upload-sessions-parts-by-upload-session-id>

これまでにアップロードセッションにアップロードされたチャンクのリストを返します。この操作では、/files/upload_sessions/{upload_session_id}/parts エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Upload session id (アップロードセッション ID)

String (文字列)

アップロードセッションの ID。

X

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all file versions

<box:get-files-versions-by-file-id>

ファイルの過去のバージョンのリストを取得します。バージョンは、プレミアムアカウントを持つ Box ユーザーでのみ追跡されます。ファイルの現在のバージョンの ID を取得するには、​GET /file/:id​ API を使用します。この操作では、/files/{file_id}/versions エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get file version

<box:get-files-versions-by-file-id-file-version-id>

ファイルの特定のバージョンを取得します。バージョンは、プレミアムアカウントを持つ Box ユーザーに対してのみ追跡されます。この操作では、/files/{file_id}/versions/{file_version_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

File version id (ファイルバージョン ID)

String (文字列)

ファイルバージョンの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get watermark on file

<box:get-files-watermark-by-file-id>

ファイルのウォーターマークを取得します。この操作では、/files/{file_id}/watermark エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List folder locks on folder

<box:get-folder-locks>

特定のフォルダーのフォルダーロックの詳細を取得します。この操作では、/folder_locks エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get folder information

<box:get-folders-by-folder-id>

フォルダーの詳細 (フォルダーの最初の 100 エントリが含まれる) を取得します。フォルダー内の項目をさらにフェッチするには、[Get items in a folder](#get-folders-id-items) エンドポイントを使用します。この操作では、/folders/{folder_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。さらに、この項目を使用して、​metadata​ 項目および取得するテンプレートのスコープとキーを指定することで、ファイルに適用されるメタデータを照会できます (例: ?field=metadata.enterprise_12345.contractTemplate​)。

If none match (一致しない合)

String (文字列)

項目が変更された場合にのみ項目が返されるようにします。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されていない場合、エンドポイントは ​304 Not Modified​ で失敗します。

boxapi

String (文字列)

この項目の共有リンクの URL、および省略可能なパスワード。このヘッダーを使用して、ユーザーと明示的に共有されていない項目にアクセスできます。形式 ​shared_link=[link]​ を使用するか、パスワードが必要な場合は ​shared_link=[link]&shared_link_password=[password]​ を使用します。このヘッダーは、共有されているファイルまたはフォルダー、および項目内にネストされているファイルまたはフォルダーで使用できます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List folder collaborations

<box:get-folders-collaborations-by-folder-id>

フォルダーの保留中およびアクティブなコラボレーションのリストを取得します。この操作では、このフォルダーへのアクセス権を持つユーザーまたはこのフォルダーに招待されたユーザーがすべて返されます。この操作では、/folders/{folder_id}/collaborations エンドポイントに対する HTTP GET 要求を行います。

Box で基盤となる API エンドポイントが変更されたため、Box Connector 5.2.2 以降では、この操作でページネーションが使用されなくなりました。そのため、​[offset (オフセット)]​ および ​[limit (制限)]​ 項目は後方互換性のためだけに存在し、無視されるようになりました。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。Box Connector 5.2.2 以降では、この項目は後方互換性のためだけに存在し、無視されるようになりました。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。Box Connector 5.2.2 以降では、この項目は後方互換性のためだけに存在し、無視されるようになりました。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get shared link for folder

<box:get-folders-get-shared-link-by-folder-id>

フォルダーの共有リンクの情報を取得します。この操作では、/folders/{folder_id}#get_shared_link エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List items in folder

<box:get-folders-items-by-folder-id>

フォルダーの項目のページを取得します。これらの項目は、ファイル、フォルダー、Web リンクになります。フォルダー自体の詳細 (サイズなど) を要求するには、代わりに [Get a folder](#get-folders-id) エンドポイントを使用します。この操作では、/folders/{folder_id}/items エンドポイントに対する HTTP GET 要求を行います。 この操作では、オフセットページネーションを使用して結果を自動的にページ分割します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。さらに、この項目を使用して、​metadata​ 項目および取得するテンプレートのスコープとキーを指定することで、ファイルに適用されるメタデータを照会できます (例: ?field=metadata.enterprise_12345.contractTemplate​)。

使用禁止 - usemarker (マーカーを使用)

Boolean (ブール)

オフセットベースのページネーションの代わりにマーカーベースのページネーションを使用するかどうかを指定します。一度に使用できるのは 1 つのページネーション方法のみです。この値を true に設定すると、応答の次のページを取得するためにこのエンドポイントにパラメーターとして渡すことができる ​marker​ 項目が API から返されます。

false

使用禁止 - marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

sort (並び替え)

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

  • ID

  • NAME

  • DATE

  • SIZE

項目の並び替えの基準となる ​2 番目​の属性を定義します。項目は常にそれらの ​type​ を基準に並び替えられ、フォルダー、ファイル、Web リンクの順にリストされます。このパラメーターは、ルートフォルダー (ID が ​0​ のフォルダー) のマーカーベースのページネーションではサポートされていません。

direction (方向)

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

  • ASC

  • DESC

結果を並び替える方向。 アルファベットの昇順 (​ASC​) または降順 (​DESC​) のいずれかを指定できます。

boxapi

String (文字列)

この項目の共有リンクの URL、および省略可能なパスワード。このヘッダーを使用して、ユーザーと明示的に共有されていない項目にアクセスできます。形式 ​shared_link=[link]​ を使用するか、パスワードが必要な場合は ​shared_link=[link]&shared_link_password=[password]​ を使用します。このヘッダーは、共有されているファイルまたはフォルダー、および項目内にネストされているファイルまたはフォルダーで使用できます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List metadata instances on folder

<box:get-folders-metadata-by-folder-id>

特定のフォルダーのすべてのメタデータを取得します。これは、ID が ​0​ のルートフォルダーでは使用できません。この操作では、/folders/{folder_id}/metadata エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get metadata instance on folder

<box:get-folders-metadata-by-folder-id-scope-template-key>

フォルダーに適用されたメタデータテンプレートのインスタンスを取得します。これは、ID が ​0​ のルートフォルダーでは使用できません。この操作では、/folders/{folder_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get classification on folder

<box:get-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>

フォルダーに適用された分類メタデータインスタンスを取得します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /folders/:id//enterprise_12345/securityClassification-6VMVochwUWo​)。この操作では、/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get trashed folder

<box:get-folders-trash-by-folder-id>

ゴミ箱に移動したフォルダーを取得します。そのフォルダー自体がゴミ箱に移動した場合にのみ、この API コールで取得できます。その親フォルダーのいずれかがゴミ箱に移動した場合は、[​GET /folders/:id/trash​](e://get_folders_id_trash) API を使用しないと、そのフォルダーを調査できません。 ゴミ箱に移動されたすべての項目をリストするには、[​GET /folders/trash/items​](e://get-folders-trash-items/) API を使用します。 この操作では、/folders/{folder_id}/trash エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List trashed items

<box:get-folders-trash-items>

ゴミ箱に移動したファイルとフォルダーを取得します。​fields​ パラメーターを使用して、完全なファイルまたはフォルダーオブジェクトの属性を渡し、デフォルトでは返されない特定の属性を取得できます。このエンドポイントでは、デフォルトでオフセットベースのページネーションが使用されますが、​marker​ パラメーターを使用したマーカーベースのページネーションもサポートされています。この操作では、/folders/trash/items エンドポイントに対する HTTP GET 要求を行います。 この操作では、オフセットページネーションを使用して結果を自動的にページ分割します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

使用禁止 - usemarker (マーカーを使用)

Boolean (ブール)

オフセットベースのページネーションの代わりにマーカーベースのページネーションを使用するかどうかを指定します。一度に使用できるのは 1 つのページネーション方法のみです。この値を true に設定すると、応答の次のページを取得するためにこのエンドポイントにパラメーターとして渡すことができる ​marker​ 項目が API から返されます。

false

使用禁止 - marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

direction (方向)

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

  • ASC

  • DESC

結果を並び替える方向。 アルファベットの昇順 (​ASC​) または降順 (​DESC​) のいずれかを指定できます。

sort (並び替え)

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

  • ID

  • NAME

  • DATE

  • SIZE

項目の並び替えの基準となる ​2 番目​の属性を定義します。項目は常にそれらの ​type​ を基準に並び替えられ、フォルダー、ファイル、Web リンクの順にリストされます。マーカーベースのページネーションを使用している場合、このパラメーターは使用できません。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get watermark for folder

<box:get-folders-watermark-by-folder-id>

フォルダーのウォーターマークを取得します。この操作では、/folders/{folder_id}/watermark エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get group membership

<box:get-group-memberships-by-group-membership-id>

特定のグループメンバーシップを取得します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/group_memberships/{group_membership_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group membership id (グループメンバーシップ ID)

String (文字列)

グループメンバーシップの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List groups for enterprise

<box:get-groups>

特定のエンタープライズのすべてのグループを取得します。エンタープライズのグループを調べるには、ユーザーに管理者権限が必要です。この操作では、/groups エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Filter term (検索語)

String (文字列)

name​ が検索語で始まるグループのみに結果を制限します。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get group

<box:get-groups-by-group-id>

グループに関する情報を取得します。この API を使用できるのは、このグループのメンバーまたは管理者レベルの権限を持つユーザーのみです。この操作では、/groups/{group_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group id (グループ ID)

String (文字列)

グループの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List collaborations for group

<box:get-groups-collaborations-by-group-id>

グループのすべてのコラボレーションを取得します。エンタープライズのグループを調べるには、ユーザーに管理者権限が必要です。各コラボレーションオブジェクトには、グループがどのようなロールでどのファイルまたはフォルダーにアクセスできるのかに関する詳細が含まれます。この操作では、/groups/{group_id}/collaborations エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group id (グループ ID)

String (文字列)

グループの ID。

X

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List members of group

<box:get-groups-memberships-by-group-id>

グループのすべてのメンバーを取得します。この API を使用できるのは、このグループのメンバーまたは管理者レベルの権限を持つユーザーのみです。この操作では、/groups/{group_id}/memberships エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group id (グループ ID)

String (文字列)

グループの ID。

X

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get user invite status

<box:get-invites-by-invite-id>

ユーザーの招待の状況を取得します。この操作では、/invites/{invite_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Invite id (招待 ID)

String (文字列)

招待の ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all legal hold policies

<box:get-legal-hold-policies>

エンタープライズに属するリーガルホールドポリシーのリストを取得します。この操作では、/legal_hold_policies エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

ポリシー名

String (文字列)

名前がこの検索語で始まるポリシーに結果を制限します。これは、大文字と小文字が区別されるプレフィックスです。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get legal hold policy

<box:get-legal-hold-policies-by-legal-hold-policy-id>

リーガルホールドポリシーを取得します。この操作では、/legal_hold_policies/{legal_hold_policy_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List legal hold policy assignments

<box:get-legal-hold-policy-assignments>

リーガルホールドポリシーが割り当てられた項目のリストを取得します。この操作では、/legal_hold_policy_assignments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Policy id (ポリシー ID)

String (文字列)

リーガルホールドポリシーの ID。

X

Assign to type (割り当て先種別)

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

  • FILE

  • FILE_VERSION​

  • FOLDER

  • USER

ポリシーが適用された項目の種別で結果を絞り込みます。

Assign to id (割り当て先 ID)

String (文字列)

ポリシーが適用された項目の ID で結果を絞り込みます。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get legal hold policy assignment

<box:get-legal-hold-policy-assignments-by-legal-hold-policy-assignment-id>

リーガルホールドポリシーの割り当てを取得します。この操作では、/legal_hold_policy_assignments/{legal_hold_policy_assignment_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy assignment 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List previous file versions for legal hold policy assignment

<box:get-legal-hold-policy-assignments-file-versions-on-hold-by-legal-hold-policy-assignment-id>

リーガルホールドの割り当ての以前のファイルバージョンのリストを取得します。最新のファイルバージョンのみが必要な場合は、代わりに、このリーガルホールドポリシーの割り当ての現在 (最新) のファイルバージョンを返す ​GET /legal_hold_policy_assignments/:id/files_on_hold​ API を使用します。再設計に取り組み中のため、この API はこのポリシー ID で保持されているすべてのファイルを返さない場合があります。代わりに、この API は、新しく開発されたアーキテクチャで保持されている過去のファイルバージョンのみを返します。従来のアーキテクチャ内で保持されているファイルの現在および過去のバージョンをフェッチするには、​GET /file_version_legal_holds​ API を使用します。​GET /legal_hold_policy_assignments?policy_id={id}​ API を使用して、特定のポリシー ID のポリシー割り当てのリストを確認できます。この操作では、/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy assignment id (リーガルホールドポリシー割り当て ID)

String (文字列)

リーガルホールドポリシー割り当ての ID。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List current file versions for legal hold policy assignment

<box:get-legal-hold-policy-assignments-files-on-hold-by-legal-hold-policy-assignment-id>

リーガルホールドの割り当ての現在のファイルバージョンのリストを取得します。以前のファイルバージョンが必要な場合は、代わりに、このリーガルホールドポリシーの割り当ての以前のファイルバージョンを返す ​GET /legal_hold_policy_assignments/:id/file_versions_on_hold​ API を使用します。

再設計に取り組み中のため、この API はこのポリシー ID で保持されているすべてのファイルバージョンを返さない場合があります。代わりに、この API は、新しく開発されたアーキテクチャで保持されている最新のファイルバージョンのみを返します。従来のアーキテクチャ内で保持されているファイルの現在および過去のバージョンをフェッチするには、​GET /file_version_legal_holds​ API を使用します。​GET /legal_hold_policy_assignments?policy_id={id}​ API を使用して、特定のポリシー ID のポリシー割り当てのリストを確認できます。

この操作では、/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy assignment id (リーガルホールドポリシー割り当て ID)

String (文字列)

リーガルホールドポリシー割り当ての ID。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List metadata cascade policies

<box:get-metadata-cascade-policies>

特定のフォルダーに適用されているすべてのメタデータカスケードポリシーのリストを取得します。これは、ID が ​0​ のルートフォルダーでは使用できません。この操作では、/metadata_cascade_policies エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

ポリシーを返すフォルダーを指定します。これは、ID が ​0​ のルートフォルダーでは使用できません。

X

Owner enterprise id (オーナーエンタープライズ ID)

String (文字列)

メタデータカスケードポリシーを検索するためのエンタープライズ ID。指定しなかった場合のデフォルトは現在のエンタープライズになります。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get metadata cascade policy

<box:get-metadata-cascade-policies-by-metadata-cascade-policy-id>

フォルダーに割り当てられた特定のメタデータカスケードポリシーのリストを取得します。この操作では、/metadata_cascade_policies/{metadata_cascade_policy_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Metadata cascade policy 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Find metadata template by instance ID

<box:get-metadata-templates>

テンプレートのインスタンスの ID を検索して、メタデータテンプレートを見つけます。この操作では、/metadata_templates エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Metadata instance id (メタデータインスタンス ID)

String (文字列)

検索するメタデータテンプレートのインスタンスの ID。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get metadata template by ID

<box:get-metadata-templates-by-template-id>

その ID を基準にメタデータテンプレートを取得します。この操作では、/metadata_templates/{template_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Template 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all metadata templates for enterprise

<box:get-metadata-templates-enterprise>

ユーザーのエンタープライズ内専用に作成されたすべてのメタデータテンプレートを取得するために使用します。この操作では、/metadata_templates/enterprise エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all classifications

<box:get-metadata-templates-enterprise-security-classification6vmvochw-uwo-schema>

分類メタデータテンプレートを取得し、このエンタープライズで使用できるすべての分類をリストします。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema​)。この操作では、/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all global metadata templates

<box:get-metadata-templates-global>

Box を使用しているすべてのエンタープライズで利用できるすべての汎用グローバルメタデータテンプレートを取得するために使用します。この操作では、/metadata_templates/global エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get metadata template by name

<box:get-metadata-templates-schema-by-scope-template-key>

その ​scope​ および ​templateKey​ 値を基準にメタデータテンプレートを取得します。テンプレートの ​scope​ および ​templateKey​ を検索するには、エンタープライズまたはグローバルのすべてのテンプレートをリストするか、ファイルまたはフォルダーに適用されたすべてのテンプレートをリストします。この操作では、/metadata_templates/{scope}/{template_key}/schema エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get events long poll endpoint

<box:get-options-events>

[event stream](#get-events) へのロングポーリング更新に使用できるリアルタイムサーバーのリストを返します。ロングポーリングでは、サーバーが応答を送信するまで HTTP 要求が開いたままになるため、更新された応答を受信するためにプロセスが何度も繰り返されます。イベントストリームのロングポーリングは、エンタープライズイベントではなくユーザーイベントでのみ使用できます。

ロングポーリングを使用する手順は、次のとおりです。

  1. まず、このエンドポイントを使用して、ロングポーリング URL のリストを取得します。

  2. 次に、指定された URL のいずれかに対してロングポーリング要求を実行します。

    監視対象アカウントでイベントが発生すると、値が ​new_change​ の応答が送信されます。応答は追加アクション (最後の既知の ​stream_position​ を使用して [events endpoint](#get-events) に要求を送信するなど) を実行するように求める要求メッセージとしてのみ機能するため、他の詳細は含まれません。

  3. サーバーはこの応答を送信すると、接続を閉じます。

  4. 次に、イベントを再度リスンするためにロングポーリングプロセスを繰り返す必要があります。

    しばらくの間イベントが発生せずに接続がタイムアウトすると、値が ​reconnect​ の応答を受信します。この応答を受信したら、このエンドポイントに対して別のコールを実行し、プロセスを再開します。​retry_timeout​ 秒以内にイベントを受信しなかった場合、リアルタイムサーバー (このエンドポイントの応答のいずれかの URL) に対して別の要求を実行する必要があります。この作業は、ネットワークエラーなどの場合に必要になります。

  5. 最後に、リアルタイムサーバーに対して要求を実行しているときに ​max_retries​ エラーを受信した場合、まずこのエンドポイントに対するコールを実行してやり直す必要があります。

この操作では、/events エンドポイントに対する HTTP OPTIONS 要求を行います。

パラメーター

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

Configuration (設定)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Preflight check before upload

<box:get-options-files-content>

ファイル全体をアップロードする前に、チェックを実行して、ファイルが Box で受け入れられることを確認します。この操作では、/files/content エンドポイントに対する HTTP OPTIONS 要求を行います。

パラメーター

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

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List recently accessed items

<box:get-recent-items>

ユーザーが最近アクセスした項目 (過去 90 日または最大で直近 1000 個のアクセスされた項目) に関する情報を返します。この操作では、/recent_items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List retention policies

<box:get-retention-policies>

エンタープライズのすべての保持ポリシーを取得します。この操作では、/retention_policies エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

ポリシー名

String (文字列)

保持ポリシーの名前の大文字と小文字が区別されるプレフィックスで結果を絞り込みます。

Policy type (ポリシーの種類)

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

  • FINITE

  • INDEFINITE

保持ポリシーの種類で結果を絞り込みます。

Created by user id (作成ユーザー ID)

String (文字列)

ポリシーを作成したユーザーの ID で結果を絞り込みます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List retention policy assignments

<box:get-retention-policies-assignments-by-retention-policy-id>

指定された保持ポリシーに関連付けられているすべての保持ポリシーの割り当てのリストを返します。この操作では、/retention_policies/{retention_policy_id}/assignments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Retention policy id (保持ポリシー ID)

String (文字列)

保持ポリシーの ID。

X

type (型)

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

  • FOLDER

  • ENTERPRISE

取得する保持ポリシーの割り当ての種別。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get retention policy

<box:get-retention-policies-by-retention-policy-id>

保持ポリシーを取得します。この操作では、/retention_policies/{retention_policy_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Retention policy 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get retention policy assignment

<box:get-retention-policy-assignments-by-retention-policy-assignment-id>

保持ポリシーの割り当てを取得します。この操作では、/retention_policy_assignments/{retention_policy_assignment_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Retention policy assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Search for content

<box:get-search>

ユーザーのデータやエンタープライズ全体でファイル、フォルダー、Web リンク、共有ファイルを検索します。この操作では、/search エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

query (クエリ)

String (文字列)

検索対象の文字列。このクエリは、項目名、説明、ファイルのテキストコンテンツ、およびさまざまな項目種別の他の項目と照合されます。

このパラメーターでは、返される結果をさらに絞り込むためにさまざまな演算子がサポートされています。

  • ""​ クエリを二重引用符で囲むと、完全一致のみが API で返されます。完全な検索では、検索の一致が特定の文字シーケンスではなく、フレーズ (単語シーケンス) に基づいて返されます。たとえば、​"Blue-Box"​ を検索すると、​"blue.box"​、​"Blue Box"​、​"Blue-Box"​ のシーケンスが含まれる検索結果 (​Blue​ と ​Box​ の単語が指定の順序で連続して含まれる項目) が返されます。

  • AND​ では、両方の検索語が含まれている項目が返されます。たとえば、​marketing AND BoxWorks​ を検索すると、​marketing​ と ​BoxWorks​ の両方が任意の順序でそのテキストに含まれている項目が返されます。​BoxWorks​ のみがそのテキストに含まれている結果は返されません。

  • OR​ では、いずれかの検索語が含まれている項目が返されます。たとえば、​marketing OR BoxWorks​ を検索すると、​marketing​ または ​BoxWorks​ のいずれかがそのテキストに含まれている結果が返されます。複数の単語が含まれているクエリは暗黙的に ​OR​ として解釈されるため、サポートされている別のブール用語を使用しなければ、この演算子を使用する必要はありません。

  • NOT​ では、指定された検索語が含まれていない項目が返されます。たとえば、​marketing AND NOT BoxWorks​ を検索すると、​marketing​ のみがそのテキストに含まれている結果が返されます。​BoxWorks​ が含まれている結果は省略されます。

小文字の演算子 (​and​、​or​、​not​) または大文字と小文字が混在している演算子 (​And​、​Or​、​Not​) はサポートされていません。 
​`mdfilters`​ パラメーターが定義されていなければ、この項目は必須です。

scope (スコープ)

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

  • USER_CONTENT​

  • ENTERPRISE_CONTENT

ユーザーがアクセスできるファイルか、エンタープライズ全体で使用可能なファイルに検索結果を制限します。スコープのデフォルトは ​user_content​ で、検索結果を現在認証されているユーザーが使用できるコンテンツに制限します。システム管理者は、サポートチャネルを介して ​enterprise_content​ を要求できます。ユーザーに対してこのスコープが有効になると、アクセス権のあるコンテンツだけでなくエンタープライズ全体のコンテンツを照会できるようになります。

USER_CONTENT

File extensions (ファイル拡張子)

Array of String (文字列の配列)

指定されたファイル拡張子のいずれかに一致するファイルに検索結果を制限します。このリストは、ドットなしのファイル拡張子のカンマ区切りリストです。

Created at range (作成日の範囲)

Array of String (文字列の配列)

特定の日付範囲内で作成された項目に検索結果を制限します。日付範囲は、カンマ区切りの RFC3339 タイムスタンプとして定義されます。開始日を省略すると (​,2014-05-17T13:35:01-07:00​)、終了日前に作成されたすべての項目が返されます。終了日を省略すると (​2014-05-15T13:35:01-07:00,​)、代わりに終了日として現在の日付が使用されます。

Updated at range (更新日の範囲)

Array of String (文字列の配列)

特定の日付範囲内で更新された項目に検索結果を制限します。日付範囲は、カンマ区切りの RFC3339 タイムスタンプとして定義されます。開始日を省略すると (​,2014-05-17T13:35:01-07:00​)、終了日前に更新されたすべての項目が返されます。終了日を省略すると (​2014-05-15T13:35:01-07:00,​)、代わりに終了日として現在の日付が使用されます。

Size range (サイズの範囲)

Array of Number (数値の配列)

特定のファイルサイズ範囲内の項目に検索結果を制限します。これは、ファイルとフォルダーに適用されます。サイズ範囲は、バイトサイズの下限と上限 (上限と下限を含む) のカンマ区切りリストとして定義されます。範囲を制限しない場合は、上限と下限を省略します。

Owner user ids (オーナーユーザー ID)

Array of String (文字列の配列)

特定の一連のオーナー (カンマ区切りのユーザー ID のリストとして定義される) が所有する項目に検索結果を制限します。項目が検索結果に表示されるには、現在認証されているユーザーによって所有または共有されている必要があります。ユーザーがいずれかのユーザーが所有するファイルにアクセスできない場合、空の結果セットが返されます。エンタープライズ全体を検索するには、​enterprise_content​ スコープパラメーターを使用します。このパラメーターは、Box サポートチームから要求できます。

Ancestor folder ids (上位フォルダー ID)

Array of String (文字列の配列)

フォルダーの特定のリスト (フォルダー ID のカンマ区切りリストとして定義される) 内の項目に検索結果を制限します。検索結果には、これらの上位フォルダーのサブフォルダー内の項目も含まれます。フォルダーは、現在認証されているユーザーによって所有または共有されている必要があります。このユーザーがフォルダーにアクセスできない場合や、フォルダーが存在しない場合、代わりに ​HTTP 404​ エラーコードが返されます。エンタープライズ全体を検索するには、​enterprise_content​ スコープパラメーターを使用します。このパラメーターは、Box サポートチームから要求できます。

Content types (コンテンツタイプ)

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

  • NAME

  • DESCRIPTION

  • FILE_CONTENT​

  • COMMENTS

  • TAG

ファイルの特定の部分 (ファイル拡張子など) の検索クエリに一致する項目に検索結果を制限します。コンテンツタイプは、Box で認識されるコンテンツタイプのカンマ区切りリストとして定義されます。許可されるコンテンツタイプを以下に示します。

  • name​ - その ​name​ 項目で定義される、項目の名前。

  • description​ - その ​description​ 項目で定義される、項目の説明。

  • file_content​ - ファイルの実際のコンテンツ。

  • comments​ - ファイルまたはフォルダーのコメントのコンテンツ。

  • tag​ - その ​tag​ 項目で定義される、項目に適用されるタグ。

type (型)

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

  • FILE

  • FOLDER

  • WEB_LINK

この種別の項目に検索結果を制限します。このパラメーターは、1 つの値のみを受け入れます。デフォルトでは、API は次のいずれかの種別に一致する項目を返します。

  • file​ - ファイルに検索結果を制限します。

  • folder​ - フォルダーに検索結果を制限します。

  • web_link​ - Web リンク (ブックマークとも呼ばれる) に検索結果を制限します。

Trash content (ゴミ箱のコンテンツ)

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

  • NON_TRASHED_ONLY​

  • TRASHED_ONLY

検索でゴミ箱の項目を検索するかどうかを決定します。デフォルトでは、この API は現在ゴミ箱にない項目検索結果のみを返します (​non_trashed_only​)。

  • trashed_only​ - 現在ゴミ箱にある項目のみを検索します。

  • non_trashed_only​ - 現在ゴミ箱にない項目のみを検索します。

NON_TRASHED_ONLY

mdfilters (メタデータ検索条件)

Array of String (文字列の配列)

メタデータが指定された検索条件に一致する項目に検索結果を制限します。このパラメーターには、検索結果を絞り込む基準となる 1 つのメタデータテンプレートのリストが含まれます。現在、このリストには 1 つのエントリのみを含めることができます。​query​ パラメーターが指定されていなければ、このパラメーターは必須です。

sort (並び替え)

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

  • MODIFIED_AT​

  • RELEVANCE

検索結果を返す順序を定義します。このパラメーターが明示的に指定されていなければ、この API はデフォルトで関連性を基準に項目を返します。

  • relevance​ (デフォルト) では、クエリ検索語の関連性で並び替えられた結果が返されます。関連性は、項目の名前、説明、コンテンツ、追加プロパティでの検索語の出現に基づいています。

  • modified_at​ では、項目の最終更新日の降順で結果が返されます。

RELEVANCE

direction (方向)

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

  • DESC

  • ASC

検索結果を並び替える方向を定義します。このパラメーターが明示的に指定されていなければ、この API はデフォルトで降順 (​DESC​) で項目を返します。結果が ​relevance​ で並び替えられる場合、項目が返される順序は関連性の降順に固定されるため、このパラメーターは無視されます。

DESC

limit (制限)

Number (数値)

結果のページの一部として返される項目の最大数最大数を定義します。

30

Include recent shared links (最近の共有リンクを含める)

Boolean (ブール)

ユーザーが共有リンクで最近アクセスした項目を検索結果に含める必要があるかどうかを定義します。このパラメーターが true に設定されている場合、この API の応答は、[Search Results with Shared Links](r://search_results_with_shared_links) のリストを返す形式に変更されます。

false

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列 * Any (任意) * Any (任意)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Find file for shared link

<box:get-shared-items>

共有リンクで表されるファイルを返します。共有ファイルは、現在のエンタープライズまたは別のエンタープライズ内から取得される共有リンクで表すことができます。共有リンクが指定されている場合にのみ、アプリケーションはこのエンドポイントを使用して共有ファイルに関する情報を取得できます。この操作では、/shared_items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

If none match (一致しない合)

String (文字列)

項目が変更された場合にのみ項目が返されるようにします。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されていない場合、エンドポイントは ​304 Not Modified​ で失敗します。

boxapi

String (文字列)

共有リンクと共有リンクの省略可能なパスワードが含まれるヘッダー。このヘッダーの形式は次のようになります。 shared_link=[link]&shared_link_password=[password]

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Find folder for shared link

<box:get-shared-itemsfolders>

共有リンクで表されるフォルダーを返します。共有フォルダーは、現在のエンタープライズまたは別のエンタープライズ内から取得される共有リンクで表すことができます。共有リンクが指定されている場合にのみ、アプリケーションはこのエンドポイントを使用して共有フォルダーに関する情報を取得できます。この操作では、/shared_items#folders エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

If none match (一致しない合)

String (文字列)

項目が変更された場合にのみ項目が返されるようにします。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されていない場合、エンドポイントは ​304 Not Modified​ で失敗します。

boxapi

String (文字列)

共有リンクと共有リンクの省略可能なパスワードが含まれるヘッダー。このヘッダーの形式は次のようになります。 shared_link=[link]&shared_link_password=[password]

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List storage policies

<box:get-storage-policies>

エンタープライズのすべてのストレージポリシーをフェッチします。この操作では、/storage_policies エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get storage policy

<box:get-storage-policies-by-storage-policy-id>

特定のストレージポリシーをフェッチします。この操作では、/storage_policies/{storage_policy_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Storage policy 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List storage policy assignments

<box:get-storage-policy-assignments>

エンタープライズまたはユーザーのすべてのストレージポリシーの割り当てをフェッチします。この操作では、/storage_policy_assignments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Resolved for type (解決対象種別)

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

  • USER

  • ENTERPRISE

割り当てを返す対象種別

X

Resolved for id (解決対象 ID)

String (文字列)

割り当てを返すユーザーまたはエンタープライズの ID

X

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get storage policy assignment

<box:get-storage-policy-assignments-by-storage-policy-assignment-id>

特定のストレージポリシーの割り当てをフェッチします。この操作では、/storage_policy_assignments/{storage_policy_assignment_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Storage policy assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get task assignment

<box:get-task-assignments-by-task-assignment-id>

タスクの割り当てに関する情報を取得します。この操作では、/task_assignments/{task_assignment_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List task assignments

<box:get-tasks-assignments-by-task-id>

特定のタスクのすべての割り当てをリストします。この操作では、/tasks/{task_id}/assignments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get task

<box:get-tasks-by-task-id>

特定のタスクに関する情報を取得します。この操作では、/tasks/{task_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List terms of service user statuses

<box:get-terms-of-service-user-statuses>

ユーザーや利用規約の状況の概要 (ユーザーが規約に同意したかどうかや、いつ同意したのかなど) を取得します。この操作では、/terms_of_service_user_statuses エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Tos id (TOS ID)

String (文字列)

利用規約の ID。

X

User id (ユーザー ID)

String (文字列)

特定のユーザー ID に結果を制限します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List terms of services

<box:get-terms-of-services>

エンタープライズの現在の利用規約テキストおよび設定を返します。この操作では、/terms_of_services エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Tos type (TOS 種別)

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

  • EXTERNAL (外部)

  • MANAGED

特定の種別の利用規約に結果を制限します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get terms of service

<box:get-terms-of-services-by-terms-of-service-id>

特定の利用規約をフェッチします。この操作では、/terms_of_services/{terms_of_service_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Terms of service 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List enterprise users

<box:get-users>

user_id​、​public_name​、​login​ と共にエンタープライズのすべてのユーザーのリストを返します。アプリケーションユーザーと認証済みユーザーには、エンタープライズ全体のユーザーをルックアップする権限が必要です。この操作では、/users エンドポイントに対する HTTP GET 要求を行います。 この操作では、オフセットページネーションを使用して結果を自動的にページ分割します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Filter term (検索語)

String (文字列)

name​ または ​login​ が検索語で始まるユーザーのみに結果を制限します。外部管理対象ユーザーを見つけるには、検索語の順序が完全に一致している必要があります。また、一度の 1 人のユーザーのみが返されます。

User type (ユーザー種別)

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

  • ALL (すべて)

  • MANAGED

  • EXTERNAL (外部)

指定された種類のユーザーに結果を制限します。

  • all​ では、​login​ または ​name​ が ​filter_term​ と部分的に一致するすべての種類のユーザーが返されます。login が ​filter_term​ と完全に一致する外部ユーザーのみ (そのユーザーのみ) が返されます。

  • managed​ では、​login​ または ​name​ が ​filter_term​ と部分的に一致するすべての管理対象ユーザーとアプリケーションユーザーが返されます。

  • external​ では、​login​ が ​filter_term​ と完全に一致するすべての外部ユーザーが返されます。

External app user id (外部アプリケーションユーザー ID)

String (文字列)

特定の ​external_app_user_id​ 値を持つアプリケーションユーザーに結果を制限します。アプリケーションユーザーを作成するときに ​external_app_user_id​ 値を設定できます。その後、この値をこのエンドポイントで使用して、その ​external_app_user_id​ 値と一致するユーザーを検索できます。

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

使用禁止 - usemarker (マーカーを使用)

Boolean (ブール)

オフセットベースのページネーションの代わりにマーカーベースのページネーションを使用するかどうかを指定します。一度に使用できるのは 1 つのページネーション方法のみです。この値を true に設定すると、応答の次のページを取得するためにこのエンドポイントにパラメーターとして渡すことができる ​marker​ 項目が API から返されます。

false

使用禁止 - marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get user avatar

<box:get-users-avatar-by-user-id>

ユーザーのアバターの画像を取得します。この操作では、/users/{user_id}/avatar エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get user

<box:get-users-by-user-id>

エンタープライズのユーザーに関する情報を取得します。アプリケーションユーザーと認証済みユーザーには、エンタープライズ全体のユーザーをルックアップする権限が必要です。このエンドポイントでは、適切なスコープの認証済みユーザーのエンタープライズで所有されるコンテンツでコラボレーションしている外部ユーザーの限定的な情報セットも返されます。この場合、許可されていない項目では代わりに null が返されます。この操作では、/users/{user_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List user’s email aliases

<box:get-users-email-aliases-by-user-id>

ユーザーのすべてのメール別名を取得します。コレクションには、ユーザーのプライマリログインは含まれません。この操作では、/users/{user_id}/email_aliases エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get current user

<box:get-users-me>

現在認証されているユーザーに関する情報を取得します。クライアント側の認証済み OAuth 2.0 アプリケーションの場合、これはアプリケーションを認証したユーザーになります。JWT (サーバー側の認証済みアプリケーション) の場合、これはデフォルトでアプリケーションに属するサービスアカウントになります。​As-User​ ヘッダーを使用して、この API コールを実行するときの代理元ユーザーを変更します。この操作では、/users/me エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List user’s groups

<box:get-users-memberships-by-user-id>

ユーザーのすべてのグループを取得します。この API を使用できるのは、このグループのメンバーまたは管理者レベルの権限を持つユーザーのみです。この操作では、/users/{user_id}/memberships エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

offset (オフセット)

Number (数値)

応答の開始位置の項目のオフセット。

0

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get web link

<box:get-web-links-by-web-link-id>

Web リンクに関する情報を取得します。この操作では、/web_links/{web_link_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの ID。

X

boxapi

String (文字列)

この項目の共有リンクの URL、および省略可能なパスワード。このヘッダーを使用して、ユーザーと明示的に共有されていない項目にアクセスできます。形式 ​shared_link=[link]​ を使用するか、パスワードが必要な場合は ​shared_link=[link]&shared_link_password=[password]​ を使用します。このヘッダーは、共有されているファイルまたはフォルダー、および項目内にネストされているファイルまたはフォルダーで使用できます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get trashed web link

<box:get-web-links-trash-by-web-link-id>

ゴミ箱に移動した Web リンクを取得します。この操作では、/web_links/{web_link_id}/trash エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

List all webhooks

<box:get-webhooks>

要求元アプリケーションのすべての定義済み Web フックを取得します。この API は、認証済みユーザーが所有するファイルまたはフォルダーに適用された Web フックのみを返します。つまり、システム管理者は、それらのフォルダーへのアクセス権がない限り、サービスアカウントによって作成された Web フックを参照できません (逆の場合も同様)。この操作では、/webhooks エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

marker (マーカー)

String (文字列)

結果を返し始める位置マーカーを定義します。これは、マーカーベースのページネーションを使用してページ分割するときに使用されます。これには、​usemarker​ が ​true​ に設定されている必要があります。

limit (制限)

Number (数値)

ページごとに返される項目の最大数。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

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 (再接続戦略)

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

出力

Type (型)

* Any の配列

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get webhook

<box:get-webhooks-by-webhook-id>

特定の Web フックを取得します。この操作では、/webhooks/{webhook_id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Webhook id (Web フック ID)

String (文字列)

Web フックの 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Download zip archive

<box:get-zip-downloads-content-by-zip-download-id>

バイナリ形式で ZIP アーカイブのコンテンツを返します。この URL では、どの認証の形式も必要なく、ユーザーのブラウザーで使用してアーカイブをユーザーのデバイスにダウンロードできます。デフォルトでは、この URL はこのアーカイブの要求が作成されてから数秒間のみ有効です。

ダウンロードが開始されると、停止や再開を行うことはできないため、代わりに ZIP アーカイブの新しい要求を作成する必要があります。このエンドポイントの URL は固定されません。代わりに、[Create zip download](e://post_zip_downloads) API を使用して、ZIP アーカイブの作成を要求し、このエンドポイントへの応答の ​download_url​ 項目に従います。

この操作では、/zip_downloads/{zip_download_id}/content エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

(非推奨) Zip download id (Zip ダウンロード ID)

String (文字列)

この ​zip​ アーカイブを表す一意の識別子。

X

Zip download URL generated by 'Create zip download' operation (「Create zip download」操作によって生成された zip ダウンロード URL)

String (文字列)

zip​ アーカイブをダウンロードするための一時 URL。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Get zip download status

<box:get-zip-downloads-status-by-zip-download-id>

ZIP アーカイブのダウンロードの状況を返します。これにより、アプリケーションはダウンロードの進行状況とスキップされた可能性のある項目の数を調べることができます。このエンドポイントは、ダウンロードが開始された後にのみアクセスできます。このエンドポイントは、ダウンロードの開始から 12 時間有効です。このエンドポイントの URL は固定されません。代わりに、[Create zip download](e://post_zip_downloads) API を使用して、ZIP アーカイブの作成を要求し、このエンドポイントへの応答の ​status_url​ 項目に従います。

この操作では、/zip_downloads/{zip_download_id}/status エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Zip download id (Zip ダウンロード ID)

String (文字列)

この ​zip​ アーカイブを表す一意の識別子。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<box:unauthorize>

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

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

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

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

X

次の設定の場合

PUpdate collaboration

<box:update-collaborations-by-collaboration-id>

コラボレーションを更新します。項目のオーナーを変更したり、コラボレーションの招待を受け入れたりするために使用できます。この操作では、/collaborations/{collaboration_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Collaboration 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update comment

<box:update-comments-by-comment-id>

コメントのメッセージを更新します。この操作では、/comments/{comment_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Comment id (コメント ID)

String (文字列)

コメントの ID。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update file request

<box:update-file-requests-by-file-request-id>

ファイル要求を更新します。これを使用して、ファイル要求をアクティブ化または非アクティブ化できます。この操作では、/file_requests/{file_request_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File request id (ファイル要求 ID)

String (文字列)

ファイル要求を表す一意の識別子。ファイル要求の ID は、Web アプリケーションのファイル要求ビルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/filerequest/123​ の場合、​file_request_id​ は ​123​ です。

X

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add shared link to file

<box:update-files-add-shared-link-by-file-id>

共有リンクをファイルに追加します。この操作では、/files/{file_id}#add_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update file

<box:update-files-by-file-id>

ファイルを更新します。これを使用して、ファイルの名前を変更したり、ファイルを移動したり、共有リンクを作成したり、ファイルをロックしたりできます。この操作では、/files/{file_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update metadata instance on file

<box:update-files-metadata-by-file-id-scope-template-key>

ファイルのメタデータを更新します。メタデータインスタンスは、テンプレートがすでにファイルに適用されている場合にのみ更新できます。メタデータを編集する場合、メタデータテンプレートスキーマと一致する値のみが受け入れられます。更新は自動的に適用されます。操作の適用時にエラーが発生した場合、メタデータインスタンスは変更されません。この操作では、/files/{file_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update classification on file

<box:update-files-metadata-enterprise-security-classification6vmvochw-uwo-by-file-id>

ファイルの分類を更新します。分類は、分類がすでにファイルに適用されている場合にのみ更新できます。分類を編集する場合、エンタープライズで定義された値のみが受け入れられます。この操作では、/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update Box Skill cards on file

<box:update-files-metadata-global-box-skills-cards-by-file-id>

1 つ以上の Box Skills メタデータカードをファイルに更新します。この操作では、/files/{file_id}/metadata/global/boxSkillsCards エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove shared link from file

<box:update-files-remove-shared-link-by-file-id>

ファイルから共有リンクを削除します。この操作では、/files/{file_id}#remove_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update shared link on file

<box:update-files-update-shared-link-by-file-id>

ファイルの共有リンクを更新します。この操作では、/files/{file_id}#update_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Upload part of file

<box:update-files-upload-sessions-by-upload-session-id>

ファイルのアップロードセッションのチャンクを更新します。この操作では、/files/upload_sessions/{upload_session_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Upload session id (アップロードセッション ID)

String (文字列)

アップロードセッションの ID。

X

ダイジェスト

String (文字列)

アップロードされたチャンクの [RFC3230][1] メッセージダイジェスト。SHA1 のみがサポートされています。SHA1 ダイジェストは Base64 でエンコードされている必要があります。このヘッダーの形式は ​sha=BASE64_ENCODED_DIGEST​ です。[1]: https://tools.ietf.org/html/rfc3230

X

Content range (コンテンツの範囲)

String (文字列)

チャンクのバイト範囲。このセッションですでにアップロードされた部分の範囲と重複しないようにしてください。

X

Body (本文)

String (文字列)

使用するコンテンツ

#[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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Apply watermark to file

<box:update-files-watermark-by-file-id>

ファイルのウォーターマークを適用または更新します。この操作では、/files/{file_id}/watermark エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

File id (ファイル ID)

String (文字列)

ファイルを表す一意の識別子。ファイルの ID は、Web アプリケーションでファイルにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/files/123​ の場合、​file_id​ は ​123​ です。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add shared link to folder

<box:update-folders-add-shared-link-by-folder-id>

共有リンクをフォルダーに追加します。この操作では、/folders/{folder_id}#add_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update folder

<box:update-folders-by-folder-id>

フォルダーを更新します。これを使用して、フォルダーを移動したり、共有リンクを作成したり、コラボレーションを更新したりすることもできます。この操作では、/folders/{folder_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

If match (一致する場合)

String (文字列)

変更を加える前に、この項目が最近変更されていないことを確認します。最後に確認された項目の ​etag​ 値をこのヘッダーに渡し、その項目がその後変更されている場合、エンドポイントは ​412 Precondition Failed​ で失敗します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update metadata instance on folder

<box:update-folders-metadata-by-folder-id-scope-template-key>

フォルダーのメタデータを更新します。メタデータインスタンスは、テンプレートがすでにフォルダーに適用されている場合にのみ更新できます。メタデータを編集する場合、メタデータテンプレートスキーマと一致する値のみが受け入れられます。更新は自動的に適用されます。操作の適用時にエラーが発生した場合、メタデータインスタンスは変更されません。この操作では、/folders/{folder_id}/metadata/{scope}/{template_key} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update classification on folder

<box:update-folders-metadata-enterprise-security-classification6vmvochw-uwo-by-folder-id>

フォルダーの分類を更新します。分類は、分類がすでにフォルダーに適用されている場合にのみ更新できます。分類を編集する場合、エンタープライズで定義された値のみが受け入れられます。この操作では、/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Remove shared link from folder

<box:update-folders-remove-shared-link-by-folder-id>

フォルダーから共有リンクを削除します。この操作では、/folders/{folder_id}#remove_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update shared link on folder

<box:update-folders-update-shared-link-by-folder-id>

フォルダーの共有リンクを更新します。この操作では、/folders/{folder_id}#update_shared_link エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

X

fields (項目)

String (文字列)

この項目に対して返される ​shared_link​ 項目を明示的に要求します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Apply watermark to folder

<box:update-folders-watermark-by-folder-id>

フォルダーのウォーターマークを適用または更新します。この操作では、/folders/{folder_id}/watermark エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Folder id (フォルダー ID)

String (文字列)

フォルダーを表す一意の識別子。フォルダーの ID は、Web アプリケーションでこのフォルダーにアクセスし、URL から ID をコピーすることで確認できます。たとえば、URL が ​https://*.app.box.com/folder/123​ の場合、​folder_id​ は ​123​ です。Box アカウントのルートフォルダーは、常に ID ​0​ で表されます。

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update group membership

<box:update-group-memberships-by-group-membership-id>

ユーザーのグループメンバーシップを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/group_memberships/{group_membership_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group membership id (グループメンバーシップ ID)

String (文字列)

グループメンバーシップの ID。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update group

<box:update-groups-by-group-id>

特定のグループを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこの API を使用できます。この操作では、/groups/{group_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Group id (グループ ID)

String (文字列)

グループの ID。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update legal hold policy

<box:update-legal-hold-policies-by-legal-hold-policy-id>

リーガルホールドポリシーを更新します。この操作では、/legal_hold_policies/{legal_hold_policy_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Legal hold policy 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Add classification

<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemaadd>

エンタープライズで使用できる分類のリストに 1 つ以上の新しい分類を追加します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema​)。この操作では、/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Delete classification

<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemadelete>

エンタープライズで使用できる分類のリストから分類を削除します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema​)。この操作では、/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update classification

<box:update-metadata-templates-enterprise-security-classification6vmvochw-uwo-schemaupdate>

エンタープライズで使用できる 1 つ以上の分類の表示ラベルと説明を更新します。この API は、URL にエンタープライズ ID を明示的に含めることでコールすることもできます (例: /metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema​)。この操作では、/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update metadata template

<box:update-metadata-templates-schema-by-scope-template-key>

メタデータテンプレートを更新します。メタデータテンプレートは、テンプレートがすでに存在する場合にのみ更新できます。更新は自動的に適用されます。操作の適用時にエラーが発生した場合、メタデータテンプレートは変更されません。この操作では、/metadata_templates/{scope}/{template_key}/schema エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

scope (スコープ)

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

  • GLOBAL

  • ENTERPRISE

メタデータテンプレートのスコープ

X

Template key (テンプレートキー)

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update retention policy

<box:update-retention-policies-by-retention-policy-id>

保持ポリシーを更新します。この操作では、/retention_policies/{retention_policy_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Retention policy 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update all Box Skill cards on file

<box:update-skill-invocations-by-skill-id>

ファイルのすべての Box Skills メタデータカードを上書きおよび更新するために使用できる代替方法。この操作では、/skill_invocations/{skill_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Skill 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update storage policy assignment

<box:update-storage-policy-assignments-by-storage-policy-assignment-id>

特定のストレージポリシーの割り当てを更新します。この操作では、/storage_policy_assignments/{storage_policy_assignment_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Storage policy assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update task assignment

<box:update-task-assignments-by-task-assignment-id>

タスクの割り当てを更新します。このエンドポイントを使用して、ユーザーに割り当てられたタスクの状態を更新できます。この操作では、/task_assignments/{task_assignment_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task assignment 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update task

<box:update-tasks-by-task-id>

タスクを更新します。これを使用して、タスクの設定やその完了状態を更新できます。この操作では、/tasks/{task_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Task 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update terms of service status for existing user

<box:update-terms-of-service-user-statuses-by-terms-of-service-user-status-id>

ユーザーの利用規約の状況を更新します。この操作では、/terms_of_service_user_statuses/{terms_of_service_user_status_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Terms of service user status 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update terms of service

<box:update-terms-of-services-by-terms-of-service-id>

特定の利用規約を更新します。この操作では、/terms_of_services/{terms_of_service_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Terms of service 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update user

<box:update-users-by-user-id>

エンタープライズの管理対象ユーザーを更新します。このエンドポイントは、適切な管理者権限を持つユーザーとアプリケーションのみが使用できます。この操作では、/users/{user_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

fields (項目)

Array of 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Transfer owned folders

<box:update-users-folders0-by-user-id>

ユーザーが所有するすべての項目 (ファイル、フォルダー、ワークフロー) を別のユーザーのアカウントに移動します。転送できるのは、ルートフォルダー (​0​) のみです。フォルダーは、管理者権限を持つユーザー間でのみ移動できます。

このコールは非同期で実行されるため、ソースユーザーのすべてのフォルダーの項目数が多いと応答が遅くなる可能性があります。宛先パスのメタデータカスケードポリシーがいずれかの親フォルダーに関連付けられている場合、メタデータカスケード操作が非同期で実行されます。現在、この操作が完了しているかどうかを確認する方法はありません。

この宛先フォルダーの名前は、​{User}'s Files and Folders​ の形式になります。​{User}​ はユーザーの表示名です。

この API コールを実行するには、アプリケーションで ​Read and write all files and folders stored in Box​ スコープが有効になっている必要があります。宛先ユーザーが ​Relay​ または ​Relay Lite​ にアクセスできて、ワークフローに含まれる転送対象のファイルおよびフォルダーにアクセスできることを確認してください。操作が完了すると、システム管理者にメールが送信されます。

この操作では、/users/{user_id}/folders/0 エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

User id (ユーザー ID)

String (文字列)

ユーザーの ID。

X

fields (項目)

Array of String (文字列の配列)

応答に含める属性のカンマ区切りのリスト。標準の応答では通常返されない項目を要求するために使用できます。このパラメーターを指定すると、明示的に指定しない限り標準項目は応答で返されなくなります。代わりに、要求された項目に加えて、最小表現の項目のみが返されます。

notify (通知)

Boolean (ブール)

実行されたアクションのメール通知をユーザーが受信するかどうかを決定します。

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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update web link

<box:update-web-links-by-web-link-id>

Web リンクオブジェクトを更新します。この操作では、/web_links/{web_link_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Web リンク ID

String (文字列)

Web リンクの 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 (再接続戦略)

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

出力

Type (型)

String (文字列)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

Update webhook

<box:update-webhooks-by-webhook-id>

Web フックを更新します。この操作では、/webhooks/{webhook_id} エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

X

Webhook id (Web フック ID)

String (文字列)

Web フックの 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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

Http Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • BOX:BAD_REQUEST

  • BOX:CLIENT_ERROR

  • BOX:CONNECTIVITY

  • BOX:INTERNAL_SERVER_ERROR

  • BOX:NOT_ACCEPTABLE

  • BOX:NOT_FOUND

  • BOX:RETRY_EXHAUSTED

  • BOX:SERVER_ERROR

  • BOX:SERVICE_UNAVAILABLE

  • BOX:TIMEOUT

  • BOX:TOO_MANY_REQUESTS

  • BOX:UNAUTHORIZED

  • BOX:UNSUPPORTED_MEDIA_TYPE

ソース

On Download File Trigger

<box:on-download-file-listener>

ファイルのダウンロードイベントが発生したときにフローを開始します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Folder ID (フォルダー ID)

String (文字列)

フォルダーの ID。

x

Include sub-folders (サブフォルダーを含める)

Boolean (ブール)

サブフォルダーを含めるかどうかを決定します。

false

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

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

scheduling-strategy

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

x

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

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

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Type (型)

Any (任意)

次の設定の場合

On New File in Folder

<box:on-new-file-in-folder-listener>

フォルダーにファイルが作成されたときにフローを開始します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Folder ID (フォルダー ID)

String (文字列)

フォルダーの ID。

x

Include sub-folders (サブフォルダーを含める)

Boolean (ブール)

サブフォルダーを含めるかどうかを決定します。

false

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

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

scheduling-strategy

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

x

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

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

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Type (型)

Any (任意)

次の設定の場合

On New Folder

<box:on-new-folder-listener>

フォルダーにフォルダーが作成されたときにフローを開始します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Folder ID (フォルダー ID)

String (文字列)

フォルダーの ID。

x

Include sub-folders (サブフォルダーを含める)

Boolean (ブール)

サブフォルダーを含めるかどうかを決定します。

false

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

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

scheduling-strategy

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

x

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

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

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Type (型)

Any (任意)

次の設定の場合

On New Task Created

<box:on-new-task-created-listener>

タスク割り当てが作成されたときにフローを開始します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Assigned To (割り当て先)

String (文字列)

タスクの割り当て先のユーザー。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

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

scheduling-strategy

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

x

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

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

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Type (型)

Any (任意)

次の設定の場合

型

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 (文字列)

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Blocking (ブロック)

Boolean

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続を試みる回数

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

Blocking (ブロック)

Boolean

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

TLS

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (トラストストア)

​Trust Store (トラストストア)​

Key Store (キーストア)

​Key Store (キーストア)​

Revocation Check (取り消し確認)

Trust Store (トラストストア)

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

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 ファイルへのパス。

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 (数値)

​REDELIVERY_EXHAUSTED​ エラーが返されるまでに、配信された要求が処理に失敗できる最大回数。

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

String (文字列)

​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​true​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​hashCode()​ が返した値が返されます。

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

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

Mule での反復可能ストリームの無効化の基準となる反復不可能ストリーミング戦略を設定します。ユースケースでコンテンツの読み取りが 1 回のみ必要な場合に、この戦略を使用します。

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

ObjectStore

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

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

再配信されたメッセージを識別する方法と、メッセージがいつ再配信されたのかを見つける方法を設定します。

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

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

Boolean

​true​ の場合、Mule では再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用します。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が false の場合にのみ設定できます。

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

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

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

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供することを目的としてメモリに保持することを許可された初期インスタンス数です。このバッファに収めることができる量よりも多くのデータがストリームに含まれる場合、バッファは、bufferSizeIncrement 属性に従って maxInMemorySize の上限まで拡張されます。デフォルト値は 100 インスタンスです。

100

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

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれくらい拡張されるか。0 以下の値を設定すると、バッファは拡張されず、バッファがフルになると ​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

100

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

Number (数値)

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

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

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

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

関連情報

MuleSoft ヘルプセンター