Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api-reference/beta/api/cloudpc-organizationaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Namespace: microsoft.graph
Trigger a Cloud PC organization action.


[!INCLUDE [national-cloud-support](../../includes/global-only.md)]

## Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Namespace: microsoft.graph
Retrieve the details of a [cloudPcOrganizationActionDetail](../resources/cloudpcorganizationactiondetail.md).


[!INCLUDE [national-cloud-support](../../includes/global-only.md)]

## Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
Expand Down
161 changes: 161 additions & 0 deletions api-reference/beta/api/plannerplan-list-historyitems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
---
title: "List historyItems"
description: "Get the history of changes made to tasks within a plan."
author: "praspati"
ms.date: 05/15/2026
ms.localizationpriority: medium
ms.subservice: "planner"
doc_type: apiPageType
---

# List historyItems

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

Get the [history](../resources/plannerhistoryitem.md) of changes made to tasks within a [plan](../resources/plannerplan.md).

## Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).

<!-- {
"blockType": "permissions",
"name": "plannerplan-list-historyitems-permissions"
}
-->
[!INCLUDE [permissions-table](../includes/permissions/plannerplan-list-historyitems-permissions.md)]

## HTTP request

<!-- {
"blockType": "ignored"
}
-->
``` http
GET /planner/plans/{plan-id}/historyItems
```

## Optional query parameters

This method supports the `$filter` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).

Use `$filter` on the **occurredDateTime** property to retrieve history items within a specific time range.

## Request headers

|Name|Description|
|:---|:---|
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|

## Request body

Don't supply a request body for this method.

## Response

If successful, this method returns a `200 OK` response code and a collection of [plannerHistoryItem](../resources/plannerhistoryitem.md) objects in the response body.

## Examples

### Request

The following example shows how to get task [history items](../resources/plannerhistoryitem.md) for a plan with a date filter.

<!-- {
"blockType": "request",
"name": "list_plannerhistoryitem_datefilter"
}
-->
``` http
GET https://graph.microsoft.com/beta/planner/plans/nETqF5FS2LkCp935s-FIFm2QAFkHM/historyItems?$filter=occurredDateTime gt 2025-11-01T00:00:00Z and occurredDateTime lt 2025-12-01T00:00:00Z
```

### Response

The following example shows the response.

>**Note:** The response object shown here might be shortened for readability.

