6. Box連携 IM-LogicDesignerタスク¶
項目
6.1. 概要¶
Box連携 IM-LogicDesignerタスクには、大きく分けて以下の3種類のタスクが存在します。
ユーザ切り替えタスク接続先の Boxユーザを切り替えるタスクです。ロジックフローに必ず配置する必要があります。 Boxストレージ取得タスクBox上のファイル操作を行う際には、このタスクが返却する仮想的なストレージを通して行います。 その他のタスクファイルのロック・アンロックなど、ストレージを介さない操作のためのタスク群です。
Box上のファイル・フォルダを操作するロジックフローを作成する際には、他のBox連携 IM-LogicDesignerタスクよりも前に、ユーザ切り替えタスクを必ず配置してください。
6.2. 各タスクの説明¶
6.2.1. ユーザ切り替えタスク¶
接続先のBoxユーザを指定するタスクです。
このタスク以降に配置したBox連携 IM-LogicDesignerタスクによる操作は、このタスクで指定したユーザとして行われます。
必ず他のBox連携 IM-LogicDesignerタスクより前に配置してください。
接続先のBoxユーザを指定するには、以下の2通りの入力値のいずれかを利用します。
ユーザコード外部システムユーザ識別子としてBoxユーザのIDを登録済であるユーザの、ユーザコードを指定する方法です。外部システムユーザ識別子の登録方法については、BoxユーザIDとiAPユーザのマッピングを参照してください。
6.2.1.1. 入力値¶
im_boxAsUser <object>
├─ boxUserId <string>
└─ userCd <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxAsUser | 任意 | object | なし | -
|
boxUserId | 任意(userCdと択一) | string | なし | BoxユーザID
|
userCd | 任意(boxUserIdと択一) | string | なし | ユーザコード
|
6.2.2. Boxストレージ取得タスク¶
Box上のファイル・フォルダに相当する仮想的なストレージを取得します。
取得したBoxストレージは、ストレージ操作タスクと組み合わせることにより任意の操作を行うことが可能です。
例えば、ストレージ出力タスクを利用してBox上のファイルに書き込みを行ったり、ストレージファイル読み込みタスクを利用してBox上のファイルを読みこむことができます。
6.2.2.1. 入力値¶
im_boxGetBoxStorage <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxGetBoxStorage | 必須 | string | なし | 操作対象のファイル・フォルダの、Boxのルートフォルダからの絶対パス
|
6.2.2.2. 出力値¶
im_boxGetBoxStorage <storage>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxGetBoxStorage | storage | なし | 取得したBoxストレージ
|
6.2.3. ファイルをロックタスク¶
指定したファイルをロックするタスクです。
6.2.3.1. 入力値¶
im_boxLockFile <object>
├─ path <string>
├─ expiresAt <string>
└─ isDownloadPrevented <boolean>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxLockFile | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイルの絶対パス
|
expiresAt | 任意 | string | なし | 有効期限日時(ISO8601形式の日付フォーマット)
|
isDownloadPrevented | 任意 | boolean | なし | ロックがダウンロードも禁止するか
|
6.2.3.2. 出力値¶
im_boxLockFile <object>
├─ createdAt <string>
├─ createdBy <string>
├─ expiresAt <string>
├─ id <string>
├─ isDownloadPrevented <boolean>
└─ type <string>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxLockFile | object | なし | -
|
createdAt | string | なし | 作成日時(ISO8601形式の日付フォーマット)
|
createdBy | string | なし | ロックの作成者
|
expiresAt | string | なし | 有効期限日時(ISO8601形式の日付フォーマット)
|
id | string | なし | ロックID
|
isDownloadPrevented | boolean | なし | ロックがダウンロードも禁止しているか
|
type | string | なし | ロックのタイプ
|
6.2.4. ファイルをアンロックタスク¶
指定したファイルのロックを解除するタスクです。
6.2.4.1. 入力値¶
im_boxUnlockFile <object>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxUnlockFile | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイルの絶対パス
|
6.2.5. メタデータ取得タスク¶
指定したファイル・フォルダのメタデータを取得するタスクです。
6.2.5.1. 入力値¶
im_boxGetMetadata <object>
├─ templateName <string>
├─ scope <string>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxGetMetadata | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
templateName | 任意 | string | なし | メタデータテンプレート名
|
scope | 任意 | string | なし | メタデータテンプレートのスコープ
|
6.2.6. メタデータ作成タスク¶
指定したファイル・フォルダにメタデータを作成するタスクです。
6.2.6.1. 入力値¶
im_boxCreateMetadata <object>
├─ metadata <map>
├─ templateName <string>
├─ scope <string>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxCreateMetadata | 任意 | object | なし | -
|
metadata | 必須 | map | なし | メタデータのキー/値のマップ。
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
templateName | 任意 | string | なし | メタデータテンプレート名
|
scope | 任意 | string | なし | メタデータテンプレートのスコープ
|
6.2.6.2. 出力値¶
im_boxCreateMetadata <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxCreateMetadata | object | なし | 出力値として利用可能な値はありません。
|
コラム
作成したメタデータはカスタムメタデータとして扱われます。
メタデータのキーの文字列には、 / を含むことができません。
また、メタデータの値はstring、または、いずれかの数値型のみが利用されます。
6.2.7. メタデータ更新タスク¶
指定したファイル・フォルダのメタデータを更新するタスクです。
新しいメタデータの中に、古いメタデータと同一のキーのものがある場合は上書きします。
それ以外については新しいメタデータと古いメタデータを両方保持します。
6.2.7.1. 入力値¶
im_boxUpdateMetadata <object>
├─ metadata <map>
├─ templateName <string>
├─ scope <string>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxUpdateMetadata | 任意 | object | なし | -
|
metadata | 必須 | map | なし | メタデータのキー/値のマップ。
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
templateName | 任意 | string | なし | メタデータテンプレート名
|
scope | 任意 | string | なし | メタデータテンプレートのスコープ
|
6.2.7.2. 出力値¶
im_boxUpdateMetadata <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxUpdateMetadata | object | なし | 出力値として利用可能な値はありません。
|
コラム
作成したメタデータはカスタムメタデータとして扱われます。
メタデータのキーの文字列には、 / を含むことができません。
また、メタデータの値はstring、または、いずれかの数値型のみが利用されます。
6.2.8. メタデータ削除タスク¶
指定したファイル・フォルダのメタデータを削除するタスクです。
6.2.8.1. 入力値¶
im_boxDeleteMetadata <object>
├─ templateName <string>
├─ scope <string>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxDeleteMetadata | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
templateName | 任意 | string | なし | メタデータテンプレート名
|
scope | 任意 | string | なし | メタデータテンプレートのスコープ
|
6.2.8.2. 出力値¶
im_boxDeleteMetadata <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxDeleteMetadata | object | なし | 出力値として利用可能な値はありません。
|
6.2.12. ファイルリクエスト取得タスク¶
指定したファイルリクエストの情報を取得するタスクです。
6.2.12.1. 入力値¶
im_boxGetFileRequestInfo <object>
└─ id <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxGetFileRequestInfo | 任意 | object | なし | -
|
id | 必須 | string | なし | 取得対象のファイルリクエストのID
|
6.2.12.2. 出力値¶
im_boxGetFileRequestInfo <object>
├─ baseUrl <string>
├─ createdAt <string>
├─ createdBy <string>
├─ description <string>
├─ etag <string>
├─ expiresAt <string>
├─ folder <string>
├─ id <string>
├─ isDescriptionRequired <boolean>
├─ isEmailRequired <boolean>
├─ path <string>
├─ resource <string>
├─ status <string>
├─ title <string>
├─ type <string>
├─ updatedAt <string>
├─ updatedBy <string>
└─ url <string>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxGetFileRequestInfo | object | なし | -
|
baseUrl | string | なし | ファイルリクエストURLのベースURL
|
createdAt | string | なし | 作成日時(ISO8601形式の日付フォーマット)
|
createdBy | string | なし | 作成者名
|
description | string | なし | 説明
|
etag | string | なし | ETag文字列
|
expiresAt | string | なし | 有効期限の日時(ISO8601形式の日付フォーマット)
|
folder | string | なし | フォルダ名
|
id | string | なし | ファイルリクエストのID
|
isDescriptionRequired | boolean | なし | 説明の入力が必要な場合は true
|
isEmailRequired | boolean | なし | メールアドレスの入力が必要な場合は true
|
path | string | なし | ファイルリクエストURLのベースURL以降のパス
|
resource | string | なし | 紐づくリソース名
|
status | string | なし | ファイルリクエストが有効な場合は ACTIVE 、そうでない場合は INACTIVE
|
title | string | なし | ファイルリクエストのタイトル
|
type | string | なし | ファイルリクエストのタイプを意味する文字列
|
updatedAt | string | なし | 更新日時(ISO8601形式の日付フォーマット)
|
updatedBy | string | なし | 更新者名
|
url | string | なし | ファイルリクエストURL
|
6.2.13. ファイルリクエストコピータスク¶
指定したファイルリクエストの情報をテンプレートとし、それを指定した別のフォルダにコピーして新しいファイルリクエストを作るタスクです。
新しいファイルリクエストには、入力値に指定した情報がテンプレートを上書きして適用されます。
6.2.13.1. 入力値¶
im_boxCopyFileRequestInfo <object>
├─ id <string>
├─ info <object>
| ├─ description <string>
| ├─ etag <string>
| ├─ expiresAt <string>
| ├─ isDescriptionRequired <boolean>
| ├─ isEmailRequired <boolean>
| ├─ status <string>
| ├─ title <string>
| └─ type <string>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxCopyFileRequestInfo | 任意 | object | なし | -
|
id | 必須 | string | なし | コピー元となるファイルリクエストのID
|
info | 任意 | object | なし | -
|
description | 任意 | string | なし | 説明
|
etag | 任意 | string | なし | ETag文字列
|
expiresAt | 任意 | string | なし | 有効期限の日時(ISO8601形式の日付フォーマット)
|
isDescriptionRequired | 任意 | boolean | なし | 説明の入力が必要な場合は true
|
isEmailRequired | 任意 | boolean | なし | メールアドレスの入力が必要な場合は true
|
status | 任意 | string | なし | ファイルリクエストが有効な場合は ACTIVE 、そうでない場合は INACTIVE
|
title | 任意 | string | なし | ファイルリクエストのタイトル
|
type | 任意 | string | なし | タイプ
|
path | 必須 | string | なし | ファイルリクエストのコピー先のフォルダパス
|
6.2.13.2. 出力値¶
im_boxCopyFileRequestInfo <object>
├─ baseUrl <string>
├─ createdAt <string>
├─ createdBy <string>
├─ description <string>
├─ etag <string>
├─ expiresAt <string>
├─ folder <string>
├─ id <string>
├─ isDescriptionRequired <boolean>
├─ isEmailRequired <boolean>
├─ path <string>
├─ resource <string>
├─ status <string>
├─ title <string>
├─ type <string>
├─ updatedAt <string>
├─ updatedBy <string>
└─ url <string>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxCopyFileRequestInfo | object | なし | -
|
baseUrl | string | なし | ファイルリクエストURLのベースURL
|
createdAt | string | なし | 作成日時(ISO8601形式の日付フォーマット)
|
createdBy | string | なし | 作成者名
|
description | string | なし | 説明
|
etag | string | なし | ETag文字列
|
expiresAt | string | なし | 有効期限の日時(ISO8601形式の日付フォーマット)
|
folder | string | なし | フォルダ名
|
id | string | なし | ファイルリクエストのID
|
isDescriptionRequired | boolean | なし | 説明の入力が必要な場合は true
|
isEmailRequired | boolean | なし | メールアドレスの入力が必要な場合は true
|
path | string | なし | ファイルリクエストURLのベースURL以降のパス
|
resource | string | なし | 紐づくリソース名
|
status | string | なし | ファイルリクエストが有効な場合は ACTIVE 、そうでない場合は INACTIVE
|
title | string | なし | ファイルリクエストのタイトル
|
type | string | なし | ファイルリクエストを意味する文字列
|
updatedAt | string | なし | 更新日時(ISO8601形式の日付フォーマット)
|
updatedBy | string | なし | 更新者名
|
url | string | なし | ファイルリクエストURL
|
コラム
ファイルリクエストコピータスクの出力値は、コピー元となったファイルリクエストの情報です。
新しく作成したファイルリクエストの情報ではありません。
6.2.14. ファイルリクエスト更新タスク¶
指定したファイルリクエストの情報を、入力値に指定した情報で更新するタスクです。
6.2.14.1. 入力値¶
im_boxUpdateFileRequestInfo <object>
├─ id <string>
└─ info <object>
├─ description <string>
├─ etag <string>
├─ expiresAt <string>
├─ isDescriptionRequired <boolean>
├─ isEmailRequired <boolean>
├─ status <string>
├─ title <string>
└─ type <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxUpdateFileRequestInfo | 任意 | object | なし | -
|
id | 必須 | string | なし | 更新の対象とするファイルリクエストのID
|
info | 任意 | object | なし | -
|
description | 任意 | string | なし | 説明
|
etag | 任意 | string | なし | ETag文字列
|
expiresAt | 任意 | string | なし | 有効期限の日時(ISO8601形式の日付フォーマット)
|
isDescriptionRequired | 任意 | boolean | なし | 説明の入力が必要な場合は true
|
isEmailRequired | 任意 | boolean | なし | メールアドレスの入力が必要な場合は true
|
status | 任意 | string | なし | ファイルリクエストが有効な場合は ACTIVE 、そうでない場合は INACTIVE
|
title | 任意 | string | なし | ファイルリクエストのタイトル
|
type | 任意 | string | なし | タイプ
|
6.2.14.2. 出力値¶
im_boxUpdateFileRequestInfo <object>
├─ baseUrl <string>
├─ createdAt <string>
├─ createdBy <string>
├─ description <string>
├─ etag <string>
├─ expiresAt <string>
├─ folder <string>
├─ id <string>
├─ isDescriptionRequired <boolean>
├─ isEmailRequired <boolean>
├─ path <string>
├─ resource <string>
├─ status <string>
├─ title <string>
├─ type <string>
├─ updatedAt <string>
├─ updatedBy <string>
└─ url <string>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxCopyFileRequestInfo | object | なし | -
|
baseUrl | string | なし | ファイルリクエストURLのベースURL
|
createdAt | string | なし | 作成日時(ISO8601形式の日付フォーマット)
|
createdBy | string | なし | 作成者名
|
description | string | なし | 説明
|
etag | string | なし | ETag文字列
|
expiresAt | string | なし | 有効期限の日時(ISO8601形式の日付フォーマット)
|
folder | string | なし | フォルダ名
|
id | string | なし | ファイルリクエストのID
|
isDescriptionRequired | boolean | なし | 説明の入力が必要な場合は true
|
isEmailRequired | boolean | なし | メールアドレスの入力が必要な場合は true
|
path | string | なし | ファイルリクエストURLのベースURL以降のパス
|
resource | string | なし | 紐づくリソース名
|
status | string | なし | ファイルリクエストが有効な場合は ACTIVE 、そうでない場合は INACTIVE
|
title | string | なし | ファイルリクエストのタイトル
|
type | string | なし | ファイルリクエストを意味する文字列
|
updatedAt | string | なし | 更新日時(ISO8601形式の日付フォーマット)
|
updatedBy | string | なし | 更新者名
|
url | string | なし | ファイルリクエストURL
|
6.2.15. ファイルリクエスト削除タスク¶
指定したファイルリクエストの情報を削除するタスクです。
6.2.15.1. 入力値¶
im_boxDeleteFileRequestInfo <object>
└─ id <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxDeleteFileRequestInfo | 任意 | object | なし | -
|
id | 必須 | string | なし | 削除の対象とするファイルリクエストのID
|
6.2.15.2. 出力値¶
im_boxDeleteFileRequestInfo <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxDeleteFileRequestInfo | object | なし | 出力値として利用可能な値はありません。
|
6.2.16. ファイル・フォルダID取得タスク¶
指定したファイル・フォルダのIDを取得するタスクです。
6.2.16.1. 入力値¶
im_boxGetItemId <object>
└─ path <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxGetItemId | 任意 | object | なし | -
|
path | 必須 | string | なし | 取得対象のファイル・フォルダの絶対パス
|
6.2.17. 埋め込みウィジェットタグ取得タスク¶
指定した共有リンクURLから埋め込みウィジェットのhtmlタグ文字列を生成するタスクです。
文字列は<iframe>タグで表現されます。
省略可能なパラメータを省略した場合は、出力されるhtmlタグ内のパラメータも省略されます。
6.2.17.1. 入力値¶
im_boxGetWidgetTag <object>
├─ url <string>
├─ view <string>
├─ sortColumn <string>
├─ sortDirection <string>
├─ showParentPath <boolean>
├─ showItemFeedActions <boolean>
├─ width <string>
└─ height <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxGetWidgetTag | 任意 | object | なし | -
|
url | 必須 | string | なし | ファイルまたはフォルダの共有リンクURL。
共有リンクについては、「共有リンク取得タスク」や「共有リンク作成タスク」で取得可能です。
|
view | 任意 | string | なし | ファイルまたはフォルダの表示方法の種類。
一覧とする場合は list 、グリッドとする場合は icon
|
sortColumn | 任意 | string | なし | ファイルまたはフォルダを並べ替える順番。
日付順とする場合は date 、名前順とする場合は name、ファイルサイズ順とする場合は size
|
sortDirection | 任意 | string | なし | ファイルまたはフォルダの並べ替えの方向。
昇順とする場合は ASC 、降順とする場合は DESC
|
showParentPath | 任意 | boolean | なし | フォルダパスを表示する場合は true 、非表示とする場合は false
|
showItemFeedActions | 任意 | boolean | なし | アクティビティフィードを表示する場合は true 、非表示とする場合は false
|
width | 必須 | int | なし | ウィジェットの幅
|
height | 必須 | int | なし | ウィジェットの高さ
|
6.2.17.2. 出力値¶
im_boxGetWidgetTag <string>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxGetWidgetTag | string | なし | ウィジェットのhtmlタグ文字列表現
|
6.2.18. コラボレータ追加・更新タスク¶
ファイル・フォルダに対するユーザのアクセス権限の追加・更新タスクです。
6.2.18.1. 入力値¶
im_boxAddOrUpdateCollaboration <object>
├─ path <string>
├─ boxUserId <string>
├─ userCd <string>
└─ accessLevel <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxAddOrUpdateCollaboration | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
boxUserId | 任意(userCdと択一) | string | なし | BoxユーザID
|
userCd | 任意(boxUserIdと択一) | string | なし | ユーザコード
|
accessLevel | 必須 | string | なし | アクセスの権限レベル。以下のいずれかの文字列を指定してください。
|
6.2.18.2. 出力値¶
im_boxAddOrUpdateCollaboration <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxAddOrUpdateCollaboration | object | なし | 出力値として利用可能な値はありません。
|
コラム
権限「所有者」を付与すると、ファイル・フォルダのパスが変更されるなどの副次的な挙動を取る場合があります。
このため accessLevel に OWNER を指定することには対応していません。
6.2.19. コラボレータ削除タスク¶
ファイル・フォルダに対するユーザアクセス権限の削除タスクです。
6.2.19.1. 入力値¶
im_boxDeleteCollaboration <object>
├─ path <string>
├─ boxUserId <string>
└─ userCd <string>
項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
---|---|---|---|---|
im_boxDeleteCollaboration | 任意 | object | なし | -
|
path | 必須 | string | なし | 操作対象のファイル・フォルダの絶対パス
|
boxUserId | 任意(userCdと択一) | string | なし | BoxユーザID
|
userCd | 任意(boxUserIdと択一) | string | なし | ユーザコード
|
6.2.19.2. 出力値¶
im_boxDeleteCollaboration <any>
項目名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
im_boxDeleteCollaboration | object | なし | 出力値として利用可能な値はありません。
|