テンプレートのファイルリクエストの作成

ガイド ファイルリクエスト テンプレートのファイルリクエストの作成

テンプレートのファイルリクエストの作成

現在、ファイルリクエストAPIで可能なのは、新しいファイルリクエストの作成のみです。このAPIを使用して新しいファイルリクエストを作成するには、Boxウェブアプリを使用して、Boxアカウントの任意のフォルダにテンプレートのファイルリクエストを作成する必要があります。

1. テンプレートフォルダ

最初に、テンプレートのファイルリクエストを関連付けることができるテンプレートフォルダを作成します。これは実際にはどのフォルダでもかまいませんが、この目的でのみ使用されるフォルダを使用することをお勧めします。

フォルダはBoxウェブインターフェイスまたはモバイルインターフェイス、あるいはPOST /folders APIを使用して作成できます。

サーバー側JWT認証を使用する場合は、アプリケーションのサービスアカウントが所有するフォルダを作成することをお勧めします。こうすることで、通常のBoxユーザーが誤ってこのフォルダを削除することはなくなります。

2. テンプレートのファイルリクエスト

ファイルリクエストを作成するには、ウェブアプリのテンプレートフォルダに移動し、ページの上部にある3つの点をクリックします。その後、メニューから [ファイルリクエスト] を選択します。

ファイルリクエストの作成

次の設定パネルで、[編集] ボタンをクリックして、ファイルリクエストの設定ページにアクセスします。

ファイルリクエストの編集

設定ページで、ページを保存する前に、タイトルと説明を設定できます。

このページには、URLに含まれるファイルリクエストのIDも表示されます。URLの末尾の数字がファイルリクエストのIDなので、このURLを書き留めてください。これは、APIを使用する際に必要になります。

https://*.app.box.com/filerequest/2338423584

テンプレートフォルダがJWTユーザーに属している場合は、管理対象Boxユーザーをフォルダに招待し、そのフォルダがウェブアプリに表示されるようにする必要があります。自分自身をフォルダに招待すると、自分でこのアプリを使用してファイルリクエストをフォルダに追加できます。

3. テンプレートの使用

テンプレートのファイルリクエストを使用すると、POST /file-requests/:id/copy APIによって新しいコピーを作成できます。新しいフォルダのIDを取得したら、1回のAPI呼び出しで既存のリクエスト (タイトル、説明、フォームの設定を含む) を新しいフォルダにコピーできます。