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

150
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-custom-forms
title: CustomForms
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/custom-forms
tags: ['SDK', 'Software Development Kit', 'CustomForms', 'BetaCustomForms']
---
# 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.
@@ -46,18 +46,15 @@ Method | HTTP request | Description
[**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options.
[**Show-BetaPreviewDataSource**](#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
------------- | ------------- | ------------- | ------------- | -------------
Body | CreateFormDefinitionRequest | [**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
@@ -188,7 +184,9 @@ $CreateFormDefinitionRequest = @"{
"key" : "department"
} ]
}"@
# Creates a form definition.
try {
New-BetaFormDefinition
@@ -199,20 +197,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-by-template
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | CreateFormDefinitionRequest | [**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
@@ -226,7 +220,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -343,7 +336,9 @@ $CreateFormDefinitionRequest = @"{
"key" : "department"
} ]
}"@
# Create a form definition by template.
try {
New-BetaFormDefinitionByTemplate
@@ -354,20 +349,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-dynamic-schema
### Parameters
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
@@ -382,7 +373,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -397,7 +387,9 @@ $Body = @"{
"type" : "action",
"versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
try {
New-BetaFormDefinitionDynamicSchema
@@ -408,11 +400,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-definition-file-request
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -422,7 +411,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
@@ -440,7 +428,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
@@ -448,7 +435,9 @@ Code | Description | Data Type
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID
$File = # System.IO.FileInfo | File specifying the multipart
# Upload new form definition file.
try {
New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File
@@ -459,20 +448,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-form-instance
### Parameters
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
@@ -486,7 +471,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -513,7 +497,9 @@ $Body = @"{
"state" : "ASSIGNED",
"ttl" : 1571827560
}"@
# Creates a form instance.
try {
New-BetaFormInstance
@@ -524,11 +510,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -537,7 +520,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormDefinitionID | **String** | True | Form definition ID
### Return type
[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0)
### Responses
@@ -552,14 +534,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Deletes a form definition.
try {
Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID
@@ -570,11 +553,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## export-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -586,7 +566,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
@@ -600,7 +579,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -610,7 +588,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-BetaFormDefinitionsByTenant
@@ -621,13 +601,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-file-from-s3
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -635,7 +612,6 @@ Path | FormDefinitionID | **String** | True | FormDefinitionID Form definiti
Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving.
### Return type
**System.IO.FileInfo**
### Responses
@@ -651,7 +627,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -659,7 +634,9 @@ Code | Description | Data Type
```powershell
$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.
# Download definition file by fileId.
try {
Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID
@@ -670,11 +647,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-definition-by-key
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -683,7 +657,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormDefinitionID | **String** | True | Form definition ID
### Return type
[**FormDefinitionResponse**](../models/form-definition-response)
### Responses
@@ -698,14 +671,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Return a form definition.
try {
Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID
@@ -716,11 +690,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-by-key
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -729,7 +700,6 @@ Param Type | Name | Data Type | Required | Description
Path | FormInstanceID | **String** | True | Form instance ID
### Return type
[**FormInstanceResponse**](../models/form-instance-response)
### Responses
@@ -744,14 +714,15 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
# Returns a form instance.
try {
Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID
@@ -762,13 +733,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-form-instance-file
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -776,7 +744,6 @@ 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.
### Return type
**System.IO.FileInfo**
### Responses
@@ -792,7 +759,6 @@ Code | Description | Data Type
503 | An external service is not available | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, image/jpeg, image/png, application/octet-stream
@@ -800,7 +766,9 @@ Code | Description | Data Type
```powershell
$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.
# Download instance file by fileId.
try {
Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID
@@ -811,20 +779,16 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## import-form-definitions
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions
### Return type
[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response)
### Responses
@@ -838,16 +802,22 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
# ImportFormDefinitionsRequestInner[] | 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}}]"@ # ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional)
# Import form definitions from export.
try {
Import-BetaFormDefinitions
@@ -858,11 +828,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-definition
Parameter `{formDefinitionID}` should match a form definition ID.
### Parameters
@@ -872,7 +839,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
@@ -887,7 +853,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -895,9 +860,11 @@ Code | Description | Data Type
```powershell
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
$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-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID
@@ -908,11 +875,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-form-instance
Parameter `{formInstanceID}` should match a form instance ID.
### Parameters
@@ -922,7 +886,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
@@ -938,7 +901,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -946,9 +908,11 @@ Code | Description | Data Type
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
$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-BetaFormInstance-BetaFormInstanceID $FormInstanceID
@@ -959,11 +923,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-definitions-by-tenant
No parameters required.
### Parameters
@@ -975,7 +936,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
@@ -989,7 +949,6 @@ Code | Description | Data Type
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -999,7 +958,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-BetaFormDefinitionsByTenant
@@ -1010,11 +971,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.
@@ -1028,7 +986,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
@@ -1043,7 +1000,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -1054,7 +1010,9 @@ $FormElementID = "1" # String | Form element ID
$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-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID
@@ -1065,11 +1023,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-form-instances-by-tenant
No parameters required.
### Parameters
@@ -1077,7 +1032,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**FormInstanceResponse[]**](../models/form-instance-response)
### Responses
@@ -1091,13 +1045,14 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List form instances by tenant.
try {
Search-BetaFormInstancesByTenant
@@ -1108,11 +1063,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## search-pre-defined-select-options
No parameters required.
### Parameters
@@ -1120,7 +1072,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response)
### Responses
@@ -1134,13 +1085,14 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
# List predefined select options.
try {
Search-BetaPreDefinedSelectOptions
@@ -1151,13 +1103,10 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## show-preview-data-source
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -1168,7 +1117,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
@@ -1183,7 +1131,6 @@ Code | Description | Data Type
500 | An internal server error occurred | GetFormDefinitionByKey400Response
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
@@ -1204,7 +1151,9 @@ $FormElementPreviewRequest = @"{
"dataSourceType" : "STATIC"
}
}"@
# Preview form definition data source.
try {
Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID
@@ -1215,7 +1164,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)