mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
Update to powershell SDK docs: 13207859154
This commit is contained in:
@@ -44,8 +44,14 @@ Method | HTTP request | Description
|
||||
[**Search-V2024PreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options.
|
||||
[**Show-V2024PreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source.
|
||||
|
||||
## 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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -188,18 +194,24 @@ $Body = @"{
|
||||
# Creates a form definition.
|
||||
|
||||
try {
|
||||
New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental
|
||||
New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -241,19 +253,25 @@ $Body = @"{
|
||||
# Generate JSON Schema dynamically.
|
||||
|
||||
try {
|
||||
New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental
|
||||
New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -291,18 +309,24 @@ $File = # System.IO.FileInfo | File specifying the multipart
|
||||
# Upload new form definition file.
|
||||
|
||||
try {
|
||||
New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File
|
||||
New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File
|
||||
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -355,19 +379,25 @@ $Body = @"{
|
||||
# Creates a form instance.
|
||||
|
||||
try {
|
||||
New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental
|
||||
New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -400,19 +430,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Deletes a form definition.
|
||||
|
||||
try {
|
||||
Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -450,18 +486,24 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
|
||||
# List form definitions by tenant.
|
||||
|
||||
try {
|
||||
Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters
|
||||
# Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -498,19 +540,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Download definition file by fileId.
|
||||
|
||||
try {
|
||||
Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -543,19 +591,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Return a form definition.
|
||||
|
||||
try {
|
||||
Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -588,18 +642,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Returns a form instance.
|
||||
|
||||
try {
|
||||
Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -636,18 +696,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Download instance file by fileId.
|
||||
|
||||
try {
|
||||
Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -687,19 +753,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# Import form definitions from export.
|
||||
|
||||
try {
|
||||
Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -V2024Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -736,19 +808,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
|
||||
# Patch a form definition.
|
||||
|
||||
try {
|
||||
Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -786,19 +864,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for
|
||||
# Patch a form instance.
|
||||
|
||||
try {
|
||||
Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body
|
||||
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -836,20 +920,26 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
|
||||
# Export form definitions by tenant.
|
||||
|
||||
try {
|
||||
Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters
|
||||
# Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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 `{formElementID}` should match a form element ID at the data source configuration.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-element-data-by-element-id)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -890,19 +980,25 @@ $Query = "support" # String | String that is passed to the underlying API to fil
|
||||
# Retrieves dynamic data by element.
|
||||
|
||||
try {
|
||||
Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query
|
||||
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -932,19 +1028,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# List form instances by tenant.
|
||||
|
||||
try {
|
||||
Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## 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.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
@@ -974,18 +1076,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
# List predefined select options.
|
||||
|
||||
try {
|
||||
Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental
|
||||
# Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[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)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
@@ -1037,10 +1145,10 @@ $FormElementPreviewRequest = @"{
|
||||
# Preview form definition data source.
|
||||
|
||||
try {
|
||||
Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
|
||||
Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest
|
||||
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -V2024FormElementPreviewRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user