Box Developerドキュメント
最新バージョン

ファイルリクエストをコピー

post
https://api.box.com/2.0
/file_requests/:file_request_id/copy

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

あるフォルダにすでに存在する既存のファイルリクエストをコピーし、別のフォルダに適用します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
123

ファイルリクエストを表す一意の識別子。

ファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/filerequest/123の場合、file_request_id123です。

リクエスト本文

string本文内省略可能
"Please upload required documents"

ファイルリクエストの新しい説明 (省略可)。これを使用して、ファイルリクエストの説明を変更できます。

デフォルトでは、既存のファイルリクエストの値になります。

string (date-time)本文内省略可能
"2020-09-28T10:53:43-08:00"

ファイルリクエストが新しい送信を受け付けなくなる日付。

この日付を過ぎると、statusは自動的にinactiveに設定されます。

デフォルトでは、既存のファイルリクエストの値になります。

object本文内

新しいファイルリクエストを関連付けるフォルダ。

string本文内必須
"42037322"

新しいファイルリクエストを関連付けるフォルダのID。

string本文内必須
"folder"

folder

次の値に固定: folder

boolean本文内省略可能
true

ファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。

これをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。

デフォルトでは、既存のファイルリクエストの値になります。

boolean本文内省略可能
true

ファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。

これをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。

デフォルトでは、既存のファイルリクエストの値になります。

string本文内省略可能
"active"

ファイルリクエストの新しいステータス (省略可)。

このステータスをinactiveに設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合はHTTP 404ステータスコードが返されます。

デフォルトでは、既存のファイルリクエストの値になります。

次の値のいずれか1つ: active,inactive

string本文内省略可能
"Please upload required documents"

ファイルリクエストの新しいタイトル (省略可)。これを使用して、ファイルリクエストのタイトルを変更できます。

デフォルトでは、既存のファイルリクエストの値になります。

レスポンス

更新されたファイルリクエストオブジェクトを返します。

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

更新を完了するための権限がユーザーに不足している場合に返されます。

  • access_denied_insufficient_permissions - 認証済みユーザーにファイルリクエストを更新するためのアクセス権限がない場合に返されます。

ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。

file_request_idが認識されていない形式で指定されている場合に返されます。

予期しないクライアントエラー。

post
ファイルリクエストをコピー
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/file_requests/42037322/copy" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "title": "Please upload required documents",
       "description": "Please upload required documents",
       "status": "active",
       "is_email_required": true,
       "is_description_required": false,
       "folder": {
         "id": "2233212",
         "type": "folder"
       }
     }'

レスポンスの例

{
  "id": "42037322",
  "type": "file_request",
  "created_at": "2020-09-28T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Following documents are requested for your process",
  "etag": "1",
  "expires_at": "2020-09-28T10:53:43-08:00",
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "is_description_required": true,
  "is_email_required": true,
  "status": "active",
  "title": "Please upload documents",
  "updated_at": "2020-09-28T10:53:43-08:00",
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "url": "/f/19e57f40ace247278a8e3d336678c64a"
}