新しいファイルリクエストAPI

Box Developers
Box Developer Blog
Published in
Feb 19, 2021
ファイルリクエストAPIがリリースされました

APIの新しいコレクションが利用可能になりました。開発者はこれを使用して、ファイルリクエストを作成および更新できます。Boxでは、ファイルリクエストの管理に役立つよう、リファレンスドキュメントを更新したほか、新しいガイドも追加しました。

Boxファイルリクエストを使用すると、どのユーザーに対しても、迅速かつ安全にファイルおよび関連付けられているメタデータをリクエストできます。ドラッグアンドドロップ方式のグラフィカルインターフェイスを使用して作成できるウェブフォームでは、以下のことが可能です。

  • Boxアカウントの有無に関係なくどのユーザーに対しても、フォルダにコラボレータを追加することなく、安全にファイルをリクエストする。
  • メタデータフォームフィールド (必須/省略可として設定可能) を使用して追加情報を要求する。
  • リンク設定を使用して、追加のセキュリティと追跡を有効にする。
  • Box Relayを使用して自動化ワークフローを開始する。

既存のファイルリクエストのコピーを作成するために必要なのは、既存のファイルリクエストの一意のIDと、新しいリクエストの適用先となるフォルダのIDだけです。

最初のファイルリクエストを作成する

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

ファイルリクエストを作成するには、フォルダを選択し、ページの上部にある省略記号をクリックします。次に、メニューから [ファイルリクエスト] を選択します。

フォルダにファイルリクエストを作成します

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

[ファイルリクエスト] パネル。続行するには [編集] をクリックします。

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

このページのURLにはファイルリクエストのIDも含まれています。次の手順で必要になるため、これをメモしておきます。

ファイルリクエストURLの例。IDは末尾の数字です。

テンプレートのファイルリクエストをコピーする

テンプレートのファイルリクエストをコピーするには、元のファイルリクエストのIDと、ファイルリクエストのコピーの適用先となるフォルダのIDが必要です。

このIDはいずれも、ブラウザでファイルリクエストとフォルダにアクセスしてメモを取ることで確認できます。以下に例を示します。

これらのIDが両方ともわかれば、フォルダに対するファイルリクエストのコピーを作成できます。同時に、ファイルリクエストの設定の一部を更新することも可能です。

さらに、開発者がファイルリクエストの詳細を取得したり、ファイルリクエストを更新または削除したりできるように追加のAPIも利用可能です。

詳細については、開発者向けドキュメントをご確認ください。

For an English translation of this release, please see this post.

--

--