intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

Copyright © 2021 NTT DATA INTRAMART CORPORATION

↑Top

1

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

目次
1. 改訂情報
2. はじめに
3. システム要件
3.1. intra-mart Accel Platform
3.2. 検証済み環境
3.2.1. サーバ環境
3.2.2. クライアント環境
4. セットアップ（Box）
4.1. 管理・開発コンソールでの設定
4.2. BoxユーザIDの確認
5. セットアップ（intra-mart）
5.1. モジュールの追加
5.2. 設定ファイルのアップロード
5.3. BoxユーザIDとiAPユーザのマッピング
5.4. BoxユーザIDとiAPユーザの一括マッピングジョブ
5.4.1. セットアップ方法
5.4.2. ジョブ実行方法
6. Box連携 IM-LogicDesignerタスク
6.1. 概要
6.2. 各タスクの説明
6.2.1. ユーザ切り替えタスク
6.2.1.1. 入力値
6.2.1.2. 出力値
6.2.2. Boxストレージ取得タスク
6.2.2.1. 入力値
6.2.2.2. 出力値
6.2.3. ファイルをロックタスク
6.2.3.1. 入力値
6.2.3.2. 出力値
6.2.4. ファイルをアンロックタスク
6.2.4.1. 入力値
6.2.4.2. 出力値
6.2.5. メタデータ取得タスク
6.2.5.1. 入力値
6.2.5.2. 出力値
6.2.6. メタデータ作成タスク
6.2.6.1. 入力値
6.2.6.2. 出力値
6.2.7. メタデータ更新タスク
6.2.7.1. 入力値
6.2.7.2. 出力値
6.2.8. メタデータ削除タスク
6.2.8.1. 入力値
6.2.8.2. 出力値
6.2.9. 共有リンク取得タスク
6.2.9.1. 入力値
6.2.9.2. 出力値
6.2.10. 共有リンク作成タスク
6.2.10.1. 入力値
6.2.10.2. 出力値
6.2.11. 共有リンク削除タスク
6.2.11.1. 入力値
6.2.11.2. 出力値2intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
6.2.12. ファイルリクエスト取得タスク
6.2.12.1. 入力値
6.2.12.2. 出力値
6.2.13. ファイルリクエストコピータスク
6.2.13.1. 入力値
6.2.13.2. 出力値
6.2.14. ファイルリクエスト更新タスク
6.2.14.1. 入力値
6.2.14.2. 出力値
6.2.15. ファイルリクエスト削除タスク
6.2.15.1. 入力値
6.2.15.2. 出力値
6.2.16. ファイル・フォルダID取得タスク
6.2.16.1. 入力値
6.2.16.2. 出力値
6.2.17. 埋め込みウィジェットタグ取得タスク
6.2.17.1. 入力値
6.2.17.2. 出力値
6.2.18. コラボレータ追加・更新タスク
6.2.18.1. 入力値
6.2.18.2. 出力値
6.2.19. コラボレータ削除タスク
6.2.19.1. 入力値
6.2.19.2. 出力値
7. 著作権および特記事項

3intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

改訂情報
変更年月日

変更内容

2021-12-01

初版

2022-06-01

第2版 下記を追加・変更しました。
「メタデータ取得タスク」に templateName, scopeパラメータを追加。
「メタデータ作成タスク」に templateName, scopeパラメータを追加。
「メタデータ更新タスク」に templateName, scopeパラメータを追加。
「メタデータ削除タスク」に templateName, scopeパラメータを追加。
「ファイルをロックタスク」に expiresAt, isDownloadPreventedパラメータを追加。
「システム要件」の検証済み環境の制限を撤廃。

2022-08-31

第3版 下記を追加・変更しました。
「共有リンク作成タスク」にて、一部パラメータが無効となる場合の説明を追加。
「セットアップ（Box）」のカスタムアプリの設定手順の説明を変更。

2022-12-01

第4版 下記を追加しました。
「セットアップ（intra-mart）」にて、intra-mart Accel Platform ユーザとBoxユーザIDの一括マッ
ピングジョブに関する説明を追加。

2023-04-01

第5版 下記を追加しました。
「ファイル・フォルダID取得タスク」の説明を追加。
「埋め込みウィジェットタグ取得タスク」の説明を追加。
「コラボレータ追加・更新タスク」の説明を追加。
「コラボレータ削除タスク」の説明を追加。

