List tasks on file
get
https://api.box.com/2.0
/files/:file_id/tasks
Retrieves a list of all the tasks for a file. This endpoint does not support pagination.
Request
application/json
Path Parameters
stringin pathrequired
12345The unique identifier that represent a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
Response
application/jsonTasks
Returns a list of tasks on a file.
If there are no tasks on this file an empty collection is returned instead.
application/jsonClient error
Returns an error when the file could not be found or the user does not have access to the file.
application/jsonClient error
Returns an error when the file_id was not provided.
application/jsonClient error
Returns an error when an attempt was made to retrieve tasks for the file
with ID 0.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -X GET https://api.box.com/2.0/files/12345/tasks \
-H 'Authorization: Bearer <ACCESS_TOKEN>'.NET
BoxCollection<BoxTask> tasks = await client.FilesManager.FilesManager.GetFileTasks("11111");Java
BoxFile file = new BoxFile(api, "id");
List<BoxTask.Info> tasks = file.getTasks();Python
tasks = client.file(file_id='11111').get_tasks()
for task in tasks:
print('Task ID is {0} and the type is {1}'.format(task.id, task.type))Node
client.files.getTasks('11111')
.then(tasks => {
/* tasks -> {
total_count: 1,
entries:
[ { type: 'task',
id: '22222',
item:
{ type: 'file',
id: '11111',
sequence_id: '6',
etag: '6',
sha1: '81cc829fb8366fcfc108aa6c5a9bde01a6a10c16',
name: 'box-logo.png' },
due_at: null } ] }
*/
});iOS
client.files.listTasks(forFile: "11111") { results in
switch results {
case let .success(iterator):
for i in 1 ... 10 {
iterator.next { result in
switch result {
case let .success(item):
print("Task messsage: \(task.message)")
case let .failure(error):
print(error)
}
}
}
case let .failure(error):
print(error)
}
}