plan resource type

The Plan resource represents a plan in Office 365. A plan can be owned by a group and contains a collection of tasks. It also can have a collection of buckets. Each plan object has a details object which can contain more information about the plan. See overview for more information regarding relationships between group, plan and task.

JSON representation

Here is a JSON representation of the resource

{
  "createdBy": "string",
  "id": "string (identifier)",
  "owner": "string",
  "title": "string",
  "createdDateTime":"DateTimeOffset",
  "iVisibleInPlannerWebClient":"Boolean",
}

Properties

Property Type Description
createdBy String Read-only. User id by which the plan is created.
id String Read-only. Id of the plan. It is 28 characters long and case sensitive. Format validation is done on the service.
owner String Group id by which the plan is owned. A valid group must exist before this field can be set. Once set, this can only be updated by the owner.
title String Required. Title of the plan. This is usually set the name of the group owning the plan.
createdDateTime DateTimeOffset Read-only. Date and time at which the plan is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
iVisibleInPlannerWebClient Boolean Read-only. Value is true if the plan is shown on Planner Web Client and false otherwise.

Relationships

Relationship Type Description
assignedToTaskBoard planTaskBoard Read-only. Used to render the task board view correctly when grouped by assignedTo.
bucketTaskBoard planTaskBoard Read-only. Used to render the buckets correctly in the task board view.
buckets bucket collection Read-only. Nullable. Collection of buckets in the plan.
details planDetails Read-only. Additional details about the plan.
progressTaskBoard planTaskBoard Read-only. Used to render the task board view correctly when grouped by progress.
tasks task collection Read-only. Nullable. Collection of tasks in the plan.

Methods

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