title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
run: summary |
Get a summary of runs for a specified time period. |
AlexFilipin |
medium |
entra-id-governance |
apiPageType |
Namespace: microsoft.graph.identityGovernance
[!INCLUDE beta-disclaimer]
Get a summary of runs for a specified time period. Because the amount of runs returned by the List API call 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}/runs/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 workflow run |
endDateTime | DateTimeOffset | The end date and time of the workflow run |
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this function returns a 200 OK
response code and a microsoft.graph.identityGovernance.runSummary in the response body.
The following example shows a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/summary(startDateTime=2022-08-01T00:00:00Z,endDateTime=2022-08-31T00:00:00Z)
[!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.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.identityGovernance.runSummary",
"failedRuns": 0,
"failedTasks": 0,
"successfulRuns": 1,
"totalRuns": 2,
"totalTasks": 4,
"totalUsers": 2
}