タスクを更新
タスクを更新します。これは、タスクの構成を更新するため、またはその完了状態を更新するために使用できます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345タスクのID。
リクエスト本文
string本文内省略可能
"review"タスク担当者が実行を求められるアクション。次のいずれかを指定する必要があります。
review- 承認または拒否できる承認タスクを定義しますcomplete- 完了できる一般タスクを定義します
次の値のいずれか1つ: review,complete
string本文内省略可能
"all_assignees"タスクが完了と見なされる前にそのタスクを完了する必要がある担当者を定義します。
all_assignees(デフォルト) - タスクが完了と見なされるには、すべての担当者がそのタスクをレビューまたは承認する必要があります。any_assignee- いずれか1人の担当者がタスクをレビューまたは承認すれば、タスクが完了と見なされます。
次の値のいずれか1つ: all_assignees,any_assignee
string (date-time)本文内省略可能
"2012-12-12T10:53:43-08:00"タスクの期限。
string本文内省略可能
"Please review"タスクに含まれるメッセージ。
レスポンス
application/jsonTask
更新されたタスクオブジェクトを返します
application/jsonクライアントエラー
リクエストのパラメータまたは本文が無効な場合に返されます。
bad_request- 本文に有効なリクエストが含まれていない場合に返されます。これは、actionまたはcompletion_ruleが許可された値のいずれでもないことが原因である可能性があります。
application/jsonクライアントエラー
ファイルに関するタスクを更新する権限がユーザーにない場合は、エラーを返します。
application/jsonクライアントエラー
ファイルが見つからない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X PUT "https://api.box.com/2.0/tasks/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"action": "review"
}'TypeScript Gen
await client.tasks.updateTaskById(task.id!, {
requestBody: {
message: 'updated message',
} satisfies UpdateTaskByIdRequestBody,
} satisfies UpdateTaskByIdOptionalsInput);Python Gen
client.tasks.update_task_by_id(task.id, message="updated message").NET Gen
await client.Tasks.UpdateTaskByIdAsync(taskId: NullableUtils.Unwrap(task.Id), requestBody: new UpdateTaskByIdRequestBody() { Message = "updated message" });Java
BoxTask task = new BoxTask(api, "id");
BoxTask.Info info = task.new Info();
info.setMessage("An edited message.");
task.updateInfo(info);Python
task_update = {'message': 'New Message', 'due_at': '2014-04-03T11:09:43-10:00'}
updated_task = client.task(task_id='12345').update_info(data=task_update)
print(f'New task message is {updated_task.message} and the new due time is {updated_task.due_at}').NET
var updates = new BoxTaskUpdateRequest()
{
Id = "22222",
Message = "Could you please review this?"
};
BoxTask updatedTask = await client.TasksManager.UpdateTaskAsync(updates);Node
client.tasks.update('11111', { message: 'Could you please review?' })
.then(task => {
/* task -> {
type: 'task',
id: '11111',
item:
{ type: 'file',
id: '22222',
sequence_id: '0',
etag: '0',
sha1: '0bbd79a105c504f99573e3799756debba4c760cd',
name: 'box-logo.png' },
due_at: '2014-04-03T11:09:43-07:00',
action: 'review',
message: 'Could you please review?',
task_assignment_collection: { total_count: 0, entries: [] },
is_completed: false,
created_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
created_at: '2013-04-03T11:12:54-07:00' }
*/
});レスポンスの例
{
"id": "11446498",
"type": "task",
"action": "review",
"completion_rule": "all_assignees",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"due_at": "2012-12-12T10:53:43-08:00",
"is_completed": true,
"item": {
"id": "12345",
"type": "file",
"etag": "1",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"name": "Contract.pdf",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
},
"message": "Legal review",
"task_assignment_collection": {
"entries": [
{
"id": "11446498",
"type": "task_assignment",
"item": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
},
"assigned_to": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"message": "Please review",
"completed_at": "2012-12-12T10:53:43-08:00",
"assigned_at": "2012-12-12T10:53:43-08:00",
"reminded_at": "2012-12-12T10:53:43-08:00",
"resolution_state": "incomplete",
"assigned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
}
}
],
"total_count": 100
}
}