List versions (of a lifecycle workflow)
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.
Get a list of the workflowVersion objects and their properties.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | LifecycleWorkflows.Read.All, LifecycleWorkflows.ReadWrite.All |
For delegated scenarios, the admin needs one of the following Azure AD roles:
- Global administrator
- Global reader
- Lifecycle workflows administrator
HTTP request
GET /identityGovernance/lifecycleWorkflows/workflows/{workflowId}/versions
Optional query parameters
This method supports the $select
, $count
, $search
, $orderBy
, $expand
, 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. |
Request body
Do not 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.workflowVersion objects in the response body.
Examples
Example 1: Retrieve the versions of a workflow
Request
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/156ce798-1eb6-4e0a-8515-e79f54d04390/versions
Response
The following is an example of the response
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('156ce798-1eb6-4e0a-8515-e79f54d04390')/versions",
"value": [
{
"category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Global onboard new hire employee",
"isEnabled": true,
"isSchedulingEnabled": true,
"lastModifiedDateTime": "2022-08-24T19:33:03.8664941Z",
"versionNumber": 3,
"createdDateTime": "2022-08-24T19:31:33.5534766Z"
},
{
"category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Onboard new hire employee",
"isEnabled": true,
"isSchedulingEnabled": false,
"lastModifiedDateTime": "2022-08-24T19:31:33.4303233Z",
"versionNumber": 2,
"createdDateTime": "2022-08-24T19:18:18.6841471Z"
},
{
"category": "joiner",
"description": "Configure new hire tasks for onboarding employees on their first day",
"displayName": "Onboard new hire employee",
"isEnabled": true,
"isSchedulingEnabled": false,
"lastModifiedDateTime": "2022-08-24T19:18:18.5633638Z",
"versionNumber": 1,
"createdDateTime": "2022-08-24T15:39:17.6496784Z"
}
]
}
Example 2: Retrieve specific properties of all versions of a workflow
Request
The following is an example of a request.
GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/workflows/15239232-66ed-445b-8292-2f5bbb2eb833/versions?$select=category,displayName,versionNumber
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/workflows('15239232-66ed-445b-8292-2f5bbb2eb833')/versions(category,displayName,versionNumber)",
"value": [
{
"category": "leaver",
"displayName": "Post-Offboarding of an employee",
"versionNumber": 2
},
{
"category": "leaver",
"displayName": "Post-Offboarding of an employee",
"versionNumber": 1
}
]
}
Feedback
Submit and view feedback for