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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
---
id: v2024-custom-forms
title: CustomForms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/custom-forms
tags: ['SDK', 'Software Development Kit', 'CustomForms', 'V2024CustomForms']
---
# CustomForms
Use this API to build and manage custom forms.
With this functionality in place, administrators can create and view form definitions and form instances.
@@ -45,11 +45,9 @@ 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
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -57,7 +55,6 @@ Param Type | Name | Data Type | Required | Description
Body | Body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -71,7 +68,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -189,7 +185,9 @@ $Body = @"{
"key" : "department"
} ]
}"@
# Creates a form definition.
try {
New-V2024FormDefinition-V2024XSailPointExperimental $XSailPointExperimental
@@ -200,13 +198,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-dynamic-schema
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -214,7 +209,6 @@ Param Type | Name | Data Type | Required | Description
Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema
### Return type
[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response)
### Responses
@@ -229,7 +223,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -245,7 +238,9 @@ $Body = @"{
"type" : "action",
"versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
try {
New-V2024FormDefinitionDynamicSchema-V2024XSailPointExperimental $XSailPointExperimental
@@ -256,11 +251,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-file-request
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -271,7 +263,6 @@ Path | FormDefinitionID | **String** | True | FormDefinitionID String specif
| File | **System.IO.FileInfo** | True | File specifying the multipart
### Return type
[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response)
### Responses
@@ -289,7 +280,6 @@ Code | Description | Data Type
503 | An external service is not available | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -298,7 +288,9 @@ Code | Description | Data Type
$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
# Upload new form definition file.
try {
New-V2024FormDefinitionFileRequest-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File
@@ -309,13 +301,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-instance
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -323,7 +312,6 @@ Param Type | Name | Data Type | Required | Description
Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -337,7 +325,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -365,7 +352,9 @@ $Body = @"{
"state" : "ASSIGNED",
"ttl" : 1571827560
}"@
# Creates a form instance.
try {
New-V2024FormInstance-V2024XSailPointExperimental $XSailPointExperimental
@@ -376,11 +365,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -390,7 +376,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -405,7 +390,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -413,7 +397,9 @@ Code | Description | Data Type
```powershell
$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.
try {
Remove-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
@@ -424,11 +410,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -441,7 +424,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified**
### Return type
[**ExportFormDefinitionsByTenant200ResponseInner[]**](../models/export-form-definitions-by-tenant200-response-inner)
### Responses
@@ -455,7 +437,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -466,7 +447,9 @@ $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result
$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)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name")
# List form definitions by tenant.
try {
Export-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental
@@ -477,13 +460,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-file-from-s3
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -492,7 +472,6 @@ Path | FileID | **String** | True | FileID String specifying the hashed name
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
**System.IO.FileInfo**
### Responses
@@ -508,7 +487,6 @@ Code | Description | Data Type
503 | An external service is not available | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -517,7 +495,9 @@ Code | Description | Data Type
$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.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download definition file by fileId.
try {
Get-V2024FileFromS3-V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
@@ -528,11 +508,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-definition-by-key
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -542,7 +519,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -557,7 +533,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -565,7 +540,9 @@ Code | Description | Data Type
```powershell
$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.
try {
Get-V2024FormDefinitionByKey-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
@@ -576,11 +553,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-by-key
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -590,7 +564,6 @@ Path | FormInstanceID | **String** | True | Form instance ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -605,7 +578,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -613,7 +585,9 @@ Code | Description | Data Type
```powershell
$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.
try {
Get-V2024FormInstanceByKey-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
@@ -624,13 +598,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-file
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -639,7 +610,6 @@ Path | FileID | **String** | True | FileID String specifying the hashed name
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
**System.IO.FileInfo**
### Responses
@@ -655,7 +625,6 @@ Code | Description | Data Type
503 | An external service is not available | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -664,7 +633,9 @@ Code | Description | Data Type
$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.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Download instance file by fileId.
try {
Get-V2024FormInstanceFile-V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental
@@ -675,13 +646,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-form-definitions
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -689,7 +657,6 @@ Param Type | Name | Data Type | Required | Description
Body | Body | [**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) | (optional) | Body is the request payload to import form definitions
### Return type
[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response)
### Responses
@@ -703,17 +670,23 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# ExportFormDefinitionsByTenant200ResponseInner[] | Body is the request payload to import form definitions (optional)
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ExportFormDefinitionsByTenant200ResponseInner[] | Body is the request payload to import form definitions (optional)
# Import form definitions from export.
try {
Import-V2024FormDefinitions-V2024XSailPointExperimental $XSailPointExperimental
@@ -724,11 +697,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -739,7 +709,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
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
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -754,7 +723,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -763,9 +731,11 @@ Code | Description | Data Type
$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 = @"[{op=replace, path=/description, value=test-description}]"@
$Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
# Patch a form definition.
try {
Update-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
@@ -776,11 +746,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-instance
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -791,7 +758,6 @@ Path | FormInstanceID | **String** | True | Form instance ID
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
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -807,7 +773,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -816,9 +781,11 @@ Code | Description | Data Type
$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 = @"[{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}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
# Patch a form instance.
try {
Update-V2024FormInstance-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental
@@ -829,11 +796,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -846,7 +810,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified**
### Return type
[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response)
### Responses
@@ -860,7 +823,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -871,7 +833,9 @@ $Offset = 250 # Int64 | Offset Integer specifying the offset of the first resul
$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)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name")
# Export form definitions by tenant.
try {
Search-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental
@@ -882,11 +846,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-element-data-by-element-id
Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration.
@@ -901,7 +862,6 @@ Path | FormElementID | **String** | True | Form element ID
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.
### Return type
[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response)
### Responses
@@ -916,7 +876,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -928,7 +887,9 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$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)
$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)
# Retrieves dynamic data by element.
try {
Search-V2024FormElementDataByElementID-V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental
@@ -939,11 +900,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-instances-by-tenant
No parameters required.
### Parameters
@@ -952,7 +910,6 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**ListFormInstancesByTenantResponse**](../models/list-form-instances-by-tenant-response)
### Responses
@@ -966,14 +923,15 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List form instances by tenant.
try {
Search-V2024FormInstancesByTenant-V2024XSailPointExperimental $XSailPointExperimental
@@ -984,11 +942,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-pre-defined-select-options
No parameters required.
### Parameters
@@ -997,7 +952,6 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response)
### Responses
@@ -1011,14 +965,15 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List predefined select options.
try {
Search-V2024PreDefinedSelectOptions-V2024XSailPointExperimental $XSailPointExperimental
@@ -1029,13 +984,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-preview-data-source
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1047,7 +999,6 @@ Path | FormDefinitionID | **String** | True | Form definition ID
Body | FormElementPreviewRequest | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema
### Return type
[**PreviewDataSourceResponse**](../models/preview-data-source-response)
### Responses
@@ -1062,7 +1013,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1084,7 +1034,9 @@ $FormElementPreviewRequest = @"{
"dataSourceType" : "STATIC"
}
}"@
# Preview form definition data source.
try {
Show-V2024PreviewDataSource-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental
@@ -1095,7 +1047,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)