Skip to content

Latest commit

 

History

History
237 lines (186 loc) · 8.97 KB

identitygovernance-workflow-list-runs.md

File metadata and controls

237 lines (186 loc) · 8.97 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
List runs
Get a list of the run objects and their properties for a lifecycle workflow.
AlexFilipin
medium
entra-id-governance
apiPageType

List runs

Namespace: microsoft.graph.identityGovernance

Get a list of the run objects and their properties for a lifecycle workflow.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-lifecycle-workflows-apis-read]

HTTP request

GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/runs/

Optional query parameters

This method supports the $select, $orderby, 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 collection of microsoft.graph.identityGovernance.run objects in the response body.

Examples

Example 1: List the run reports for a workflow

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/runs/

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

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/v1.0/$metadata#identityGovernance/lifecycleWorkflows/workflows('14879e66-9ea9-48d0-804d-8fea672d0341')/runs",
    "@odata.count": 2,
    "value": [
        {
            "id": "dad77a47-6eda-4de7-bc37-fe8eb5aaf17d",
            "completedDateTime": "2022-08-24T23:28:11.1348863Z",
            "failedTasksCount": 0,
            "failedUsersCount": 0,
            "lastUpdatedDateTime": "2022-08-24T23:33:09.186588Z",
            "processingStatus": "completed",
            "scheduledDateTime": "2022-08-24T23:28:01.6476554Z",
            "startedDateTime": "2022-08-24T23:28:04.5688752Z",
            "successfulUsersCount": 2,
            "totalTasksCount": 4,
            "totalUsersCount": 2,
            "totalUnprocessedTasksCount": 0,
            "workflowExecutionType": "onDemand"
        },
        {
            "id": "a512bb50-3423-4bdc-ad5e-9731095b3b9a",
            "completedDateTime": "2022-08-25T00:15:11.8535443Z",
            "failedTasksCount": 0,
            "failedUsersCount": 0,
            "lastUpdatedDateTime": "2022-08-25T00:20:05.8667912Z",
            "processingStatus": "completed",
            "scheduledDateTime": "2022-08-25T00:15:04.0253846Z",
            "startedDateTime": "2022-08-25T00:15:05.1818741Z",
            "successfulUsersCount": 2,
            "totalTasksCount": 4,
            "totalUsersCount": 2,
            "totalUnprocessedTasksCount": 0,
            "workflowExecutionType": "onDemand"
        }
    ]
}

Example 2: List the run reports for a workflow and select specific properties

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/runs?$select=id,failedTasksCount,failedUsersCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,totalUsersCount,id

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

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/v1.0/$metadata#identityGovernance/lifecycleWorkflows/workflows('15239232-66ed-445b-8292-2f5bbb2eb833')/runs(id,failedTasksCount,failedUsersCount,processingStatus,totalTasksCount,totalUnprocessedTasksCount,totalUsersCount)",
    "value": [
        {
            "id": "e65e08a0-d68d-41dc-915b-8c4019af5cc2",
            "failedTasksCount": 0,
            "failedUsersCount": 0,
            "processingStatus": "completed",
            "totalTasksCount": 3,
            "totalUsersCount": 1,
            "totalUnprocessedTasksCount": 0
        }
    ]
}