taskReport: summary
Namespace: microsoft.graph.identityGovernance
Get a taskReportSummary object.
This API provides a summary of task processing results for a specified time period. Because the volume of task processing results and task reports returned by the List API calls can be overwhelming, this summary allows the administrator to get a quick overview based on counts.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | LifecycleWorkflows.Read.All | LifecycleWorkflows.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | LifecycleWorkflows.Read.All | LifecycleWorkflows.ReadWrite.All |
For delegated scenarios, the admin needs at least the Global Reader or Lifecycle Workflows Administrator Microsoft Entra role.
HTTP request
GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/summary(startDateTime={timestamp},endDateTime={timestamp})
Function parameters
In the request URL, provide the following query parameters with values.
Parameter | Type | Description |
---|---|---|
startDateTime | DateTimeOffset | The start date and time of the period for which the taskReport summary will be generated. |
endDateTime | DateTimeOffset | The end date and time of the period for which the taskReport summary will be generated. |
Optional query parameters
This method supports the $count
, $orderby
, $expand
, and $filter
OData query parameters to help customize the response. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a microsoft.graph.identityGovernance.taskReportSummary object in the response body.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/taskReports/summary(startDateTime=2022-08-19T00:00:00.000Z,endDateTime=2022-08-25T00:33:31.533Z)
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.identityGovernance.taskReportSummary",
"successfulTasks": 8,
"failedTasks": 0,
"unprocessedTasks": 0,
"totalTasks": 8
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for