diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md index 43d4871bb..2ad91190f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md @@ -25,9 +25,6 @@ Method | HTTP request | Description ## get-pending-task-headers -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Responds with headers only for list of task statuses for pending tasks. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers) @@ -35,7 +32,6 @@ Responds with headers only for list of task statuses for pending tasks. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. 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. @@ -60,7 +56,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -68,10 +63,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve pending task list headers try { - Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTaskHeaders # Below is a request that includes all optional parameters - # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024PendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" Write-Host $_.ErrorDetails @@ -80,9 +75,6 @@ try { [[Back to top]](#) ## get-pending-tasks -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) @@ -90,7 +82,6 @@ Retrieve a list of statuses for pending tasks. Types of tasks include account an ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. 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. @@ -115,7 +106,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -123,10 +113,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve pending task status list try { - Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTasks # Below is a request that includes all optional parameters - # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024PendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" Write-Host $_.ErrorDetails @@ -135,9 +125,6 @@ try { [[Back to top]](#) ## get-task-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status) @@ -146,7 +133,6 @@ Get task status by task ID. Types of tasks include account and entitlement aggre Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Task ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**TaskStatus**](../models/task-status) @@ -169,15 +155,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get task status by id try { - Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024TaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" Write-Host $_.ErrorDetails @@ -186,9 +171,6 @@ try { [[Back to top]](#) ## get-task-status-list -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. @@ -197,7 +179,6 @@ Use this endpoint to get a list of statuses for **completed** tasks. Types of ta ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. 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. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. @@ -224,7 +205,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) @@ -234,10 +214,10 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe # Retrieve task status list try { - Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatusList # Below is a request that includes all optional parameters - # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2024TaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" Write-Host $_.ErrorDetails @@ -246,9 +226,6 @@ try { [[Back to top]](#) ## update-task-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status) @@ -257,7 +234,6 @@ Update a current task status by task ID. Use this API to clear a pending task by Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Task ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. ### Return type @@ -281,7 +257,6 @@ Code | Description | Data Type ### Example ```powershell $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -293,10 +268,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2024TaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2024TaskStatus -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md index b393a224b..5f8c8afc6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md @@ -25,9 +25,6 @@ Method | HTTP request | Description ## get-pending-task-headers -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Responds with headers only for list of task statuses for pending tasks. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-task-headers) @@ -35,7 +32,6 @@ Responds with headers only for list of task statuses for pending tasks. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. 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. @@ -60,7 +56,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -68,10 +63,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve pending task list headers try { - Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTaskHeaders # Below is a request that includes all optional parameters - # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" Write-Host $_.ErrorDetails @@ -80,9 +75,6 @@ try { [[Back to top]](#) ## get-pending-tasks -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-pending-tasks) @@ -90,7 +82,6 @@ Retrieve a list of statuses for pending tasks. Types of tasks include account an ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. 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. @@ -115,7 +106,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -123,10 +113,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve pending task status list try { - Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTasks # Below is a request that includes all optional parameters - # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" Write-Host $_.ErrorDetails @@ -135,9 +125,6 @@ try { [[Back to top]](#) ## get-task-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-task-status) @@ -146,7 +133,6 @@ Get task status by task ID. Types of tasks include account and entitlement aggre Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Task ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**TaskStatus**](../models/task-status) @@ -169,15 +155,14 @@ Code | Description | Data Type ### Example ```powershell $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get task status by id try { - Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025TaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" Write-Host $_.ErrorDetails @@ -186,9 +171,6 @@ try { [[Back to top]](#) ## get-task-status-list -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. @@ -197,7 +179,6 @@ Use this endpoint to get a list of statuses for **completed** tasks. Types of ta ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. 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. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. @@ -224,7 +205,6 @@ Code | Description | Data Type ### Example ```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) @@ -234,10 +214,10 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe # Retrieve task status list try { - Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatusList # Below is a request that includes all optional parameters - # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025TaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" Write-Host $_.ErrorDetails @@ -246,9 +226,6 @@ try { [[Back to top]](#) ## update-task-status -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/update-task-status) @@ -257,7 +234,6 @@ Update a current task status by task ID. Use this API to clear a pending task by Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Task ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. ### Return type @@ -281,7 +257,6 @@ Code | Description | Data Type ### Example ```powershell $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -293,10 +268,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025TaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025TaskStatus -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 8478d1877..f00061cb9 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -17207,7 +17207,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-task-headers source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -17215,10 +17214,10 @@ # Retrieve pending task list headers try { - Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTaskHeaders # Below is a request that includes all optional parameters - # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024PendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" Write-Host $_.ErrorDetails @@ -17229,7 +17228,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-tasks source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -17237,10 +17235,10 @@ # Retrieve pending task status list try { - Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTasks # Below is a request that includes all optional parameters - # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024PendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" Write-Host $_.ErrorDetails @@ -17252,15 +17250,14 @@ label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get task status by id try { - Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024TaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" Write-Host $_.ErrorDetails @@ -17271,7 +17268,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status-list source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) @@ -17281,10 +17277,10 @@ # Retrieve task status list try { - Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatusList # Below is a request that includes all optional parameters - # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2024TaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" Write-Host $_.ErrorDetails @@ -17296,7 +17292,6 @@ label: SDK_tools/sdk/powershell/v2024/methods/task-management#update-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -17308,10 +17303,10 @@ try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2024TaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2024TaskStatus -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index c74f39a9d..aaa2ff1a5 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -17478,7 +17478,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -17486,10 +17485,10 @@ # Retrieve pending task list headers try { - Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTaskHeaders # Below is a request that includes all optional parameters - # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" Write-Host $_.ErrorDetails @@ -17500,7 +17499,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) $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) @@ -17508,10 +17506,10 @@ # Retrieve pending task status list try { - Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTasks # Below is a request that includes all optional parameters - # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" Write-Host $_.ErrorDetails @@ -17523,15 +17521,14 @@ label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get task status by id try { - Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025TaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" Write-Host $_.ErrorDetails @@ -17542,7 +17539,6 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $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) @@ -17552,10 +17548,10 @@ # Retrieve task status list try { - Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatusList # Below is a request that includes all optional parameters - # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025TaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" Write-Host $_.ErrorDetails @@ -17567,7 +17563,6 @@ label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -17579,10 +17574,10 @@ try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025TaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025TaskStatus -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" Write-Host $_.ErrorDetails