Edit

plannerRoster resource type

  • Article

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 collection of users who are collaborating on a plannerPlan. A plannerRoster is a simple set of users, where everyone has the same level of permissions and they can be created by everyone, unless disabled by the tenant administrator. A plannerRoster can contain one plan.

Deleting a plannerRoster will also delete the plan and all tasks in the plan. A plannerRoster will also be automatically deleted under the following conditions:

  • The plannerRoster doesn't contain a plan 24 hours after its creation. Membership information will be completely erased within 30 days of this deletion.
  • The plannerRoster doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation.
  • The plannerRoster doesn't have any users remaining in the membership list because the last user was permanently deleted. Roster, its plan and all contained tasks will be deleted immediately. Deleted users are permanently erased within 30 days of their deletion; however, tenant administrators can also choose to permanently delete users without this delay.

Methods

Method Return type Description
Create plannerRoster plannerRoster Create a new plannerRoster object.
Get plannerRoster plannerRoster Read the properties and relationships of a plannerRoster object.
Delete plannerRoster None Delete a plannerRoster object.
List members plannerRosterMember collection Get the plannerRosterMember resources from the members navigation property.
Create plannerRosterMember plannerRosterMember Create a new plannerRosterMember object.
List plans plannerPlan collection Get the plannerPlan resources from the plans navigation property.
List user's rosterPlans plannerPlan collection Get the plannerPlans contained by the plannerRosters that the user is a member.

Properties

Property Type Description
id String Identifier of the plannerRoster. Read only. Inherited from entity

Relationships

Relationship Type Description
members plannerRosterMember collection Retrieves the members of the plannerRoster.
plans plannerPlan collection Retrieves the plans contained by the plannerRoster.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.plannerRoster",
  "id": "String (identifier)"
}