Box コネクタモジュールドキュメントリファレンス

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

デフォルト設定

パラメータ

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

Name (名前)

String (文字列)

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

x

Connection (接続)

config_connection、Connection (接続)

この設定に指定できる接続型。

x

host

String (文字列)

API をコンシュームするためのホスト。

api.box.com

port

String (文字列)

API をコンシュームするためのポート。

443

basePath

String (文字列)

API をコンシュームするためのベースパス。

/2.0

protocol

String (文字列)

API をコンシュームするためのプロトコル。

HTTPS

clientId

String (文字列)

OAuth2 クライアント ID。

x

clientSecret

String (文字列)

OAuth2 クライアントシークレット。

x

localCallbackPath

String (文字列)

ローカルコールバックエンドポイントを自動生成するためのパス。

/callback

localCallbackConfig

String (文字列)

コールバックエンドポイントを公開するための HTTP リスナ設定名。

cloudhub_http

externalCallbackUrl

String (文字列)

OAuth ダンスログイン後のリダイレクト用の URL。

http://my-app.cloudhub.io/callback

localAuthorizationUrl

String (文字列)

OAuth ダンスを開始するエンドポイントを自動生成するためのローカル URL。

http://localhost:8081/authorize

authorizationUrl

String (文字列)

API をコンシュームするための認証 URL。

https://account.box.com/api/oauth2/authorize

accessTokenUrl

String

API をコンシュームするためのトークン URL。

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

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

ExpirationPolicy

ランタイムで有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最小時間を設定します。これは、プラットフォームで対象となるインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

Box コネクタの操作

  • Copy File

  • Copy Folder

  • Create Collaboration

  • Create Comment

  • Create Folder

  • Create Group

  • Create Group Membership

  • Create Task

  • Create Task Assignment

  • Create User

  • Delete Collaboration

  • Delete Comment

  • Delete File

  • Delete File Version

  • Delete Folder

  • Delete Group

  • Delete Group Membership

  • Delete Task

  • Delete Task Assignment

  • Delete Trashed File

  • Delete Trashed Folder

  • Delete User

  • Get Collaboration

  • Get Comment

  • Get Enterprise Groups

  • Get Enterprise Users

  • Get File

  • Get File Comments

  • Get File Content

  • Get File Tasks

  • Get File Thumbnail

  • Get File Versions

  • Get Folder

  • Get Folder Collaborations

  • Get Folder Items

  • Get Group

  • Get Group Membership

  • Get Group Memberships

  • Get Pending Collaborations

  • Get Task

  • Get Task Assignment

  • Get Task Assignments

  • Get Trashed File

  • Get Trashed Folder

  • Get Trashed Items

  • Get User

  • Get User Group Membership

  • Promote File Version

  • Restore Trashed File

  • Restore Trashed Folder

  • Search

  • Update Collaboration

  • Update Comment

  • Update File Info

  • Update Folder

  • Update Group Membership

  • Update Task

  • Update Task Assignment

  • Update User

  • Update User Folder

Copy File

<mule-box-connector:copy-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Copy File Request Data (Copy File 要求データ)

Any (いずれか)

#[payload]

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Copy Folder

