Edit

Share via

plannerTaskDetails 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 the additional information about a task. Each task object has a details object.

Methods

Method Return Type Description
Get task details plannerTaskDetails Read properties and relationships of plannerTaskDetails object.
Update task details plannerTaskDetails Update plannerTaskDetails object.

Properties

Property Type Description
approvalAttachment plannerBaseApprovalAttachment Detailed information about the approval that is attached to the task.
checklist plannerChecklistItems The collection of checklist items on the task.
forms plannerFormsDictionary Read-only. Represents a dictionary of data about the forms associated with a task. Each entry in the dictionary is a key-value pair, and the value is a plannerFormReference object.
completionRequirements plannerTaskCompletionRequirementDetails Contains detailed information about requirements on the task.
description String Description of the task.
id String Read-only. ID of the task details. It's 28 characters long and case-sensitive. Format validation is done on the service.
notes itemBody Rich text description of the task. To be used by HTML-aware clients. For backwards compatibility, a plain-text version of the HTML description will be synced to the "description" field. If this field hasn't previously been set but "description" has been, the existing description is synchronized to "notes" with minimal whitespace-preserving HTML markup. Setting both "description" and "notes" is an error and will result in an exception.
previewType string This sets the type of preview that shows up on the task. Possible values are: automatic, noPreview, checklist, description, reference. When set to automatic the displayed preview is chosen by the app viewing the task.
references plannerExternalReferences The collection of references on the task.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "checklist": {"@odata.type": "microsoft.graph.plannerChecklistItems"},
  "forms": {"@odata.type": "microsoft.graph.plannerFormsDictionary"},
  "completionRequirements": {"@odata.type": "microsoft.graph.plannerTaskCompletionRequirementDetails"},
  "description": "String",
  "id": "String (identifier)",
  "notes": {"@odata.type": "microsoft.graph.itemBody"},
  "previewType": "String",
  "references": {"@odata.type": "microsoft.graph.plannerExternalReferences"},
  "approvalAttachment": {"@odata.type": "microsoft.graph.plannerBaseApprovalAttachment"}
}