2023-10-01

第6版 下記を追加しました。
「共有リンク作成タスク」に canEdit, passwordパラメータを追加。

4

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

はじめに
本書は Box と intra-mart Accel Platform を連携するためのモジュールについて記載しています。
Box連携 は以下の機能を提供します。
Box連携 IM-LogicDesignerタスク
Box連携 設定ファイルアップロード画面
IM-LogicDesignerタスクをロジックフローに配置することで、Box上のファイルの操作を実現できます。
Box連携 を利用するには、 事前にBoxの管理コンソールにて intra-mart Accel Platform をカスタムアプリとして登録する必要があります。
Box連携 は、Box開発コンソールからダウンロードした接続設定ファイルを利用して、Boxへの接続の認証を行います。

5

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

システム要件
当バージョンにおけるシステム要件は次の通りです。

項目
intra-mart Accel Platform
検証済み環境intra-mart Accel Platform
intra-mart Accel Platform 2021 Winter(Dandelion) 以降のご利用のバージョン に準じます。

検証済み環境以下、弊社動作検証済みの intra-mart 製品と他社ミドルウェア製品との組み合わせです。

サーバ環境
intra-mart Accel Platform 2021 Winter(Dandelion) の検証済みサーバ環境に準じます。

クライアント環境
intra-mart Accel Platform 2021 Winter(Dandelion) の検証済みクライアント環境に準じます。

6

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

セットアップ（Box）
項目
管理・開発コンソールでの設定
BoxユーザIDの確認
ここでは Box連携 のインストールと設定手順のうち、Box管理者が行う事項について説明します。
設定は、 Box の管理コンソール画面、および、 開発コンソール画面にて行います。

管理・開発コンソールでの設定
intra-mart Accel Platform から Box に接続をするためには、 Box に管理者としてログインし、以下の設定を行う必要があります。
1. Box に管理者としてログインし、左メニュー下部の「開発者コンソール」をクリックします。

2. 「アプリの新規作成」をクリックします。

3. 「カスタムアプリ」を選択します。

7

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

4. 認証方式として「サーバー認証（JWT使用）」を選択し、「アプリ名」に任意のアプリケーション名を入力し、「アプリの作成」ボタンをクリックします。

5. 「アプリアクセスレベル」として「アプリ＋Enterpriseアクセス」を選択します。

8

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

6. 「アプリケーションスコープ」として、以下の2つが選択されていることを確認します。
Boxに格納されているすべてのファイルとフォルダへの書き込み
ユーザを管理する

7. 「高度な機能」として「as-userヘッダーを使用してAPI呼び出しを行う」を選択します。
その後、「変更を保存」ボタンをクリックします。

9

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

8. 「公開キーの追加と管理」にて、「公開/秘密キーペアを生成」ボタンをクリックします。

9. もしも画像のようなエラーが表示された場合は、この管理者アカウントに対して2段階認証の設定を有効にしてください。

10intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

10. <config.json>ファイルがダウンロードされます。このファイルは後ほど使用しますので、保存してください。

コラム「アプリ設定」の「JSONとしてダウンロード」ボタンをクリックしても<config.json>ファイルがダウンロードされます
が、このファイルには認証キー情報が含まれていません。
必ず「公開/秘密キーペアを生成」ボタンをクリックして<config.json>ファイルをダウンロードしてください。
11. 「承認」タブをクリックし、「確認して送信」ボタンをクリックします。

11

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

12. 「アプリの説明」に任意の説明を入力し、「送信」ボタンをクリックします。

13. 「マイアカウントに戻る」をクリックし、ログイン直後の画面に戻ります。

12

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

14. 管理コンソールを開き、「カスタムアプリ」画面を開きます。

15. 管理コンソールメニューの「アプリ」をクリックします。

13

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

16. 「カスタムアプリ」タブをクリックします。

17. 手順12.で送信したアプリが一覧に表示されているので、「・・・」ボタンをクリックし、「アプリを承認」をクリックします。

14

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

BoxユーザIDの確認
Box連携 IM-LogicDesignerタスクを利用する際には、接続先のBoxユーザのIDが必要です。
BoxユーザのIDは、対象のユーザでBoxにログインした後、右上メニュー→「アカウント設定」→「アカウント」タブ→「アカウントの詳細」→「アカウントID」より確認可能です。

