Box · Schema
Task assignment
A task assignment defines which task is assigned to which user to complete.
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The unique identifier for this task assignment |
| type | string | `task_assignment` |
| item | object | |
| assigned_to | object | |
| message | string | A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI. |
| completed_at | string | The date at which this task assignment was completed. This will be `null` if the task is not completed yet. |
| assigned_at | string | The date at which this task was assigned to the user. |
| reminded_at | string | The date at which the assigned user was reminded of this task assignment. |
| resolution_state | string | The current state of the assignment. The available states depend on the `action` value of the task object. |
| assigned_by | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/TaskAssignment",
"title": "Task assignment",
"type": "object",
"x-box-resource-id": "task_assignment",
"x-box-tag": "task_assignments",
"description": "A task assignment defines which task is assigned to which user to complete.",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for this task assignment",
"example": "11446498"
},
"type": {
"type": "string",
"description": "`task_assignment`",
"example": "task_assignment",
"enum": [
"task_assignment"
]
},
"item": {
"allOf": [
{
"$ref": "#/components/schemas/File--Mini"
},
{
"description": "The file that the task has been assigned to."
}
]
},
"assigned_to": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user that the task has been assigned to."
}
]
},
"message": {
"type": "string",
"example": "Please review",
"description": "A message that will is included with the task\nassignment. This is visible to the assigned user in the web and mobile\nUI."
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "The date at which this task assignment was\ncompleted. This will be `null` if the task is not completed yet.",
"example": "2012-12-12T10:53:43-08:00"
},
"assigned_at": {
"type": "string",
"format": "date-time",
"description": "The date at which this task was assigned to the user.",
"example": "2012-12-12T10:53:43-08:00"
},
"reminded_at": {
"type": "string",
"format": "date-time",
"description": "The date at which the assigned user was reminded of this task\nassignment.",
"example": "2012-12-12T10:53:43-08:00"
},
"resolution_state": {
"type": "string",
"description": "The current state of the assignment. The available states depend on\nthe `action` value of the task object.",
"example": "incomplete",
"enum": [
"completed",
"incomplete",
"approved",
"rejected"
]
},
"assigned_by": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user who assigned this task."
}
]
}
}
}