Skip to content

Commit fb37d34

Browse files
Automated build 'Automated commit 'PLTWRKFLW-8843: Mark get workflow execution history for deprecation (#2402)
* Enhance load-accounts.yaml description to clarify usage and add warning about disableOptimization parameter * PLTWRKFLW-8843: Mark get workflow execution history for deprecation * PLTWRKFLW-8843: lint * PLTWRKFLW-8843: revert unintended change in load-accounts.yaml * PLTWRKFLW-8843: lint * PLTWRKFLW-8843: lint --------- Co-authored-by: Luke Hagar <[email protected]> Co-authored-by: Luke Hagar <[email protected]>' by github action: 19074340753' powershell sdk: 19074401892
1 parent 203a041 commit fb37d34

File tree

12 files changed

+19
-13
lines changed

12 files changed

+19
-13
lines changed

PSSailpoint/PSSailpoint.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Sailpoint Developer Relations
55
#
6-
# Generated on: 11/03/2025
6+
# Generated on: 11/04/2025
77
#
88

99
@{

PSSailpoint/beta/docs/Methods/BetaWorkflowsApi.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,10 @@ try {
269269
[[Back to top]](#)
270270

271271
## get-workflow-execution-history
272-
Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
272+
:::caution deprecated
273+
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
274+
:::
275+
[Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found.
273276

274277
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history)
275278

PSSailpoint/beta/src/PSSailpoint.Beta/Api/BetaWorkflowsApi.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ Get workflow execution history
408408
409409
.DESCRIPTION
410410
411-
Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
411+
[Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found.
412412
413413
.PARAMETER Id
414414
Id of the workflow execution

PSSailpoint/beta/src/PSSailpoint.Beta/PSSailpoint.Beta.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: OpenAPI Generator Team
55
#
6-
# Generated on: 11/03/2025
6+
# Generated on: 11/04/2025
77
#
88

99
@{

PSSailpoint/v2024/src/PSSailpoint.V2024/PSSailpoint.V2024.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: OpenAPI Generator Team
55
#
6-
# Generated on: 11/03/2025
6+
# Generated on: 11/04/2025
77
#
88

99
@{

PSSailpoint/v2025/docs/Examples/powershell_code_examples_overlay.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10325,7 +10325,7 @@
1032510325
source: |
1032610326
$SourceId = "6d0458373bec4b4b80460992b76016da" # String | The ID of the source.
1032710327
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
10328-
$Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional)
10328+
$Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional)
1032910329
$Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional)
1033010330
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
1033110331
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)

PSSailpoint/v2025/docs/Methods/V2025MachineAccountsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ Param Type | Name | Data Type | Required | Description
307307
------------- | ------------- | ------------- | ------------- | -------------
308308
Path | SourceId | **String** | True | The ID of the source.
309309
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
310-
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw*
310+
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw*
311311
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName**
312312
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
313313
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
@@ -334,7 +334,7 @@ Code | Description | Data Type
334334
```powershell
335335
$SourceId = "6d0458373bec4b4b80460992b76016da" # String | The ID of the source.
336336
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
337-
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional)
337+
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional)
338338
$Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional)
339339
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
340340
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)

PSSailpoint/v2025/src/PSSailpoint.V2025/Api/V2025MachineAccountsApi.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ The ID of the source.
492492
Use this header to enable this experimental API.
493493
494494
.PARAMETER Filters
495-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw*
495+
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw*
496496
497497
.PARAMETER Sorters
498498
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName**

PSSailpoint/v2025/src/PSSailpoint.V2025/PSSailpoint.V2025.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: OpenAPI Generator Team
55
#
6-
# Generated on: 11/03/2025
6+
# Generated on: 11/04/2025
77
#
88

99
@{

PSSailpoint/v3/docs/Methods/WorkflowsApi.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,10 @@ try {
362362
[[Back to top]](#)
363363

364364
## get-workflow-execution-history
365-
Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
365+
:::caution deprecated
366+
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
367+
:::
368+
[Deprecated] This endpoint will be removed in October 2027. Please use `/workflow-executions/{id}/history-v2` instead. Retrieves the detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived; accessing an archived execution will return a 404 Not Found.
366369

367370
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history)
368371

0 commit comments

Comments
 (0)