Box · Schema

Task

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.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
id	string	The unique identifier for this task
type	string	`task`
item	object
due_at	string	When the task is due
action	string	The type of task the task assignee will be prompted to perform.
message	string	A message that will be included with the task
task_assignment_collection	object
is_completed	boolean	Whether the task has been completed
created_by	object
created_at	string	When the task object was created
completion_rule	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 the task in order for it to be considered

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Task",
  "title": "Task",
  "type": "object",
  "x-box-resource-id": "task",
  "x-box-tag": "tasks",
  "description": "A task allows for file-centric workflows within Box. Users can\ncreate tasks on files and assign them to other users for them to complete the\ntasks.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this task",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`task`",
      "example": "task",
      "enum": [
        "task"
      ]
    },
    "item": {
      "allOf": [
        {
          "$ref": "#/components/schemas/File--Mini"
        },
        {
          "description": "The file associated with the task"
        }
      ]
    },
    "due_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the task is due",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "action": {
      "type": "string",
      "example": "review",
      "description": "The type of task the task assignee will be prompted to\nperform.",
      "enum": [
        "review",
        "complete"
      ]
    },
    "message": {
      "type": "string",
      "description": "A message that will be included with the task",
      "example": "Legal review"
    },
    "task_assignment_collection": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskAssignments"
        },
        {
          "description": "A collection of task assignment objects\nassociated with the task"
        }
      ]
    },
    "is_completed": {
      "type": "boolean",
      "description": "Whether the task has been completed",
      "example": true
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Mini"
        },
        {
          "description": "The user who created the task"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the task object was created",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "completion_rule": {
      "type": "string",
      "description": "Defines which assignees need to complete this task before the task\nis considered completed.\n\n* `all_assignees` requires all assignees to review or\napprove the the task in order for it to be considered completed.\n* `any_assignee` accepts any one assignee to review or\napprove the the task in order for it to be considered completed.",
      "example": "all_assignees",
      "enum": [
        "all_assignees",
        "any_assignee"
      ]
    }
  }
}