図：「アカウント設定」画面の 「アカウントID」
または、管理者でBoxにログインし、「管理コンソール」→「コンテンツ」→「コンテンツマネージャ」にて一覧から対象のユーザをクリックした際、URLアドレスの content/ 以降に表示されています。

15

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

図：「コンテンツマネージャ」画面のURLアドレス

16

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

セットアップ（intra-mart）
項目
モジュールの追加
設定ファイルのアップロード
BoxユーザIDとiAPユーザのマッピング
BoxユーザIDとiAPユーザの一括マッピングジョブ
セットアップ方法
ジョブ実行方法
ここでは Box連携 のインストールと設定手順のうち、 intra-mart Accel Platform にて行う事項を説明します。
インストールと設定は、 IM-Juggling 、および、設定ファイルアップロード画面にて行います。
以下の手順を行うことで Box連携 を intra-mart Accel Platform 上で利用できます。

モジュールの追加
Box連携 を利用するため、追加機能より「Box 連携」モジュールを選択し WARファイルを作成します。
1. [追加機能 - 外部システム連携機能 - Box 連携]モジュールを選択します。

図：「IM-Juggling モジュール構成」画面
2. その他、任意の設定を行い、WARファイルを作成します。

設定ファイルのアップロード
Box 開発者コンソールからダウンロードした設定ファイルを intra-mart Accel Platform にアップロードし、登録します。
登録した設定ファイルは、 Box への接続時の認証に用いられます。
1. テナント管理者でログインし、「サイトマップ」→「Box」→「Box連携設定」をクリックし、「設定ファイルアップロード」画面を開きます。

17

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

図：「設定ファイルアップロード」画面
2. 「設定ファイル」に、Box管理者コンソールからダウンロードした<config.json>ファイルを指定します。
3. 「アップロード」ボタンをクリックします。

BoxユーザIDとiAPユーザのマッピング
Boxユーザに対応するiAPユーザが存在する場合、 intra-mart Accel Platform にBoxユーザIDを登録しておくことができます。
BoxユーザIDを登録したiAPユーザは、ユーザ切り替えタスクにおいて、BoxユーザIDを直接指定する代わりにユーザコードを指定できます。
BoxユーザIDの確認方法については、BoxユーザIDの確認を参照してください。
intra-mart Accel Platform にBoxユーザIDを登録する方法は、以下の通りです。
1. 対象のユーザでintra-mart Accel Platform へログインし、サイトマップより「個人設定」 - 「プロファイル」をクリックします。
2. ツールバーの「外部システムユーザ識別子設定」をクリックします。

18

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

図： 「プロファイル」画面
3. 外部システム名が「Box」の行の「ユーザ識別子」に連携先のBoxユーザIDを貼り付けて「変更」ボタンをクリックします。

図：「外部システムユーザ識別子設定」画面

BoxユーザIDとiAPユーザの一括マッピングジョブ
intra-mart Accel Platform 2022 Winter(Freesia) 以降では、連携先のBoxに存在するユーザのIDを、intra-mart Accel Platform に一括登録

19

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
する機能を利用できます。
この機能は、ジョブ・ジョブネットにて提供しています。
紐づけには、Boxユーザのメールアドレスと、iAPのユーザプロファイルに設定された「メールアドレス1」の値を利用します。
本機能では、上記メールアドレスが同一であるユーザの「外部システムユーザ識別子」に対して、BoxユーザIDを自動で一括登録します。
本機能は、intra-mart Accel Platform 2022 Winter(Freesia) 以降でテナント環境セットアップを行うことで、ジョブネット管理画面から実行
できます。

コラム
連携先Boxのユーザのメールアドレスとユーザプロファイルの「メールアドレス1」が等しいユーザに対して既に「外部システム
ユーザ識別子」が登録されている場合は、本ジョブの実行によって上書きされます。
また、以下のiAPユーザには影響を与えません。
ユーザプロファイルの「メールアドレス1」が空欄であるユーザ「メールアドレス1」に設定されたメールアドレスが連携先Boxに登録されていないユーザ
対象ユーザは、ジョブ実行時点で有効なユーザのみです。

