Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
ファイルリクエストを更新
ファイルリクエストを更新します。これは使用すると、ファイルリクエストを有効化または無効化できます。
リクエスト
リクエストヘッダー
1変更を加える前にこの項目が最近変更されていないことを確認します。
その項目の 最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは412 Precondition Failedを返して失敗します。
パスパラメータ
123ファイルリクエストを表す一意の識別子。
ファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/filerequest/123の場合、file_request_idは123です。
リクエスト本文
"Please upload required documents"ファイルリクエストの新しい説明 (省略可)。これを使用して、ファイルリクエストの説明を変更できます。
デフォルトでは、既存のファイルリクエストの値になります。
"2020-09-28T10:53:43-08:00"ファイルリクエストが新しい送信を受け付けなくなる日付。
この日付を過ぎると、statusは自動的にinactiveに設定されます。
デフォルトでは、既存のファイルリクエストの値になります。
trueファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。
これをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。
デフォルトでは、既存のファイルリクエストの値になります。
trueファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。
これをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。
デフォルトでは、既存のファイルリクエストの値になります。
"active"ファイルリクエストの新しいステータス (省略可)。
このステータスをinactiveに設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合はHTTP 404ステータスコードが返されます。
デフォルトでは、既存のファイルリクエストの値になります。
次の値のいずれか1つ: active,inactive
"Please upload required documents"ファイルリクエストの新しいタイトル (省略可)。これを使用して、ファイルリクエストのタイトルを変更できます。
デフォルトでは、既存のファイルリクエストの値になります。
レスポンス
更新されたファイルリクエストオブジェクトを返します。
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
更新を完了するための権限がユーザーに不足している場合に返されます。
access_denied_insufficient_permissions- 認証済みユーザーにファイルリクエストを更新するためのアクセス権限がない場合に返されます。
ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。
file_request_idが認識されていない形式で指定されている場合に返されます。
If-Matchヘッダーがファイルリクエストの現在のetag値と一致しない場合にエラーを返します。これは、ファイルリクエストが前回リクエストされたときから変更されていることを示します。
予期しないクライアントエラー。
リクエストの例
curl -i -X PUT "https://api.box.com/2.0/file_requests/42037322" \
-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
}'await client.fileRequests.updateFileRequestById(copiedFileRequest.id, {
title: 'updated title',
description: 'updated description',
} satisfies FileRequestUpdateRequest);client.file_requests.update_file_request_by_id(
copied_file_request.id, title="updated title", description="updated description"
)await client.FileRequests.UpdateFileRequestByIdAsync(fileRequestId: copiedFileRequest.Id, requestBody: new FileRequestUpdateRequest() { Title = "updated title", Description = "updated description" });try await client.fileRequests.updateFileRequestById(fileRequestId: copiedFileRequest.id, requestBody: FileRequestUpdateRequest(title: "updated title", description: "updated description"))client.getFileRequests().updateFileRequestById(copiedFileRequest.getId(), new FileRequestUpdateRequest.Builder().title("updated title").description("updated description").build())await client.FileRequests.UpdateFileRequestByIdAsync(fileRequestId: copiedFileRequest.Id, requestBody: new FileRequestUpdateRequest() { Title = "updated title", Description = "updated description" });await client.fileRequests.updateFileRequestById(copiedFileRequest.id, {
title: 'updated title',
description: 'updated description',
} satisfies FileRequestUpdateRequest);レスポンスの例
{
"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"
}