LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 14084874744

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-26 13:45:58 +00:00
parent e44badae35
commit fe4aab85d6
2 changed files with 72 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md
View File

@@ -46,9 +46,6 @@ Method | HTTP request | Description
## create-form-definition ## create-form-definition
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition)
@@ -56,7 +53,6 @@ This API is currently in an experimental state. The API is subject to change bas
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request Body | Body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request
### Return type ### Return type
@@ -78,7 +74,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"{ $Body = @"{
"owner" : { "owner" : {
"name" : "Grant Smith", "name" : "Grant Smith",
@@ -194,10 +189,10 @@ $Body = @"{
# Creates a form definition. # Creates a form definition.
try { try {
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental New-V2024FormDefinition
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormDefinition -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -206,9 +201,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## create-form-definition-dynamic-schema ## create-form-definition-dynamic-schema
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema)
@@ -216,7 +208,6 @@ This API is currently in an experimental state. The API is subject to change bas
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema
### Return type ### Return type
@@ -239,7 +230,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"{ $Body = @"{
"description" : "A description", "description" : "A description",
"attributes" : { "attributes" : {
@@ -253,10 +243,10 @@ $Body = @"{
# Generate JSON Schema dynamically. # Generate JSON Schema dynamically.
try { try {
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental New-V2024FormDefinitionDynamicSchema
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormDefinitionDynamicSchema -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -265,9 +255,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## create-form-definition-file-request ## create-form-definition-file-request
:::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.
:::
Parameter `{formDefinitionID}` should match a form definition ID. Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request)
@@ -276,7 +263,6 @@ Parameter `{formDefinitionID}` should match a form definition ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | FormDefinitionID String specifying FormDefinitionID Path | FormDefinitionID | **String** | True | FormDefinitionID String specifying FormDefinitionID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
| File | **System.IO.FileInfo** | True | File specifying the multipart | File | **System.IO.FileInfo** | True | File specifying the multipart
### Return type ### Return type
@@ -303,16 +289,15 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | File specifying the multipart $File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file. # Upload new form definition file.
try { try {
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -321,9 +306,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## create-form-instance ## create-form-instance
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance) [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance)
@@ -331,7 +313,6 @@ This API is currently in an experimental state. The API is subject to change bas
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance
### Return type ### Return type
@@ -353,7 +334,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @"{ $Body = @"{
"formInput" : { "formInput" : {
"input1" : "Sales" "input1" : "Sales"
@@ -379,10 +359,10 @@ $Body = @"{
# Creates a form instance. # Creates a form instance.
try { try {
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental New-V2024FormInstance
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormInstance -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -391,9 +371,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## delete-form-definition ## delete-form-definition
:::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.
:::
Parameter `{formDefinitionID}` should match a form definition ID. Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition) [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition)
@@ -402,7 +379,6 @@ Parameter `{formDefinitionID}` should match a form definition ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | Form definition ID Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) [**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
@@ -425,15 +401,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Deletes a form definition. # Deletes a form definition.
try { try {
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -442,9 +417,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## export-form-definitions-by-tenant ## export-form-definitions-by-tenant
:::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.
:::
No parameters required. No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant) [API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant)
@@ -452,7 +424,6 @@ No parameters required.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in*
@@ -477,7 +448,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'name sw "my form"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) $Filters = 'name sw "my form"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -486,10 +456,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List form definitions by tenant. # List form definitions by tenant.
try { try {
Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental Export-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters # Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -498,9 +468,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-file-from-s3 ## get-file-from-s3
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3)
@@ -510,7 +477,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | FormDefinitionID Form definition ID Path | FormDefinitionID | **String** | True | FormDefinitionID Form definition ID
Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
**System.IO.FileInfo** **System.IO.FileInfo**
@@ -535,15 +501,14 @@ Code | Description | Data Type
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download definition file by fileId. # Download definition file by fileId.
try { try {
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -552,9 +517,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-form-definition-by-key ## get-form-definition-by-key
:::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.
:::
Parameter `{formDefinitionID}` should match a form definition ID. Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key)
@@ -563,7 +525,6 @@ Parameter `{formDefinitionID}` should match a form definition ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | Form definition ID Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**FormDefinitionResponse**](../models/form-definition-response) [**FormDefinitionResponse**](../models/form-definition-response)
@@ -586,15 +547,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return a form definition. # Return a form definition.
try { try {
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -603,9 +563,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-form-instance-by-key ## get-form-instance-by-key
:::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.
:::
Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key)
@@ -614,7 +571,6 @@ Parameter `{formInstanceID}` should match a form instance ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormInstanceID | **String** | True | Form instance ID Path | FormInstanceID | **String** | True | Form instance ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**FormInstanceResponse**](../models/form-instance-response) [**FormInstanceResponse**](../models/form-instance-response)
@@ -637,15 +593,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Returns a form instance. # Returns a form instance.
try { try {
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -654,9 +609,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## get-form-instance-file ## get-form-instance-file
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file) [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file)
@@ -666,7 +618,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID
Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
**System.IO.FileInfo** **System.IO.FileInfo**
@@ -691,15 +642,14 @@ Code | Description | Data Type
```powershell ```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download instance file by fileId. # Download instance file by fileId.
try { try {
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -708,9 +658,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## import-form-definitions ## import-form-definitions
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions) [API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions)
@@ -718,7 +665,6 @@ This API is currently in an experimental state. The API is subject to change bas
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions
### Return type ### Return type
@@ -740,7 +686,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
@@ -753,10 +698,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Import form definitions from export. # Import form definitions from export.
try { try {
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental Import-V2024FormDefinitions
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result # Import-V2024FormDefinitions -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -765,9 +710,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## patch-form-definition ## patch-form-definition
:::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.
:::
Parameter `{formDefinitionID}` should match a form definition ID. Parameter `{formDefinitionID}` should match a form definition ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition) [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition)
@@ -776,7 +718,6 @@ Parameter `{formDefinitionID}` should match a form definition ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | Form definition ID Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com
### Return type ### Return type
@@ -800,7 +741,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) $Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
@@ -808,10 +748,10 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form definition. # Patch a form definition.
try { try {
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -820,9 +760,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## patch-form-instance ## patch-form-instance
:::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.
:::
Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formInstanceID}` should match a form instance ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance) [API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance)
@@ -831,7 +768,6 @@ Parameter `{formInstanceID}` should match a form instance ID.
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormInstanceID | **String** | True | Form instance ID Path | FormInstanceID | **String** | True | Form instance ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com
### Return type ### Return type
@@ -856,7 +792,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
@@ -864,10 +799,10 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
# Patch a form instance. # Patch a form instance.
try { try {
Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental Update-V2024FormInstance -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result # Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -876,9 +811,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## search-form-definitions-by-tenant ## search-form-definitions-by-tenant
:::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.
:::
No parameters required. No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant) [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant)
@@ -886,7 +818,6 @@ No parameters required.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in*
@@ -911,7 +842,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'name sw "my form"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) $Filters = 'name sw "my form"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -920,10 +850,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Export form definitions by tenant. # Export form definitions by tenant.
try { try {
Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental Search-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters # Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -932,9 +862,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## search-form-element-data-by-element-id ## search-form-element-data-by-element-id
:::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.
:::
Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration. Parameter `{formElementID}` should match a form element ID at the data source configuration.
@@ -945,7 +872,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormInstanceID | **String** | True | Form instance ID Path | FormInstanceID | **String** | True | Form instance ID
Path | FormElementID | **String** | True | Form element ID Path | FormElementID | **String** | True | Form element ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")`
Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields.
@@ -972,7 +898,6 @@ Code | Description | Data Type
```powershell ```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$FormElementID = "1" # String | Form element ID $FormElementID = "1" # String | Form element ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = 'value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) $Filters = 'value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional)
$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -980,10 +905,10 @@ $Query = "support" # String | String that is passed to the underlying API to fil
# Retrieves dynamic data by element. # Retrieves dynamic data by element.
try { try {
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -992,9 +917,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## search-form-instances-by-tenant ## search-form-instances-by-tenant
:::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.
:::
No parameters required. No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant) [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant)
@@ -1002,7 +924,6 @@ No parameters required.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**ListFormInstancesByTenantResponse[]**](../models/list-form-instances-by-tenant-response) [**ListFormInstancesByTenantResponse[]**](../models/list-form-instances-by-tenant-response)
@@ -1023,15 +944,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List form instances by tenant. # List form instances by tenant.
try { try {
Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental Search-V2024FormInstancesByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental # Search-V2024FormInstancesByTenant
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -1040,9 +960,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## search-pre-defined-select-options ## search-pre-defined-select-options
:::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.
:::
No parameters required. No parameters required.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options) [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options)
@@ -1050,7 +967,6 @@ No parameters required.
### Parameters ### Parameters
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type ### Return type
[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) [**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response)
@@ -1071,15 +987,14 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List predefined select options. # List predefined select options.
try { try {
Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental Search-V2024PreDefinedSelectOptions
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental # Search-V2024PreDefinedSelectOptions
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -1088,9 +1003,6 @@ try {
[[Back to top]](#) [[Back to top]](#)
## show-preview-data-source ## show-preview-data-source
:::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.
:::
[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source) [API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source)
@@ -1099,7 +1011,6 @@ This API is currently in an experimental state. The API is subject to change bas
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | FormDefinitionID | **String** | True | Form definition ID Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | Limit | **Int64** | (optional) (default to 10) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. Query | Limit | **Int64** | (optional) (default to 10) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")`
Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields.
@@ -1126,7 +1037,6 @@ Code | Description | Data Type
### Example ### Example
```powershell ```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10)
$Filters = 'value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) $Filters = 'value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional)
$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -1145,10 +1055,10 @@ $FormElementPreviewRequest = @"{
# Preview form definition data source. # Preview form definition data source.
try { try {
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails

90
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -4150,7 +4150,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @" $Body = @"
{ {
"owner" : { "owner" : {
@@ -4268,10 +4267,10 @@
# Creates a form definition. # Creates a form definition.
try { try {
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental New-V2024FormDefinition
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormDefinition -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4282,7 +4281,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @" $Body = @"
{ {
"description" : "A description", "description" : "A description",
@@ -4298,10 +4296,10 @@
# Generate JSON Schema dynamically. # Generate JSON Schema dynamically.
try { try {
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental New-V2024FormDefinitionDynamicSchema
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormDefinitionDynamicSchema -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4313,16 +4311,15 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$File = # System.IO.FileInfo | File specifying the multipart $File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file. # Upload new form definition file.
try { try {
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4333,7 +4330,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @" $Body = @"
{ {
"formInput" : { "formInput" : {
@@ -4361,10 +4357,10 @@
# Creates a form instance. # Creates a form instance.
try { try {
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental New-V2024FormInstance
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result # New-V2024FormInstance -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4376,15 +4372,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Deletes a form definition. # Deletes a form definition.
try { try {
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4395,7 +4390,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) $Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -4404,10 +4398,10 @@
# List form definitions by tenant. # List form definitions by tenant.
try { try {
Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental Export-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters # Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4420,15 +4414,14 @@
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download definition file by fileId. # Download definition file by fileId.
try { try {
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4440,15 +4433,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return a form definition. # Return a form definition.
try { try {
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4460,15 +4452,14 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key
source: | source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Returns a form instance. # Returns a form instance.
try { try {
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4481,15 +4472,14 @@
source: | source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download instance file by fileId. # Download instance file by fileId.
try { try {
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4500,7 +4490,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
@@ -4513,10 +4502,10 @@
# Import form definitions from export. # Import form definitions from export.
try { try {
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental Import-V2024FormDefinitions
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result # Import-V2024FormDefinitions -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4528,7 +4517,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/description, value=test-description}]"@ $Body = @"[{op=replace, path=/description, value=test-description}]"@
@@ -4536,10 +4524,10 @@
# Patch a form definition. # Patch a form definition.
try { try {
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4551,7 +4539,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance
source: | source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
$Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@
@@ -4559,10 +4546,10 @@
# Patch a form instance. # Patch a form instance.
try { try {
Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental Update-V2024FormInstance -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result # Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4573,7 +4560,6 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) $Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -4582,10 +4568,10 @@
# Export form definitions by tenant. # Export form definitions by tenant.
try { try {
Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental Search-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters # Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4598,7 +4584,6 @@
source: | source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$FormElementID = "1" # String | Form element ID $FormElementID = "1" # String | Form element ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) $Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional)
$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -4606,10 +4591,10 @@
# Retrieves dynamic data by element. # Retrieves dynamic data by element.
try { try {
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4620,15 +4605,14 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List form instances by tenant. # List form instances by tenant.
try { try {
Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental Search-V2024FormInstancesByTenant
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental # Search-V2024FormInstancesByTenant
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4639,15 +4623,14 @@
- lang: PowerShell - lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options
source: | source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List predefined select options. # List predefined select options.
try { try {
Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental Search-V2024PreDefinedSelectOptions
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental # Search-V2024PreDefinedSelectOptions
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails
@@ -4659,7 +4642,6 @@
label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source
source: | source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10)
$Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) $Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional)
$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional)
@@ -4680,10 +4662,10 @@
# Preview form definition data source. # Preview form definition data source.
try { try {
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
} catch { } catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
Write-Host $_.ErrorDetails Write-Host $_.ErrorDetails