セットアップ方法
1. 追加機能より「Box 連携」モジュールを選択し WARファイルを作成します。このとき、「Box 連携」のバージョンが8.0.2以降であることを確認します。

図：「IM-Juggling モジュール構成」画面
2. WARファイルのデプロイ後、テナント環境セットアップを実行することにより、ジョブ・ジョブネットがインポートされます。
3. Boxユーザと紐づけたいiAPユーザに対し、共通マスタ画面より、プロファイルの「メールアドレス1」を設定します。
設定するメールアドレスは、紐づけの対象とするBoxユーザのメールアドレスと同じものとしてください。

20

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

図：「ユーザ詳細」画面 - 「プロファイル」タブ

ジョブ実行方法
1. テナント管理者でログインします。
2. ジョブネット管理画面を開き、[ジョブネット一覧 - IM-Box - Boxユーザ一括連携]を選択します。

図：「ジョブネット管理」画面
3. 即時実行ボタンをクリックします。

21

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

Box連携 IM-LogicDesignerタスク
項目
概要
各タスクの説明
ユーザ切り替えタスク
入力値
出力値
Boxストレージ取得タスク
入力値
出力値
ファイルをロックタスク
入力値
出力値
ファイルをアンロックタスク
入力値
出力値
メタデータ取得タスク
入力値
出力値
メタデータ作成タスク
入力値
出力値
メタデータ更新タスク
入力値
出力値
メタデータ削除タスク
入力値
出力値
共有リンク取得タスク
入力値
出力値
共有リンク作成タスク
入力値
出力値
共有リンク削除タスク
入力値
出力値
ファイルリクエスト取得タスク
入力値
出力値
ファイルリクエストコピータスク
入力値
出力値
ファイルリクエスト更新タスク
入力値
出力値
ファイルリクエスト削除タスク
入力値
出力値
ファイル・フォルダID取得タスク
入力値
出力値
埋め込みウィジェットタグ取得タスク
入力値22

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
出力値
コラボレータ追加・更新タスク
入力値
出力値
コラボレータ削除タスク
入力値
出力値

概要
Box連携 IM-LogicDesignerタスクには、大きく分けて以下の3種類のタスクが存在します。
ユーザ切り替えタスク
接続先の Boxユーザを切り替えるタスクです。ロジックフローに必ず配置する必要があります。
Boxストレージ取得タスク
Box上のファイル操作を行う際には、このタスクが返却する仮想的なストレージを通して行います。
その他のタスクファイルのロック・アンロックなど、ストレージを介さない操作のためのタスク群です。
Box上のファイル・フォルダを操作するロジックフローを作成する際には、他のBox連携 IM-LogicDesignerタスクよりも前に、ユーザ切り替え
タスクを必ず配置してください。

コラム
IM-LogicDesignerタスクの入力値としてBoxのファイル・フォルダのパスを指定する際には、ルートフォルダからの絶対パスを指定してください。
例えば以下の図のように abc フォルダ内に存在する test1.txt を指定する際には、"abc/test1.txt" と指定してください。

各タスクの説明
ユーザ切り替えタスク
接続先のBoxユーザを指定するタスクです。
このタスク以降に配置したBox連携 IM-LogicDesignerタスクによる操作は、このタスクで指定したユーザとして行われます。
必ず他のBox連携 IM-LogicDesignerタスクより前に配置してください。
接続先のBoxユーザを指定するには、以下の2通りの入力値のいずれかを利用します。
BoxユーザID
接続先のBoxユーザのIDを直接指定する方法です。
BoxユーザIDの確認方法については、BoxユーザIDの確認を参照してください。
ユーザコード外部システムユーザ識別子としてBoxユーザのIDを登録済であるユーザの、ユーザコードを指定する方法です。
外部システムユーザ識別子の登録方法については、BoxユーザIDとiAPユーザのマッピングを参照してください。

入力値

23

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
im_boxAsUser <object>├─ boxUserId <string>└─ userCd <string>

項目名

必須/任意

型

配列/リスト説明

im_boxAsUser

任意objectなし-

boxUserId

任意

stringなし

BoxユーザID

stringなし

ユーザコード（userCdと択一）
userCd任意（boxUserId
と択一）

出力値
im_boxAsUser <any>

項目名型

配列/リスト 説明

