Skip to main content

lifecycle_workflows_workflows_runs

Creates, updates, deletes, gets or lists a lifecycle_workflows_workflows_runs resource.

Overview​

Namelifecycle_workflows_workflows_runs
TypeResource
Identra_id.identity_governance.lifecycle_workflows_workflows_runs

Fields​

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
activatedOnScopeThe scope for which the workflow runs.
completedDateTimestring (date-time)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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
failedTasksCountnumber (int32)The number of tasks that failed in the run execution.
failedUsersCountnumber (int32)The number of users that failed in the run execution.
lastUpdatedDateTimestring (date-time)The datetime that the run was last updated.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
processingStatusstring (queued, inProgress, completed, completedWithErrors, canceled, failed, unknownFutureValue) (title: lifecycleWorkflowProcessingStatus)
reprocessedRunsarrayThe related reprocessed workflow run.
scheduledDateTimestring (date-time)The date time that the run is scheduled to be executed for a workflow.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
startedDateTimestring (date-time)The date time that the run execution started.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
successfulUsersCountnumber (int32)The number of successfully completed users in the run.
taskProcessingResultsarrayThe related taskProcessingResults.
totalTasksCountnumber (int32)
totalUnprocessedTasksCountnumber (int32)The total number of unprocessed tasks in the run execution.
totalUsersCountnumber (int32)The total number of users in the workflow execution.
userProcessingResultsarrayThe associated individual user execution.
workflowExecutionTypestring (scheduled, onDemand, unknownFutureValue, activatedWithScope) (title: workflowExecutionType)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectworkflow_id, run_idRead the properties and relationships of a run object.
listselectworkflow_idGet a list of the run objects and their properties for a lifecycle workflow.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
run_idstringThe unique identifier of run
workflow_idstringThe unique identifier of workflow

SELECT examples​

Read the properties and relationships of a run object.

SELECT
id,
activatedOnScope,
completedDateTime,
failedTasksCount,
failedUsersCount,
lastUpdatedDateTime,
processingStatus,
reprocessedRuns,
scheduledDateTime,
startedDateTime,
successfulUsersCount,
taskProcessingResults,
totalTasksCount,
totalUnprocessedTasksCount,
totalUsersCount,
userProcessingResults,
workflowExecutionType
FROM entra_id.identity_governance.lifecycle_workflows_workflows_runs
WHERE workflow_id = '{{ workflow_id }}' -- required
AND run_id = '{{ run_id }}' -- required
;