Task assignment

A task assignment defines which task is assigned to which user to complete.

string
11446498

The unique identifier for this task assignment

string
task_assignment

Value is always task_assignment

string / date-time
2012-12-12T10:53:43-08:00

The date at which this task was assigned to the user.

The user who assigned this task.

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

The user that the task has been assigned to.

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

string / date-time
2012-12-12T10:53:43-08:00

The date at which this task assignment was completed. This will be null if the task is not completed yet.

object

The file that the task has been assigned to.

string
12345

The 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.

string
file

Value is always file

string
1

The HTTP etag of this file. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the file if (no) changes have happened.

The information about the current version of the file.

12345

The unique identifier that represent a file version.

file_version

Value is always file_version

134b65991ed521fcfe4724b7d814ab8ded5185dc

The SHA1 hash of this version of the file.

string
Contract.pdf

The name of the file

3

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

string / digest
85136C79CBF9FE36BB9D05D0639C70C265C18D37

The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.

string
Please review

A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.

string / date-time
2012-12-12T10:53:43-08:00

The date at which the assigned user was reminded of this task assignment.

incomplete

The current state of the assignment. The available states depend on the action value of the task object.

Value is one of completed,incomplete,approved,rejected

Response Example

{
  "id": 11446498,
  "type": "task_assignment",
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "assigned_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "assigned_to": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "completed_at": "2012-12-12T10:53:43-08:00",
  "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": "Please review",
  "reminded_at": "2012-12-12T10:53:43-08:00",
  "resolution_state": "incomplete"
}