im_boxAsUser

objectなし

出力値として利用可能な値はありません。

Boxストレージ取得タスク
Box上のファイル・フォルダに相当する仮想的なストレージを取得します。
取得したBoxストレージは、ストレージ操作タスクと組み合わせることにより任意の操作を行うことが可能です。
例えば、ストレージ出力タスクを利用してBox上のファイルに書き込みを行ったり、ストレージファイル読み込みタスクを利用してBox上のファ
イルを読みこむことができます。

入力値
im_boxGetBoxStorage <string>

項目名

必須/任意

型

配列/リスト説明

im_boxGetBoxStorage必須

stringなし

操作対象のファイル・フォルダの、Boxのルートフォルダからの絶対パス

出力値
im_boxGetBoxStorage <storage>

項目名型

im_boxGetBoxStorage storage

配列/リスト 説明なし

取得したBoxストレージ

ファイルをロックタスク
指定したファイルをロックするタスクです。

入力値
im_boxLockFile <object>├─ path <string>├─ expiresAt <string>└─ isDownloadPrevented <boolean>24

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名

必須/任意

型

配列/リスト 説明

im_boxLockFile

任意

object

なし

-

path

必須

stringなし

操作対象のファイルの絶対パス

expiresAt

任意

stringなし

有効期限日時（ISO8601形式の日付フォーマット）

isDownloadPrevented

任意booleanなし

ロックがダウンロードも禁止するか

出力値
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形式の日付フォーマット）

idstringなし

ロックID

isDownloadPrevented

booleanなし

ロックがダウンロードも禁止しているか

type

stringなし

ロックのタイプ

ファイルをアンロックタスク
指定したファイルのロックを解除するタスクです。

入力値
im_boxUnlockFile <object>└─ path <string>

項目名

必須/任意

型

配列/リスト 説明

im_boxUnlockFile

任意

object

なし

-

path

必須

stringなし

操作対象のファイルの絶対パス

出力値
im_boxUnlockFile <any>

項目名型

配列/リスト 説明

im_boxUnlockFile

objectなし

出力値として利用可能な値はありません。

メタデータ取得タスク
指定したファイル・フォルダのメタデータを取得するタスクです。

入力値

25

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
im_boxGetMetadata <object>├─ templateName <string>├─ scope <string>└─ path <string>

項目名

必須/任意

型

配列/リスト 説明

im_boxGetMetadata

任意object

なし

-

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

templateName

任意

stringなし

メタデータテンプレート名

scope

任意

stringなし

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

出力値
im_boxGetMetadata <map>

項目名型

配列/リスト 説明

im_boxGetMetadata

map

なし

メタデータのキー/値のマップ。

メタデータ作成タスク
指定したファイル・フォルダにメタデータを作成するタスクです。

入力値
im_boxCreateMetadata <object>├─ metadata <map>├─ templateName <string>├─ scope <string>└─ path <string>

必須/任意

型

配列/リスト 説明

im_boxCreateMetadata 任意

objectなし-

metadata

必須

map

なし

メタデータのキー/値のマップ。

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

templateName

任意

stringなし

メタデータテンプレート名

scope

任意

stringなし

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

項目名

出力値
im_boxCreateMetadata <any>

項目名型

im_boxCreateMetadata object

配列/リスト 説明なし

出力値として利用可能な値はありません。

コラム
作成したメタデータはカスタムメタデータとして扱われます。
メタデータのキーの文字列には、 / を含むことができません。
また、メタデータの値はstring、または、いずれかの数値型のみが利用されます。

メタデータ更新タスク
指定したファイル・フォルダのメタデータを更新するタスクです。
新しいメタデータの中に、古いメタデータと同一のキーのものがある場合は上書きします。

26

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
それ以外については新しいメタデータと古いメタデータを両方保持します。

入力値
im_boxUpdateMetadata <object>├─ metadata <map>├─ templateName <string>├─ scope <string>└─ path <string>

必須/任意

型

配列/リスト説明

im_boxUpdateMetadata 任意

objectなし-

metadata

必須

map

なし

メタデータのキー/値のマップ。

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

templateName

任意

stringなし

メタデータテンプレート名

scope

任意

stringなし

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

項目名

出力値
im_boxUpdateMetadata <any>

