run resource type

Namespace: microsoft.graph.identityGovernance

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the result of a lifecycle workflow that ran for a collection of users because they fulfilled the conditions of the lifecycle workflow. The result is an aggregation of all user processing results of the users that were either processed within an interval or were part of an on-demand execution.

Inherits from entity.

Methods

Method	Return type	Description
List runs	microsoft.graph.identityGovernance.run collection	Get a list of the run objects and their properties.
Get run	microsoft.graph.identityGovernance.run	Read the properties and relationships of a run object.
summary	microsoft.graph.identityGovernance.runSummary	Get a summary of workflows runs.
List task processing results of a run	microsoft.graph.identityGovernance.taskReportSummary	List task processing results from a run.

Properties

Property	Type	Description
completedDateTime	DateTimeOffset	The date time that the run completed. Value is null if the workflow hasn't completed. Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
failedTasksCount	Int32	The number of tasks that failed in the run execution.
failedUsersCount	Int32	The number of users that failed in the run execution.
id	String	A unique identifier for the workflow run.
lastUpdatedDateTime	DateTimeOffset	The datetime that the run was last updated. Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
processingStatus	microsoft.graph.identityGovernance.lifecycleWorkflowProcessingStatus	The run execution status. The possible values are: queued, inProgress, completed, completedWithErrors, canceled, failed, unknownFutureValue. Supports $filter(eq, ne) and $orderby.
scheduledDateTime	DateTimeOffset	The date time that the run is scheduled to be executed for a workflow. Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
startedDateTime	DateTimeOffset	The date time that the run execution started. Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
successfulUsersCount	Int32	The number of successfully completed users in the run.
totalUsersCount	Int32	The total number of users in the workflow execution.
totalTasksCounts	Int32	The total number of tasks in the run execution.
totalUnprocessedTasksCount	Int32	The total number of unprocessed tasks in the run execution.
workflowExecutionType	microsoft.graph.identityGovernance.workflowExecutionType	The execution type of the workflows associated with the run. The possible values are: scheduled, onDemand, unknownFutureValue. Supports $filter(eq, ne) and $orderby.

Relationships

Relationship	Type	Description
userProcessingResults	microsoft.graph.identityGovernance.userProcessingResult collection	The associated individual user execution.
taskProcessingResults	microsoft.graph.identityGovernance.taskProcessingResult collection	The related taskProcessingResults.
taskReports	microsoft.graph.identityGovernance.taskReport collection	The related taskProcessingReports.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.identityGovernance.run",
  "id": "String (identifier)",
  "completedDateTime": "String (timestamp)",
  "failedTasksCount": "Integer",
  "failedUsersCount": "Integer",
  "lastUpdatedDateTime": "String (timestamp)",
  "processingStatus": "String",
  "startedDateTime": "String (timestamp)",
  "scheduledDateTime": "String (timestamp)",
  "successfulUsersCount": "Integer",
  "totalTasksCounts": "Integer",
  "totalUsersCount": "Integer",
  "totalUnprocessedTasksCount": "Integer",
  "workflowExecutionType": "String"
}