---
id: v2024-custom-forms
title: CustomForms
pagination_label: CustomForms
sidebar_label: CustomForms
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CustomForms', 'V2024CustomForms'] 
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.

Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form.

Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value.

Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud.
 
  

All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*

Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2024FormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition.
[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically.
[**New-V2024FormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file.
[**New-V2024FormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance.
[**Remove-V2024FormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition.
[**Export-V2024FormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant.
[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId.
[**Get-V2024FormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition.
[**Get-V2024FormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance.
[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId.
[**Import-V2024FormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export.
[**Update-V2024FormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition.
[**Update-V2024FormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance.
[**Search-V2024FormDefinitionsByTenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant.
[**Search-V2024FormElementDataByElementID**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element.
[**Search-V2024FormInstancesByTenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant.
[**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
------------- | ------------- | ------------- | ------------- | ------------- 
   | 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

### Return type

[**FormDefinitionResponse**](../models/form-definition-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
201 | Returns a new form definition | FormDefinitionResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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")
$Body = @"{
  "owner" : {
    "name" : "Grant Smith",
    "id" : "2c9180867624cbd7017642d8c8c81f67",
    "type" : "IDENTITY"
  },
  "formConditions" : [ {
    "ruleOperator" : "AND",
    "effects" : [ {
      "config" : {
        "defaultValueLabel" : "Access to Remove",
        "element" : "8110662963316867"
      },
      "effectType" : "HIDE"
    }, {
      "config" : {
        "defaultValueLabel" : "Access to Remove",
        "element" : "8110662963316867"
      },
      "effectType" : "HIDE"
    } ],
    "rules" : [ {
      "sourceType" : "ELEMENT",
      "valueType" : "STRING",
      "source" : "department",
      "value" : "Engineering",
      "operator" : "EQ"
    }, {
      "sourceType" : "ELEMENT",
      "valueType" : "STRING",
      "source" : "department",
      "value" : "Engineering",
      "operator" : "EQ"
    } ]
  }, {
    "ruleOperator" : "AND",
    "effects" : [ {
      "config" : {
        "defaultValueLabel" : "Access to Remove",
        "element" : "8110662963316867"
      },
      "effectType" : "HIDE"
    }, {
      "config" : {
        "defaultValueLabel" : "Access to Remove",
        "element" : "8110662963316867"
      },
      "effectType" : "HIDE"
    } ],
    "rules" : [ {
      "sourceType" : "ELEMENT",
      "valueType" : "STRING",
      "source" : "department",
      "value" : "Engineering",
      "operator" : "EQ"
    }, {
      "sourceType" : "ELEMENT",
      "valueType" : "STRING",
      "source" : "department",
      "value" : "Engineering",
      "operator" : "EQ"
    } ]
  } ],
  "formInput" : [ {
    "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic",
    "id" : "00000000-0000-0000-0000-000000000000",
    "label" : "input1",
    "type" : "STRING"
  }, {
    "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic",
    "id" : "00000000-0000-0000-0000-000000000000",
    "label" : "input1",
    "type" : "STRING"
  } ],
  "name" : "My form",
  "description" : "My form description",
  "usedBy" : [ {
    "name" : "Access Request Form",
    "id" : "61940a92-5484-42bc-bc10-b9982b218cdf",
    "type" : "WORKFLOW"
  }, {
    "name" : "Access Request Form",
    "id" : "61940a92-5484-42bc-bc10-b9982b218cdf",
    "type" : "WORKFLOW"
  } ],
  "formElements" : [ {
    "id" : "00000000-0000-0000-0000-000000000000",
    "validations" : [ {
      "validationType" : "REQUIRED"
    }, {
      "validationType" : "REQUIRED"
    } ],
    "elementType" : "TEXT",
    "config" : {
      "label" : "Department"
    },
    "key" : "department"
  }, {
    "id" : "00000000-0000-0000-0000-000000000000",
    "validations" : [ {
      "validationType" : "REQUIRED"
    }, {
      "validationType" : "REQUIRED"
    } ],
    "elementType" : "TEXT",
    "config" : {
      "label" : "Department"
    },
    "key" : "department"
  } ]
}"@
# Creates a form definition.
try {
    New-V2024FormDefinition-V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## create-form-definition-dynamic-schema



### Parameters 
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

### Return type

[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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")
$Body = @"{
  "description" : "A description",
  "attributes" : {
    "formDefinitionId" : "00000000-0000-0000-0000-000000000000"
  },
  "id" : "00000000-0000-0000-0000-000000000000",
  "type" : "action",
  "versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
try {
    New-V2024FormDefinitionDynamicSchema-V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## create-form-definition-file-request

Parameter `{formDefinitionID}` should match a form definition ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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

### Return type

[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
201 | Returns a new form definition file | FormDefinitionFileUploadResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
413 | An error with payload size too large | SearchFormDefinitionsByTenant400Response
415 | An error with unsupported media type | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
503 | An external service is not available | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: multipart/form-data
- **Accept**: application/json

### Example
```powershell
$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 
    
    # Below is a request that includes all optional parameters
    # New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## create-form-instance



### Parameters 
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

### Return type

[**FormInstanceResponse**](../models/form-instance-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
201 | Returns a new form instance | FormInstanceResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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")
$Body = @"{
  "formInput" : {
    "input1" : "Sales"
  },
  "standAloneForm" : false,
  "createdBy" : {
    "id" : "00000000-0000-0000-0000-000000000000",
    "type" : "WORKFLOW_EXECUTION"
  },
  "recipients" : [ {
    "id" : "00000000-0000-0000-0000-000000000000",
    "type" : "IDENTITY"
  }, {
    "id" : "00000000-0000-0000-0000-000000000000",
    "type" : "IDENTITY"
  } ],
  "expire" : "2023-08-12T20:14:57.74486Z",
  "formDefinitionId" : "00000000-0000-0000-0000-000000000000",
  "state" : "ASSIGNED",
  "ttl" : 1571827560
}"@
# Creates a form instance.
try {
    New-V2024FormInstance-V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## delete-form-definition

Parameter `{formDefinitionID}` should match a form definition ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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
Code | Description  | Data Type
------------- | ------------- | -------------
204 | Returns an empty body | SystemCollectionsHashtable
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### Example
```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 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $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

No parameters required.

### Parameters 
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 | 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 | 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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a list of form definition objects by tenant used by SP-Config | ExportFormDefinitionsByTenant200ResponseInner[]
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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")
$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)
$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 
    
    # Below is a request that includes all optional parameters
    # Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## get-file-from-s3



### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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.
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

### Return type

**System.IO.FileInfo**

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | System.IO.FileInfo
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
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

### Example
```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.
$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 
    
    # Below is a request that includes all optional parameters
    # Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $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

Parameter `{formDefinitionID}` should match a form definition ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a form definition | FormDefinitionResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### Example
```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 
    
    # Below is a request that includes all optional parameters
    # Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $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

Parameter `{formInstanceID}` should match a form instance ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a form instance by its key | FormInstanceResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### Example
```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 
    
    # Below is a request that includes all optional parameters
    # Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## get-form-instance-file



### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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.
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.

### Return type

**System.IO.FileInfo**

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a file that is referred to by fileID and associated with the formInstanceID | System.IO.FileInfo
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response
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

### Example
```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.
$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 
    
    # Below is a request that includes all optional parameters
    # Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## import-form-definitions



### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
   | XSailPointExperimental | **String** | True  (default to "true") | Use this header to enable this experimental API.
 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
Code | Description  | Data Type
------------- | ------------- | -------------
202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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}}]"@ 

# Import form definitions from export.
try {
    Import-V2024FormDefinitions-V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## patch-form-definition

Parameter `{formDefinitionID}` should match a form definition ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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

### Return type

[**FormDefinitionResponse**](../models/form-definition-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns the form definition updated | FormDefinitionResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### Example
```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")
$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}]"@ 

# Patch a form definition.
try {
    Update-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## patch-form-instance

Parameter `{formInstanceID}` should match a form instance ID.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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

### Return type

[**FormInstanceResponse**](../models/form-instance-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns the form instance updated | FormInstanceResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
409 | An error with the request property conflicts with stored | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### Example
```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")
$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}}]"@ 

# Patch a form instance.
try {
    Update-V2024FormInstance-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## search-form-definitions-by-tenant

No parameters required.

### Parameters 
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 | 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 | 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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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")
$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)
$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 
    
    # Below is a request that includes all optional parameters
    # Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $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

Parameter `{formInstanceID}` should match a form instance ID.
Parameter `{formElementID}` should match a form element ID at the data source configuration.

### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
Path   | FormInstanceID | **String** | True  | Form instance 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 | 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.

### Return type

[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response)

### Responses
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### Example
```powershell
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance 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)
$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 
    
    # Below is a request that includes all optional parameters
    # Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $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

No parameters required.

### Parameters 
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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a list of form instances by tenant | ListFormInstancesByTenantResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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 
    
    # Below is a request that includes all optional parameters
    # Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $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

No parameters required.

### Parameters 
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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
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 
    
    # Below is a request that includes all optional parameters
    # Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#) 

## show-preview-data-source



### Parameters 
Param Type | Name | Data Type | Required  | Description
------------- | ------------- | ------------- | ------------- | ------------- 
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 | 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.
 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
Code | Description  | Data Type
------------- | ------------- | -------------
200 | Returns a preview of a form definition data source | PreviewDataSourceResponse
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response
404 | An error with the item not found | SearchFormDefinitionsByTenant400Response
429 | Too many requests | ModelError
500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### Example
```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")
$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)
$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)
$FormElementPreviewRequest = @"{
  "dataSource" : {
    "config" : {
      "indices" : [ "identities" ],
      "query" : "*",
      "aggregationBucketField" : "attributes.cloudStatus.exact",
      "objectType" : "IDENTITY"
    },
    "dataSourceType" : "STATIC"
  }
}"@
# Preview form definition data source.
try {
    Show-V2024PreviewDataSource-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource"
    Write-Host $_.ErrorDetails
}
```

[[Back to top]](#)