項目名配列/リスト 説明型

im_boxUpdateMetadata object

なし

出力値として利用可能な値はありません。

コラム
作成したメタデータはカスタムメタデータとして扱われます。
メタデータのキーの文字列には、 / を含むことができません。
また、メタデータの値はstring、または、いずれかの数値型のみが利用されます。

メタデータ削除タスク
指定したファイル・フォルダのメタデータを削除するタスクです。

入力値
im_boxDeleteMetadata <object>├─ templateName <string>├─ scope <string>└─ path <string>型

配列/リスト 説明

im_boxDeleteMetadata 任意

object

なし

-

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

templateName

任意

stringなし

メタデータテンプレート名

scope

任意

stringなし

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

項目名

必須/任意

出力値
im_boxDeleteMetadata <any>

項目名型

im_boxDeleteMetadata object

配列/リスト 説明なし

出力値として利用可能な値はありません。

27

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
共有リンク取得タスク
指定したファイル・フォルダの共有リンクを取得するタスクです。

入力値
im_boxGetSharedLink <object>└─ path <string>

項目名

必須/任意

型

配列/リスト 説明

im_boxGetSharedLink

任意object

なし

-

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

出力値
im_boxGetSharedLink <string>

項目名型

配列/リスト 説明

im_boxGetSharedLink

stringなし

共有リンクのURL

共有リンク作成タスク
指定したファイル・フォルダの共有リンクを作成するタスクです。

入力値
im_boxCreateSharedLink <object>├─ access <string>├─ canDownload <boolean>├─ canEdit <boolean>├─ canPreview <boolean>├─ password <string>├─ path <string>└─ unsharedDate <string>

項目名

必須/任意

型

配列/リスト説明

im_boxCreateSharedLink

任意objectなし-

access任意

stringなし

共有リンクのアクセス権限。以下のいずれかの文字列を指定
してください。
指定しない場合は DEFAULT が用いられます。
OPEN
リンクを知っているすべての人
COLLABORATORS
協働者内
COMPANY
会社内
DEFAULT
ユーザ、または、エンタープライズの設定に従う

canDownload

任意boolean

なし

ダウンロードを許可する場合は true、禁止する場合は false

canEdit任意booleanなし

編集可能を許可する場合は true、禁止する場合は false

canPreview

任意booleanなし

プレビューを許可する場合は true、禁止する場合は false

password任意

string

なし

パスワード

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

28

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名

必須/任意

型

配列/リスト説明unsharedDate

任意stringなし

共有期限の日時（ISO8601形式の日付フォーマット）

出力値
im_boxCreateSharedLink <string>

項目名型

im_boxCreateSharedLink string

配列/リスト説明なし

共有リンクのURL

コラム
共有リンクが既に存在するファイル・フォルダを指定した場合、共有リンクの情報は上書きされます。
accessに対して、COLLABORATORS を指定した場合、または、共有リンクが既に「招待されたユーザのみ」を対象として作成済
みという状態において DEFAULT を指定した場合、同時にcanDownload、および、canPreviewの指定はできません。これらの場
合、指定しても無効です。
2022年8月現在、canPreviewを指定しても、Boxサーバ側では常に true として扱われます。

共有リンク削除タスク
指定したファイル・フォルダの共有リンクを削除するタスクです。

入力値
im_boxDeleteSharedLink <object>└─ path <string>型

配列/リスト説明

im_boxDeleteSharedLink 任意

object

なし

-

path

stringなし

操作対象のファイル・フォルダの絶対パス

項目名

必須/任意

必須

出力値
im_boxDeleteSharedLink <any>

項目名型

im_boxDeleteSharedLink object

配列/リスト

説明なし

出力値として利用可能な値はありません。

ファイルリクエスト取得タスク
指定したファイルリクエストの情報を取得するタスクです。

入力値
im_boxGetFileRequestInfo <object>└─ id <string>型

配列/リスト説明

im_boxGetFileRequestInfo 任意

objectなし-

idstringなし

取得対象のファイルリクエストのID

項目名

必須/任意

必須

出力値

29

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
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形式の日付フォーマット）

folderstring

なし

フォルダ名

id

stringなし

ファイルリクエストのID

isDescriptionRequired

boolean

なし

説明の入力が必要な場合は trueisEmailRequired

