plannerBucket resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a bucket (or "custom column") for tasks in a plan in Microsoft 365. It is contained in a plannerPlan and can have a collection of plannerTasks.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get bucket | plannerBucket | Read properties and relationships of plannerBucket object. |
| List bucket tasks | plannerTask collection | Get a plannerTask object collection. |
| Create bucket | plannerBucket | Create a new plannerBucket object. |
| Update bucket | plannerBucket | Update plannerBucket object. |
| Delete bucket | None | Delete plannerBucket object. |
| Get delta | plannerBucket collection | Get newly created, updated, or deleted plannerBucket objects in a Planner plan without having to perform a full read of the entire resource collection. |
Properties
| Property | Type | Description |
|---|---|---|
| archivalInfo | plannerArchivalInfo | Read-only. Nullable. Contains information about who archived or unarchived the bucket and why. |
| creationSource | plannerBucketCreation | Contains information about the origin of the bucket. |
| id | String | Read-only. Unique identifier for the bucket. It is 28 characters long and case-sensitive. The format validation is done on the service. |
| isArchived | Boolean | Read-only. If set totrue, the bucket is archived. An archived bucket is read-only. |
| name | String | Name of the bucket. |
| orderHint | String | Hint used to order items of this type in a list view. For details about the supported format, see Using order hints in Planner. |
| planId | String | Plan ID to which the bucket belongs. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| tasks | plannerTask collection | Read-only. Nullable. The collection of tasks in the bucket. |
JSON representation
The following JSON representation shows the resource type.
{
"creationSource": {"@odata.type": "#microsoft.graph.plannerBucketCreation"},
"id": "String (identifier)",
"name": "String",
"orderHint": "String",
"planId": "String"
}