<!-- {
"blockType": "response",
"truncated": true,
"@odata.type": "Collection(microsoft.graph.plannerHistoryItem)"
}
-->
``` http
HTTP/1.1 200 OK
Content-Type: application/json

{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#planner/plans('nETqF5FS2LkCp935s-FIFm2QAFkHM')/historyItems",
"value": [
{
"@odata.type": "#microsoft.graph.taskHistoryItem",
"id": "historyItem-id-1",
"planId": "nETqF5FS2LkCp935s-FIFm2QAFkHM",
"entityId": "dYsWHy7-WEGMQsMaPBv_9ZUAOzQz",
"entityType": "task",
"eventType": "created",
"occurredDateTime": "2026-01-12T14:16:26.5896957Z",
"actor": {
"user": {
"displayName": null,
"id": "6699294c-9300-4ad8-a768-af3407b5e0fe"
},
"application": {
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627a41c90f3"
}
},
"oldData": null,
"newData": {
"createdBy": {
"user": {
"displayName": null,
"id": "6699294c-9300-4ad8-a768-af3407b5e0fe"
},
"application": {
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627a41c90f3"
}
},
"bucketId": "0LHuWF3PrUqKYzq-TcR3oJUADFn8",
"isArchived": false,
"title": "Initial Task Title",
"orderHint": "8584333795589189673P,",
"percentComplete": 0,
"priority": 5
}
},
{
"@odata.type": "#microsoft.graph.taskHistoryItem",
"id": "historyItem-id-2",
"planId": "nETqF5FS2LkCp935s-FIFm2QAFkHM",
"entityId": "dYsWHy7-WEGMQsMaPBv_9ZUAOzQz",
"entityType": "task",
"eventType": "updated",
"occurredDateTime": "2026-01-12T15:16:26.5896957Z",
"actor": {
"user": {
"displayName": null,
"id": "6699294c-9300-4ad8-a768-af3407b5e0fe"
},
"application": {
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627a41c90f3"
}
},
"oldData": {
"title": "Initial Task Title",
"percentComplete": 0
},
"newData": {
"title": "Updated Task Title",
"percentComplete": 50
}
}
]
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
description: "Automatically generated file. DO NOT MODIFY"
ms.topic: include
ms.localizationpriority: medium
---

|Permission type|Least privileged permissions|Higher privileged permissions|
|:---|:---|:---|
|Delegated (work or school account)|Tasks.Read|Tasks.ReadWrite|
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
|Application|Tasks.Read.All|Tasks.ReadWrite.All|

19 changes: 19 additions & 0 deletions api-reference/beta/resources/enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,24 @@ Namespace: microsoft.graph
|failedActivation|
|unknownFutureValue|

### historyEntityType values

|Member|
|:---|
|task|
|unknownFutureValue|

### historyEventType values

|Member|
|:---|
|created|
|updated|
|deleted|
|undeleted|
|moved|
|unknownFutureValue|

### provisionState values

| Member |
Expand Down Expand Up @@ -521,6 +539,7 @@ Namespace: microsoft.graph
| unknownFutureValue |
| formCompletion |
| approvalCompletion |
| completionInHostedApp |

### plannerApprovalStatus values

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The mailbox import and export APIs in Microsoft Graph allow your application to
These APIs support access to data in users' primary, shared, and archive mailboxes on Exchange Online. Items can be imported to the same mailbox or a different one.

> [!Important]
> The mailbox import and export APIs in Microsoft Graph are not designed for mailbox backup and restore. For mailbox backup and restore in Microsoft 365, see [Microsoft 365 Backup](/microsoft-365/backup/backup-overview) or the [Microsoft Graph Backup Storage overview](/graph/backup-storage-concept-overview).
> The mailbox import and export APIs in Microsoft Graph aren't designed for mailbox backup and restore. For mailbox backup and restore in Microsoft 365, see [Microsoft 365 Backup](/microsoft-365/backup/backup-overview) and [Microsoft 365 Backup storage in Microsoft Graph](/graph/backup-storage-concept-overview).

## How to use the mailbox import and export APIs

Expand Down
5 changes: 5 additions & 0 deletions api-reference/beta/resources/planner-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ The delta payload objects that the Planner delta query can currently return are

Use the corresponding `GET` methods on the resource to obtain the initial state of objects to be populated into the local cache.


### Looking at history for the plan

Planner supports an [API](../api/plannerplan-list-historyitems.md) to get the [history](plannerhistoryitem.md) of changes made to [tasks](plannertask.md) within a [plan](plannerplan.md).

### Differentiating between object creation and object modification

In certain scenarios, the caller might want to distinguish between object creation and object modification within Planner's delta query feed.
Expand Down
46 changes: 46 additions & 0 deletions api-reference/beta/resources/plannerdelta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: "plannerDelta resource type"
description: "An abstract type that represents the base type for planner entities such as a plan or a task."
author: "praspati"
ms.date: 05/15/2026
ms.localizationpriority: medium
ms.subservice: "planner"
doc_type: resourcePageType
---

# plannerDelta resource type

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

An abstract type that represents the base type for planner entities such as a plan or a task.

Base type of [plannerHistoryItem](plannerhistoryitem.md), [plannerTask](plannertask.md), [plannerPlan](plannerplan.md), and [plannerBucket](plannerbucket.md).

## Methods
None.

## Properties
|Property|Type|Description|
|:---|:---|:---|
|id|String|The unique identifier for the entity. |

## Relationships
None.

## JSON representation
The following JSON representation shows the resource type.
<!-- {
"blockType": "resource",
"keyProperty": "id",
"@odata.type": "microsoft.graph.plannerDelta",
"openType": false
}
-->
``` json
{
"@odata.type": "#microsoft.graph.plannerDelta",
"id": "String (identifier)"
}
```
63 changes: 63 additions & 0 deletions api-reference/beta/resources/plannerhistoryitem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "plannerHistoryItem resource type"
description: "An abstract type that represents a record of a change made to an entity within a planner plan."
author: "praspati"
ms.date: 05/15/2026
ms.localizationpriority: medium
ms.subservice: "planner"
doc_type: resourcePageType
---

# plannerHistoryItem resource type

Namespace: microsoft.graph

[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]

An abstract type that represents a record of a change made to an entity within a [planner plan](../resources/plannerplan.md). This resource serves as the base for specific history item types.

Inherits from [plannerDelta](../resources/plannerdelta.md).

## Methods
|Method|Return type|Description|
|:---|:---|:---|
|[List](../api/plannerplan-list-historyitems.md)|[plannerHistoryItem](../resources/plannerhistoryitem.md) collection|Get the [history](../resources/plannerhistoryitem.md) of changes made to tasks within a [plan](../resources/plannerplan.md).|

## Properties
|Property|Type|Description|
|:---|:---|:---|
|actor|[identitySet](../resources/identityset.md)|The identity of the user or application that performed the change.|
|entityId|String|The ID of the entity that was changed.|
|entityType|historyEntityType|The type of entity that was changed. The possible values are: `task`, `unknownFutureValue`.|
|eventType|historyEventType|The type of change event that occurred. The possible values are: `created`, `updated`, `deleted`, `undeleted`, `moved`, `unknownFutureValue`.|
|id|String|The unique identifier for the history item. Inherited from [plannerDelta](../resources/plannerdelta.md).|
|occurredDateTime|DateTimeOffset|The date and time when the change occurred. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2024, is `2024-01-01T00:00:00Z`.|
|planId|String|The ID of the plan that contains the changed entity.|

## Relationships
None.

## JSON representation
The following JSON representation shows the resource type.
<!-- {
"blockType": "resource",
"keyProperty": "id",
"@odata.type": "microsoft.graph.plannerHistoryItem",
"baseType": "microsoft.graph.plannerDelta",
"openType": false
}
-->
``` json
{
"@odata.type": "#microsoft.graph.plannerHistoryItem",
"id": "String (identifier)",
"planId": "String",
"entityId": "String",
"entityType": "String",
"eventType": "String",
"occurredDateTime": "String (timestamp)",
"actor": {
"@odata.type": "microsoft.graph.identitySet"
}
}
```
2 changes: 2 additions & 0 deletions api-reference/beta/resources/plannerplan.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Represents a plan in Microsoft 365. Either a [group](group.md) or a [user](user.
|[List plan tasks](../api/plannerplan-list-tasks.md) |[plannerTask](plannertask.md) collection| Get a **plannerTask** object collection.|
|[Get delta](../api/plannerplan-delta.md) | [plannerPlan](../resources/plannerplan.md) collection | Get newly created, updated, or deleted **plannerPlan** objects in either a **group** or a [plannerRoster](plannerroster.md) type container without having to perform a full read of the entire resource collection. |
|[Get usage rights](../api/plannerplan-getusagerights.md)|[planUsageRight](../resources/planusageright.md)|Get the usage rights for a specific [plan](../resources/plannerplan.md) based on its sensitivity label assignment and the requesting user's permissions.|
|[List history items](../api/plannerplan-list-historyitems.md)|[plannerHistoryItem](plannerhistoryitem.md) collection|Get the [history](../resources/plannerhistoryitem.md) of changes made to tasks within a [plan](../resources/plannerplan.md).|

## Properties
| Property | Type |Description|
Expand All @@ -53,6 +54,7 @@ Represents a plan in Microsoft 365. Either a [group](group.md) or a [user](user.
|:---------------|:--------|:----------|
|buckets|[plannerBucket](plannerbucket.md) collection| Collection of buckets in the plan. Read-only. Nullable.|
|details|[plannerPlanDetails](plannerplandetails.md)| Extra details about the plan. Read-only. Nullable. |
|historyItems|[plannerHistoryItem](plannerhistoryitem.md) collection| Collection of history items for entities in the plan. Read-only. Nullable. |
|tasks|[plannerTask](plannertask.md) collection| Collection of tasks in the plan. Read-only. Nullable. |

## JSON representation
Expand Down
Loading
Loading