booleanなし

メールアドレスの入力が必要な場合は truepath

stringなし

ファイルリクエストURLのベースURL以降のパス

resource

stringなし

紐づくリソース名

statusstringなし

ファイルリクエストが有効な場合は ACTIVE 、そうでない場合
は INACTIVE

title

stringなし

ファイルリクエストのタイトル

type

stringなし

ファイルリクエストのタイプを意味する文字列

updatedAt

stringなし

更新日時（ISO8601形式の日付フォーマット）

updatedBy

string

なし

更新者名

url

stringなし

ファイルリクエストURL

30

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
コラム
ファイルリクエスト取得タスクの実行に必要なファイルリクエストIDは、Boxにログインしてファイルリクエストの編集画面にアクセスした際のURLに含まれています。
例えば以下のファイルリクエスト編集画面であれば、ファイルリクエストIDは 1675721329 です。

ファイルリクエストコピータスク
指定したファイルリクエストの情報をテンプレートとし、それを指定した別のフォルダにコピーして新しいファイルリクエストを作るタスクです。
新しいファイルリクエストには、入力値に指定した情報がテンプレートを上書きして適用されます。

入力値
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

なし

説明の入力が必要な場合は trueisEmailRequired任意booleanなし

メールアドレスの入力が必要な場合は true

status任意

stringなし

ファイルリクエストが有効な場合は ACTIVE 、そうでない

項目名

必須/任意

場合は INACTIVE

31intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名

必須/任意

型

配列/リスト

説明

title

任意

stringなし

ファイルリクエストのタイトル

type

任意

string

なし

タイプ

path

必須

stringなし

ファイルリクエストのコピー先のフォルダパス

出力値
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形式の日付フォーマット）

folderstring

なし

フォルダ名

id

stringなし

ファイルリクエストのID

isDescriptionRequired

boolean

なし

説明の入力が必要な場合は trueisEmailRequired

booleanなし

メールアドレスの入力が必要な場合は truepath

stringなし

ファイルリクエストURLのベースURL以降のパス

resource

stringなし

紐づくリソース名

statusstringなし

ファイルリクエストが有効な場合は ACTIVE 、そうでない場合
は INACTIVE

title

stringなし

ファイルリクエストのタイトル

type

stringなし

ファイルリクエストを意味する文字列

updatedAt

stringなし

更新日時（ISO8601形式の日付フォーマット）

updatedBy

string

なし

更新者名

url

stringなし

ファイルリクエストURL

コラム
ファイルリクエストコピータスクの出力値は、コピー元となったファイルリクエストの情報です。
新しく作成したファイルリクエストの情報ではありません。

32

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
ファイルリクエスト更新タスク
指定したファイルリクエストの情報を、入力値に指定した情報で更新するタスクです。

入力値
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

なし

説明の入力が必要な場合は trueisEmailRequired任意booleanなし

メールアドレスの入力が必要な場合は true

status任意

stringなし

ファイルリクエストが有効な場合は ACTIVE 、そうでない

項目名

必須/任意

場合は INACTIVE
title

任意

stringなし

ファイルリクエストのタイトル

type

任意

string

なし

タイプ

出力値
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形式の日付フォーマット）

33

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名型

配列/リスト説明createdBy

stringなし

作成者名

description

string

なし

説明

etag

stringなし

ETag文字列

expiresAt

stringなし

有効期限の日時（ISO8601形式の日付フォーマット）

folderstring

なし

フォルダ名

id

stringなし

ファイルリクエストのID

isDescriptionRequired

boolean

なし

説明の入力が必要な場合は trueisEmailRequired

booleanなし

メールアドレスの入力が必要な場合は truepath

stringなし

ファイルリクエストURLのベースURL以降のパス

resource

stringなし

紐づくリソース名

statusstringなし

ファイルリクエストが有効な場合は ACTIVE 、そうでない場合
は INACTIVE

title

stringなし

ファイルリクエストのタイトル

type

stringなし

ファイルリクエストを意味する文字列

updatedAt

stringなし

更新日時（ISO8601形式の日付フォーマット）

updatedBy

string

なし

更新者名

url

stringなし

ファイルリクエストURL

ファイルリクエスト削除タスク
指定したファイルリクエストの情報を削除するタスクです。

