ファイルに関する詳細を取得します。
12345
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123
の場合、file_id
は123
です。
id,type,name
応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
1
項目が変更されている場合にのみ、その項目を返します。
その項目の最後に認識されたetag
値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modified
を返して失敗します。
[pdf]
ファイルの特定のrepresentations
をリクエストするために必要なヘッダー。特定のファイルレプリゼンテーションをリクエストするには、このヘッダーをfields
クエリパラメータと組み合わせて使用します。
これらのレプリゼンテーションの一般的な形式はX-Rep-Hints: [...]
で、[...]
の部分では[fileType?query]
という形式で1つまたは複数のヒントを指定します。
たとえば、ピクセルサイズ32x32
および94x94
のpng
レプリゼンテーションをリクエストするには、以下のヒントを指定します。
X-Rep-Hints: [jpg?dimensions=32x32][jpg?dimensions=94x94]
また、[extracted_text]
レプリゼンテーションを使用すると、Box内のすべてのドキュメントファイルタイプのtext
レプリゼンテーションを使用できます。
X-Rep-Hints: [extracted_text]
If-None-Match
ヘッダーがフォルダの現在のetag
値と一致する場合は、空の応答を返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。
Authorization
ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。
file_id
が認識されていない形式で指定されている場合に返されます。
誤ったメディアタイプのファイルに対してアクションが実行されると、エラーが返されます。
expiring_embed_link
をリクエストすると、unsupported_media_type
が返されます。予期しないクライアントエラー。
curl -X GET https://api.box.com/2.0/files/12345 \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
BoxFile file = await client.FilesManager.GetInformationAsync(id: "11111");
BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();
file_id = '11111'
file_info = client.file(file_id).get()
print('File "{0}" has a size of {1} bytes'.format(file_info.name, file_info.size))
client.files.get('11111')
.then(file => {
/* file -> {
type: 'file',
id: '11111',
file_version:
{ type: 'file_version',
id: '22222',
sha1: '97b3dbba6eab7ad0f058240744c8636b7c7bea93' },
sequence_id: '1',
etag: '1',
sha1: '97b3dbba6eab7ad0f058240744c8636b7c7bea93',
name: 'Puppy.png',
description: '',
size: 106833,
path_collection:
{ total_count: 2,
entries:
[ { type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' },
{ type: 'folder',
id: '33333',
sequence_id: '0',
etag: '0',
name: 'Collaborated Folder' } ] },
created_at: '2016-11-16T22:01:44-08:00',
modified_at: '2016-11-16T22:01:51-08:00',
trashed_at: null,
purged_at: null,
content_created_at: '2016-10-29T18:33:50-07:00',
content_modified_at: '2016-10-29T18:33:50-07:00',
created_by:
{ type: 'user',
id: '44444',
name: 'Owner',
login: 'owner@example.com' },
modified_by:
{ type: 'user',
id: '44444',
name: 'Owner',
login: 'owner@example.com' },
owned_by:
{ type: 'user',
id: '44444',
name: 'Owner',
login: 'owner@example.com' },
shared_link: null,
parent:
{ type: 'folder',
id: '33333',
sequence_id: '0',
etag: '0',
name: 'Collaborated Folder' },
item_status: 'active' }
*/
});
client.files.get(fileId: "11111", fields: ["name", "created_at"]) { (result: Result<File, BoxSDKError>) in
guard case let .success(file) = result else {
print("Error retrieving file information")
return
}
print("File \(file.name) was created at \(file.createdAt)")
}