<mule-box-connector:copy-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Copy Folder Request Data (Copy Folder 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Collaboration

<mule-box-connector:create-collaboration>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Collaboration Request Data (Create Collaboration 要求データ)

Any (いずれか)

#[payload]

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Comment

<mule-box-connector:create-comment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Comment Request Data (Create Comment 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Folder

<mule-box-connector:create-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Folder Request Data (Create Folder 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Group

<mule-box-connector:create-group>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Group Request Data (Create Group 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Group Membership

<mule-box-connector:create-group-membership>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Group Membership Request Data (Create Group Membership 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Task

<mule-box-connector:create-task>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Task Request Data (Create Task 要求データ)

Any (いずれか)

#[payload]

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create Task Assignment

<mule-box-connector:create-task-assignment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create Task Assignment Request Data (Create Task Assignment 要求データ)

Any (いずれか)

#[payload]

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Create User

<mule-box-connector:create-user>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Create User Request Data (Create User 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Delete Collaboration

<mule-box-connector:delete-collaboration>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Collab Id (コラボレーション ID)

String (文字列)

x

次の設定の場合

  • config

Delete Comment

<mule-box-connector:delete-comment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Comment Id (コメント ID)

String (文字列)

x

次の設定の場合

  • config

Delete File

<mule-box-connector:delete-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Id (ファイル ID)

String (文字列)

x

If Match (一致する場合)

String (文字列)

ファイルの etag。これはファイルオブジェクトの「etag」項目に含まれます。

次の設定の場合

  • config

Delete File Version

<mule-box-connector:delete-file-version>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Id (ファイル ID)

String (文字列)

x

Version Id (バージョン ID)

String (文字列)

x

If Match (一致する場合)

String (文字列)

ファイルの etag。これはファイルオブジェクトの「etag」項目に含まれます。

次の設定の場合

  • config

Delete Folder

<mule-box-connector:delete-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Recursive (再帰)

Boolean (ブール)

Folder Id (フォルダ ID)

String (文字列)

x

If Match (一致する場合)

String (文字列)

これはフォルダオブジェクトの「etag」項目に含まれます。

次の設定の場合

  • config

Delete Group

<mule-box-connector:delete-group>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Group Id (グループ ID)

String (文字列)

x

次の設定の場合

  • config

Delete Group Membership

<mule-box-connector:delete-group-membership>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Group Membership Id (グループメンバーシップ ID)

String (文字列)

x

次の設定の場合

  • config

Delete Task

<mule-box-connector:delete-task>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Task Id (タスク ID)

String (文字列)

x

次の設定の場合

  • config

Delete Task Assignment

<mule-box-connector:delete-task-assignment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Task Assignment Id (タスク割り当て ID)

String (文字列)

x

次の設定の場合

  • config

Delete Trashed File

<mule-box-connector:delete-trashed-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Id (ファイル ID)

String (文字列)

x

次の設定の場合

  • config

Delete Trashed Folder

<mule-box-connector:delete-trashed-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Folder Id (フォルダ ID)

String (文字列)

x

次の設定の場合

  • config

Delete User

<mule-box-connector:delete-user>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Notify (通知)

Boolean (ブール)

Force (強制)

Boolean (ブール)

User Id (ユーザ ID)

String (文字列)

x

次の設定の場合

  • config

Get Collaboration

<mule-box-connector:get-collaboration>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Status (状況)

String (文字列)

pending (待機中) のみ可能。

Collab Id (コラボレーション ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Comment

<mule-box-connector:get-comment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Comment Id (コメント ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Enterprise Groups

<mule-box-connector:get-enterprise-groups>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

ページに返す項目の最大数。デフォルトは 100、最大は 1,000 です。

Offset (オフセット)

Number (数値)

応答の開始位置の項目。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Enterprise Users

<mule-box-connector:get-enterprise-users>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Filter Term (検索語)

String (文字列)

名前またはログインのいずれかで filter_term で始まるユーザのみに結果を絞り込むために使用する文字列。

Limit (制限)

Number (数値)

返すレコードの数。デフォルトは 100、最大は 1,000 です。

Offset (オフセット)

Number (数値)

開始位置のレコード。デフォルトは 0 です。

User Type (ユーザ種別)

String (文字列)

検索の対象であるユーザの種別。有効な値は all (すべて)、external (外部)、managed (管理対象) です。 指定しない場合、デフォルト動作の managed (管理対象) のみになります。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get File

<mule-box-connector:get-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get File Comments

<mule-box-connector:get-file-comments>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get File Content

<mule-box-connector:get-file-content>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Version (バージョン)

String (文字列)

ダウンロードするこのファイルの ID 固有のバージョン。

File Id (ファイル ID)

String (文字列)

x

Range (範囲)

String (文字列)

バイト単位の範囲値。形式は bytes={start_range}-{end_range} である必要があります。

Box Api (Box API)

String (文字列)

この項目の共有リンク。形式は shared_link=SHARED_LINK である必要があります。

次の設定の場合

  • config

Get File Tasks

<mule-box-connector:get-file-tasks>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get File Thumbnail

<mule-box-connector:get-file-thumbnail>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Min Height (最小高さ)

Number (数値)

サムネイルの最小高さ。

Min Width (最小幅)

Number (数値)

サムネイルの最小幅。

Max Height (最大高さ)

Number (数値)

サムネイルの最大高さ。

Max Width (最大幅)

Number (数値)

サムネイルの最大幅。

File Id (ファイル ID)

String (文字列)

x

Extension (拡張子)

String (文字列)

プレビュー形式。例: .png、.jpg

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get File Versions

<mule-box-connector:get-file-versions>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Folder

<mule-box-connector:get-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Folder Collaborations

<mule-box-connector:get-folder-collaborations>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

ページに返す項目の最大数。デフォルトは 100、最大は 1,000 です。

Offset (オフセット)

Number (数値)

応答の開始位置の項目。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Folder Items

<mule-box-connector:get-folder-items>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

ページに返す項目の最大数。デフォルトは 100、最大は 1,000 です。

Offset (オフセット)

String (文字列)

応答の開始位置のオフセット。オフセットの値が 0 の場合、フォルダリストの先頭から開始されます。注意: 前の応答に非表示の項目がある場合、次のオフセットは、オフセット + 制限 (返されたレコード数ではない) である必要があります。デフォルトは 0 です。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Group

<mule-box-connector:get-group>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Group Id (グループ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Group Membership

<mule-box-connector:get-group-membership>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Group Membership Id (グループメンバーシップ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Group Memberships

<mule-box-connector:get-group-memberships>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

ページに返す項目の最大数。デフォルトは 100、最大は 1,000 です。

Offset (オフセット)

Number (数値)

応答の開始位置の項目。

Group Id (グループ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Pending Collaborations

<mule-box-connector:get-pending-collaborations>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Status (状況)

String (文字列)

「pending」(待機中) である必要があります。

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Task

<mule-box-connector:get-task>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Task Id (タスク ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Task Assignment

<mule-box-connector:get-task-assignment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Task Assignment Id (タスク割り当て ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Task Assignments

<mule-box-connector:get-task-assignments>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Task Id (タスク ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Trashed File

<mule-box-connector:get-trashed-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Trashed Folder

<mule-box-connector:get-trashed-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get Trashed Items

<mule-box-connector:get-trashed-items>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

返す項目の最大数。

Offset (オフセット)

Number (数値)

応答の開始位置の項目。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get User

<mule-box-connector:get-user>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

User Id (ユーザ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Get User Group Membership

<mule-box-connector:get-user-group-membership>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Fields (項目)

String (文字列)

応答に含める属性。

Limit (制限)

Number (数値)

デフォルトは 100 です。最大は 1,000 です。

Offset (オフセット)

Number (数値)

応答の開始位置の項目。

User Id (ユーザ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Promote File Version

<mule-box-connector:promote-file-version>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Promote File Version Request Data (Promote File Version 要求データ)

Any (いずれか)

#[payload]

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Restore Trashed File

<mule-box-connector:restore-trashed-file>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Restore Trashed File Request Data (Restore Trashed File 要求データ)

Any (いずれか)

#[payload]

File Id (ファイル ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Restore Trashed Folder

<mule-box-connector:restore-trashed-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Restore Trashed Folder Request Data (Restore Trashed Folder 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

<mule-box-connector:search>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Query (クエリ)

String (文字列)

検索の対象である文字列。項目名、説明、ファイルのテキストコンテンツ、およびさまざまな項目種別の他の項目と照合できます。

x

Scope (スコープ)

String (文字列)

このスコープに検索を制限します。現在のユーザのみに検索を制限する場合は user_content を、エンタープライズ全体の場合は enterprise_content を指定できます。システム管理者に対して enterprise_content スコープを有効にするには、弊社にお問い合わせください。

File Extensions (ファイル拡張子)

String (文字列)

特定のファイル拡張子 (pdf、png、doc など) に検索を制限します。1 つのファイル拡張子またはカンマ区切りの一連のファイル拡張子 (file_extension_1,file_extension_2,…​) が必要です。

Created At Range (作成日の範囲)

Date (日付)

項目が作成された日付。カンマで区切られた RFC3339 タイムスタンプ変数を使用して日付範囲 (from_date,to_date) を指定します (例: 2018-05-15T13:35:01-07:00,2018-05-17T13:35:01-07:00)。from_date, の後のカンマと ,to_date の前のカンマも受け入れられます。それぞれ、現在の日付と既知の最も早い日付が指定されます。

Updated At Range (更新日の範囲)

Date (日付)

項目が最後に更新された日付。カンマで区切られた RFC3339 変数を使用して日付範囲 (from_date,to_date) を指定します (例: 2018-05-15T13:35:01-07:00,2018-05-17T13:35:01-07:00)。from_date, の後のカンマと ,to_date の前のカンマも受け入れられます。それぞれ、現在の日付と既知の最も早い日付が指定されます。

Size Range (サイズの範囲)

Number (数値)

ファイルサイズの範囲で絞り込みます。カンマで区切られたファイルサイズ (バイト) の範囲 (lower_bound_size,upper_bound_size) を指定します。1MB は 1,000,000 バイトに相当します。lower_bound_size, の後のカンマと ,upper_bound_size の前のカンマもパラメータとして受け入れられます。

Owner User Ids (所有者ユーザ ID)

String (文字列)

項目の所有者で検索します。1 つの user_id またはカンマ区切りの一連の user_id (user_id_1,user_id_2,…​) が必要です。

Ancestor Folder Ids (上位フォルダ ID)

String (文字列)

特定の親フォルダに検索を制限します。1 つの folder_id またはカンマ区切りの一連の folder_id (folder_id_1,folder_id_2,…​) が必要です。親フォルダの結果には、サブフォルダ内の項目も含まれます。

Content Types (コンテンツタイプ)

String (文字列)

Box で指定された特定のコンテンツタイプに検索を制限します。name、description、file_content、comments、または tags を指定できます。1 つの content_type またはカンマ区切りの一連の content_type (content_type_1,content_type_2,…​) が必要です。

Type (型)

String (文字列)

検索で返す型。file、folder、または web_link を指定できます。

Trash Content (ゴミ箱のコンテンツ)

String (文字列)

ゴミ箱内の検索を許可します。trashed_only または non_trashed_only を指定できます。このパラメータなしの検索では、デフォルトの non_trashed_only になります。

Mdfilters (メタデータ検索条件)

String (文字列)

メタデータオブジェクトの関連付けを持つファイルの特定のメタデータテンプレートを絞り込みます。検索条件は 1 つの JSON オブジェクト内に配置されます。swagger.json の定義セクションの MDFilters オブジェクトを参照してください。

Limit (制限)

Number (数値)

返す検索結果の数。デフォルトは 30、最大は 200 です。

Offset (オフセット)

Number (数値)

応答の開始位置の検索結果。デフォルトは 0 です。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Collaboration

<mule-box-connector:update-collaboration>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Collaboration Request Data (Update Collaboration 要求データ)

Any (いずれか)

#[payload]

Collab Id (コラボレーション ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Comment

<mule-box-connector:update-comment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Comment Request Data (Update Comment 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Comment Id (コメント ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update File Info

<mule-box-connector:update-file-info>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update File Info Request Data (Update File Info 要求データ)

Any (いずれか)

#[payload]

File Id (ファイル ID)

String (文字列)

x

If Match (一致する場合)

String (文字列)

ファイルの etag を「If-Match」ヘッダーとして含めると、競合状態を回避できます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Folder

<mule-box-connector:update-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Folder Request Data (Update Folder 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Folder Id (フォルダ ID)

String (文字列)

x

If Match (一致する場合)

String (文字列)

これはフォルダオブジェクトの「etag」項目に含まれます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Group Membership

<mule-box-connector:update-group-membership>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Group Membership Request Data (Update Group Membership 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Group Membership Id (グループメンバーシップ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Task

<mule-box-connector:update-task>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Task Request Data (Update Task 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

Task Id (タスク ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update Task Assignment

<mule-box-connector:update-task-assignment>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Task Assignment Request Data (Update Task Assignment 要求データ)

Any (いずれか)

#[payload]

Task Assignment Id (タスク割り当て ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update User

<mule-box-connector:update-user>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update User Request Data (Update User 要求データ)

Any (いずれか)

#[payload]

Fields (項目)

String (文字列)

応答に含める属性。

User Id (ユーザ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

Update User Folder

<mule-box-connector:update-user-folder>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update User Folder Request Data (Update User Folder 要求データ)

Any (いずれか)

#[payload]

Notify (通知)

Boolean (ブール)

Fields (項目)

String (文字列)

応答に含める属性。

User Id (ユーザ ID)

String (文字列)

x

Folder Id (フォルダ ID)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

操作の出力に対してこの式を評価し、結果を対象変数に保存します。

#[payload]

出力

Type (型)

Any (いずれか)

次の設定の場合

  • config

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

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

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

Number (数値)

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

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub