| title | plannerBucket resource type |
|---|---|
| description | Represents a bucket for tasks in a plan in Microsoft 365. |
| author | TarkanSevilmis |
| ms.localizationpriority | medium |
| ms.subservice | planner |
| doc_type | resourcePageType |
| ms.date | 07/22/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
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.
| 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. |
| 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. |
| Relationship | Type | Description |
|---|---|---|
| tasks | plannerTask collection | Read-only. Nullable. The collection of tasks in the bucket. |
The following JSON representation shows the resource type.
{
"creationSource": {"@odata.type": "#microsoft.graph.plannerBucketCreation"},
"id": "String (identifier)",
"name": "String",
"orderHint": "String",
"planId": "String"
}