title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
taskReport: summary |
Get a summary of task processing results for a specified time period. |
AlexFilipin |
medium |
entra-id-governance |
apiPageType |
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.
[!INCLUDE national-cloud-support]
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.
[!INCLUDE permissions-table]
[!INCLUDE rbac-lifecycle-workflows-apis-read]
GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/taskReports/summary(startDateTime={timestamp},endDateTime={timestamp})
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. |
This method supports the $count
, $orderby
, $expand
, and $filter
OData query parameters to help customize the response. For general information, see OData query parameters.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and a microsoft.graph.identityGovernance.taskReportSummary object in the response body.
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)
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
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
}