Edit

Share via

workflowVersion resource type

  • Article

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 a version of a lifecycle workflow. Workflow versions are subsequent versions of workflows you can create when you need to change the workflow configuration other than its basic properties. You can view older versions of the workflow and associated reports will note which workflow version had been run.

Inherits from workflowBase.

Methods

Method Return type Description
Create microsoft.graph.identityGovernance.workflowVersion Create a new workflowVersion object.
List microsoft.graph.identityGovernance.workflowVersion collection Get a list of the workflowVersion objects and their properties. Inherited from workflowBase.
Get microsoft.graph.identityGovernance.workflowVersion Read the properties and relationships of a workflowVersion object. Inherited from workflowBase.
List tasks for a workflow version microsoft.graph.identityGovernance.task collection Get the task resources from the tasks navigation property. Inherited from workflowBase.
Get task microsoft.graph.identityGovernance.task Read the properties and relationships of a task object.

Properties

Property Type Description
category microsoft.graph.identityGovernance.lifecycleWorkflowCategory The category of the HR function supported by the workflows created using this template. A workflow can only belong to one category. The possible values are: joiner, leaver, mover, unknownFutureValue. Inherited from workflowBase.

Supports $filter(eq,ne) and $orderby
createdDateTime DateTimeOffset The date time when the workflow was versioned. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
description String The description of the workflowversion. Inherited from workflowBase.
displayName String The display name of the workflowversion. Inherited from workflowBase.

Supports $filter(eq, ne) and orderby.
executionConditions microsoft.graph.identityGovernance.workflowExecutionConditions Conditions describing when to execute the workflow and the criteria to identify in-scope subject set. Inherited from workflowBase.
isEnabled Boolean Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true. Inherited from workflowBase.

Supports $filter(eq, ne) and orderBy.
isSchedulingEnabled Boolean If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Cannot be true for a disabled workflow (where isEnabled is false). Inherited from workflowBase.

Supports $filter(eq, ne) and orderBy.
lastModifiedDateTime DateTimeOffset The date time when the workflow was last modified. Inherited from workflowBase.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.
versionNumber Int32 The version of the workflow.

Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Relationships

Relationship Type Description
createdBy user The user who created the workflow. Inherited from workflowBase.

Supports $filter(eq, ne) and $expand.
lastModifiedBy user The user who last modified the workflow.

Supports $filter(eq, ne) and $expand.
tasks microsoft.graph.identityGovernance.task collection The tasks in the workflow. Inherited from workflowBase.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.identityGovernance.workflowVersion",
  "category": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "executionConditions": {
    "@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"
  },
  "isEnabled": "Boolean",
  "isSchedulingEnabled": "Boolean",
  "lastModifiedDateTime": "String (timestamp)",
  "versionNumber": "Integer"
}