bucket 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.

A Planner V4 bucket (a custom column used to group tasks within a plan). A bucket has no defaults beyond the universal property set (id, displayName, createdBy, createdDateTime, lastModifiedBy, lastModifiedDateTime); it doesn't carry archivalInfo.

Inherits from plannerDelta.

Methods

Method	Return type	Description
List	bucket collection	Get a list of the bucket objects and their properties.
Create	bucket	Create a new bucket object.
Get	bucket	Read the properties and relationships of bucket object.
Update	bucket	Update the properties of a bucket object.
Delete	None	Delete a bucket object.

Properties

Property	Type	Description
capabilities	bucketCapability	Server-computed, read-only capability flags indicating which optional features are enabled for the entity.
creationInfo	creationInfo	Read-only creation metadata for the entity.
displayName	String	Title of the bucket.
extensions	extensionFieldCollection	Custom extension field values set on the entity. Supports $select.
id	String	The unique identifier of the entity. Read-only. Inherited from entity
lastModifiedBy	identitySet	Identity of the user (or application) who last modified the entity. Read-only.
lastModifiedDateTime	DateTimeOffset	Date and time the entity was last modified. The value is represented in ISO 8601 format and is always in UTC time. Read-only.
planId	String	ID of the plan that contains the bucket. Immutable after creation.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.bucket",
  "id": "String (identifier)",
  "displayName": "String",
  "planId": "String",
  "creationInfo": {
    "@odata.type": "microsoft.graph.creationInfo"
  },
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "capabilities": {
    "@odata.type": "microsoft.graph.bucketCapability"
  },
  "extensions": {
    "@odata.type": "microsoft.graph.extensionFieldCollection"
  }
}