Task - Box Dev Docs

{
  "id": "11446498",
  "type": "task",
  "item": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "due_at": "2012-12-12T10:53:43-08:00",
  "action": "review",
  "message": "Legal review",
  "task_assignment_collection": {
    "total_count": 100,
    "entries": [
      {
        "id": "11446498",
        "type": "task_assignment",
        "item": {
          "id": "12345",
          "type": "file",
          "etag": "1",
          "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": "[email protected]"
        },
        "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": "[email protected]"
        }
      }
    ]
  },
  "is_completed": true,
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "completion_rule": "all_assignees"
}

A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks.

string

The unique identifier for this task.

Example:

"11446498"

type

enum<string>

The value will always be task.

Available options:

task

Example:

"task"

item

File (Mini) · object

The file associated with the task.

Show child attributes

due_at

string<date-time>

When the task is due.

Example:

"2012-12-12T10:53:43-08:00"

action

enum<string>

The type of task the task assignee will be prompted to perform.

Available options:

review,

complete

Example:

"review"

message

string

A message that will be included with the task.

Example:

"Legal review"

task_assignment_collection

Task assignments · object

A collection of task assignment objects associated with the task.

Show child attributes

is_completed

boolean

Whether the task has been completed.

Example:

true

created_by

User (Mini) · object

The user who created the task.

Show child attributes

created_at

string<date-time>

When the task object was created.

Example:

"2012-12-12T10:53:43-08:00"

completion_rule

enum<string>

Defines which assignees need to complete this task before the task is considered completed.

all_assignees requires all assignees to review or approve the task in order for it to be considered completed.
any_assignee accepts any one assignee to review or approve the task in order for it to be considered completed.

Available options:

all_assignees,

any_assignee

Example:

"all_assignees"

Unassign task

Tasks

⌘I