bucket resource type

The Bucket resource represents a bucket (or "custom column") for tasks in a plan in Office 365. It is contained in a plan and can have a collection of tasks.

JSON representation

Here is a JSON representation of the resource

{
  "id": "string (identifier)",
  "name": "string",
  "orderHint": "string",
  "planId": "string"
}

Properties

Property Type Description
id String Read-only. Id of the bucket. It is 28 characters long and case sensitive. Format validation is done on the service.
name String Name of the bucket.
orderHint String Used to set the relative order of the buckets in the task board view. Consider three buckets in the order of: 'E', 'F', 'G'. To make 'F' the first bucket, set its 'orderHint' to smaller than that of 'x'. The comparison is an ordinal string comparison.
planId String Plan id to which the bucket belongs.

Relationships

Relationship Type Description
tasks task collection Read-only. Nullable. Collection of tasks in the bucket.

Methods

Method Return Type Description
Get bucket bucket Read properties and relationships of bucket object.
List tasks task collection Get a task object collection.
Create bucket bucket Create a new bucket object.
Update bucket None Update bucket object.
Delete bucket None Delete bucket object.