入力値
im_boxDeleteFileRequestInfo <object>└─ id <string>型

配列/リスト説明

im_boxDeleteFileRequestInfo 任意

objectなし-

idstringなし

削除の対象とするファイルリクエストのID

項目名

必須/任意

必須

出力値
im_boxDeleteFileRequestInfo <any>

項目名型

im_boxDeleteFileRequestInfo object

配列/リスト

説明なし

出力値として利用可能な値はありません。

ファイル・フォルダID取得タスク
指定したファイル・フォルダのIDを取得するタスクです。

入力値
im_boxGetItemId <object>└─ path <string>34

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名

必須/任意

型

配列/リスト 説明

im_boxGetItemId

任意object

なし

-

path

必須

stringなし

取得対象のファイル・フォルダの絶対パス

出力値
im_boxGetItemId <string>

項目名型

配列/リスト 説明

im_boxGetItemId

stringなし

ファイル・フォルダのID

埋め込みウィジェットタグ取得タスク
指定した共有リンクURLから埋め込みウィジェットのhtmlタグ文字列を生成するタスクです。
文字列は<iframe>タグで表現されます。
省略可能なパラメータを省略した場合は、出力されるhtmlタグ内のパラメータも省略されます。

入力値
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

なし

ウィジェットの高さ

出力値
im_boxGetWidgetTag <string>

項目名型

配列/リスト 説明

35

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
項目名型

配列/リスト 説明

im_boxGetWidgetTagstringなし

ウィジェットのhtmlタグ文字列表現

コラボレータ追加・更新タスク
ファイル・フォルダに対するユーザのアクセス権限の追加・更新タスクです。

入力値
im_boxAddOrUpdateCollaboration <object>├─ path <string>├─ boxUserId <string>├─ userCd <string>└─ accessLevel <string>

必須/任意

型

配列/リスト 説明

im_boxAddOrUpdateCollaboration 任意

object

なし

-

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

boxUserId

任意

stringなし

BoxユーザID

stringなし

ユーザコードstringなし

アクセスの権限レベル。以下のいずれかの文字列を指定

項目名（userCdと択一）
userCd任意（boxUserIdと択一）

accessLevel

必須

してください。
CO_OWNER
共同所有者
EDITOR
編集者
VIEWER_UPLOADER
ビューアー/アップローダー
PREVIEWER_UPLOADER
プレビューアー/アップローダー
VIEWER
ビューアー
PREVIEWER
プレビューアーUPLOADER
アップローダー

出力値
im_boxAddOrUpdateCollaboration <any>

項目名型

im_boxAddOrUpdateCollaboration object

配列/リスト

説明なし

出力値として利用可能な値はありません。

コラム
権限「所有者」を付与すると、ファイル・フォルダのパスが変更されるなどの副次的な挙動を取る場合があります。
このため accessLevel に OWNER を指定することには対応していません。

コラボレータ削除タスク

36

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01
ファイル・フォルダに対するユーザアクセス権限の削除タスクです。

入力値
im_boxDeleteCollaboration <object>├─ path <string>├─ boxUserId <string>└─ userCd <string>型

配列/リスト説明

im_boxDeleteCollaboration 任意

object

なし

-

path

必須

stringなし

操作対象のファイル・フォルダの絶対パス

boxUserId

任意

stringなし

BoxユーザID

stringなし

ユーザコード

項目名

必須/任意（userCdと択一）
userCd任意（boxUserId
と択一）

出力値
im_boxDeleteCollaboration <any>

項目名型

im_boxDeleteCollaboration object

配列/リスト

説明なし

出力値として利用可能な値はありません。

37

intra-mart Accel Platform — Box連携モジュール 利用ガイド 第6版 2023-10-01

著作権および特記事項
intra-mart は株式会社エヌ・ティ・ティ・データイントラマートの登録商標です。
Oracle と Javaは、Oracle Corporation およびその子会社、関連会社の米国およびその他の国における登録商標です。
Box は、Box（Box, Inc.）のオンラインストレージサービスです。
文中の社名、商品名等は各社の商標または登録商標である場合があります。
他の会社名、製品名およびサービス名などはそれぞれ各社の商標または登録商標です。
本製品を使用する場合は、本製品に含まれる各ソフトウェアのライセンスについても同意したものとします。
以上

38