sailpoint.custom_forms.CustomFormsApi
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 for more information about using forms in Identity Security Cloud.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| create-form-definition-dynamic-schema-v1 | POST /form-definitions/v1/forms-action-dynamic-schema | Generate json schema dynamically. |
| create-form-definition-file-request-v1 | POST /form-definitions/v1/{formDefinitionID}/upload | Upload new form definition file. |
| create-form-definition-v1 | POST /form-definitions/v1 | Creates a form definition. |
| create-form-instance-v1 | POST /form-instances/v1 | Creates a form instance. |
| delete-form-definition-v1 | DELETE /form-definitions/v1/{formDefinitionID} | Deletes a form definition. |
| export-form-definitions-by-tenant-v1 | GET /form-definitions/v1/export | List form definitions by tenant. |
| get-file-from-s3-v1 | GET /form-definitions/v1/{formDefinitionID}/file/{fileID} | Download definition file by fileid. |
| get-form-definition-by-key-v1 | GET /form-definitions/v1/{formDefinitionID} | Return a form definition. |
| get-form-instance-by-key-v1 | GET /form-instances/v1/{formInstanceID} | Returns a form instance. |
| get-form-instance-file-v1 | GET /form-instances/v1/{formInstanceID}/file/{fileID} | Download instance file by fileid. |
| import-form-definitions-v1 | POST /form-definitions/v1/import | Import form definitions from export. |
| patch-form-definition-v1 | PATCH /form-definitions/v1/{formDefinitionID} | Patch a form definition. |
| patch-form-instance-v1 | PATCH /form-instances/v1/{formInstanceID} | Patch a form instance. |
| search-form-definitions-by-tenant-v1 | GET /form-definitions/v1 | Export form definitions by tenant. |
| search-form-element-data-by-element-idv1 | GET /form-instances/v1/{formInstanceID}/data-source/{formElementID} | Retrieves dynamic data by element. |
| search-form-instances-by-tenant-v1 | GET /form-instances/v1 | List form instances by tenant. |
| search-pre-defined-select-options-v1 | GET /form-definitions/v1/predefined-select-options | List predefined select options. |
| show-preview-data-source-v1 | POST /form-definitions/v1/{formDefinitionID}/data-source | Preview form definition data source. |
create-form-definition-dynamic-schema-v1
Generate json schema dynamically.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | body | Formdefinitiondynamicschemarequest | (optional) | Body is the request payload to create a form definition dynamic schema |
Return type
Formdefinitiondynamicschemaresponse
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a form elements dynamic schema | Formdefinitiondynamicschemaresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.formdefinitiondynamicschemarequest import Formdefinitiondynamicschemarequest
from sailpoint.custom_forms.models.formdefinitiondynamicschemaresponse import Formdefinitiondynamicschemaresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = '''{"id":"sp:forms","attributes":{"formDefinitionId":"00000000-0000-0000-0000-000000000000"},"description":"AnotherDescription","type":"action","versionNumber":1}''' # Formdefinitiondynamicschemarequest | Body is the request payload to create a form definition dynamic schema (optional)
try:
# Generate json schema dynamically.
results = CustomFormsApi(api_client).create_form_definition_dynamic_schema_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema_v1(new_body)
print("The response of CustomFormsApi->create_form_definition_dynamic_schema_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema_v1: %s\n" % e)
create-form-definition-file-request-v1
Upload new form definition file.
Parameter {formDefinitionID} should match a form definition ID.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | FormDefinitionID String specifying FormDefinitionID |
| file | bytearray | True | File specifying the multipart |
Return type
Formdefinitionfileuploadresponse
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 201 | Returns a new form definition file | Formdefinitionfileuploadresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 413 | An error with payload size too large | SearchFormDefinitionsByTenantV1400Response | - |
| 415 | An error with unsupported media type | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 503 | An external service is not available | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.formdefinitionfileuploadresponse import Formdefinitionfileuploadresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID
file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart
try:
# Upload new form definition file.
results = CustomFormsApi(api_client).create_form_definition_file_request_v1(form_definition_id=form_definition_id, file=file)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_file_request_v1(form_definition_id, file)
print("The response of CustomFormsApi->create_form_definition_file_request_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_file_request_v1: %s\n" % e)
create-form-definition-v1
Creates a form definition.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | body | Createformdefinitionrequest | (optional) | Body is the request payload to create form definition request |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 201 | Returns a new form definition | Formdefinitionresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.createformdefinitionrequest import Createformdefinitionrequest
from sailpoint.custom_forms.models.formdefinitionresponse import Formdefinitionresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = '''{"name":"my form","description":"my form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"},"formElements":[{"id":"000000000000","elementType":"SECTION","config":{"alignment":"LEFT","description":"elementType must be 'SECTION' for the root formElements, child formElements must be within the 'config' attribute","label":"Section","labelStyle":"h2","showLabel":true,"formElements":[{"id":"0000000000000","key":"textField","elementType":"TEXT","config":{"default":"","description":"","helpText":"form element type text","label":"Text Field","placeholder":"","required":false},"validations":[]}]}}]}''' # Createformdefinitionrequest | Body is the request payload to create form definition request (optional)
try:
# Creates a form definition.
results = CustomFormsApi(api_client).create_form_definition_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_v1(new_body)
print("The response of CustomFormsApi->create_form_definition_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_v1: %s\n" % e)
create-form-instance-v1
Creates a form instance.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | body | Createforminstancerequest | (optional) | Body is the request payload to create a form instance |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 201 | Returns a new form instance | Forminstanceresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.createforminstancerequest import Createforminstancerequest
from sailpoint.custom_forms.models.forminstanceresponse import Forminstanceresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = '''{"expire":"2023-06-20T15:57:55.332882Z","formDefinitionId":"00000000-0000-0000-0000-000000000000","recipients":[{"type":"IDENTITY","id":"an-identity-id"}],"createdBy":{"type":"WORKFLOW_EXECUTION","id":"a-workflow-execution-id"}}''' # Createforminstancerequest | Body is the request payload to create a form instance (optional)
try:
# Creates a form instance.
results = CustomFormsApi(api_client).create_form_instance_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_instance_v1(new_body)
print("The response of CustomFormsApi->create_form_instance_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_instance_v1: %s\n" % e)
delete-form-definition-v1
Deletes a form definition.
Parameter {formDefinitionID} should match a form definition ID.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | Form definition ID |
Return type
object
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 204 | Returns an empty body | object | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Deletes a form definition.
results = CustomFormsApi(api_client).delete_form_definition_v1(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).delete_form_definition_v1(form_definition_id)
print("The response of CustomFormsApi->delete_form_definition_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->delete_form_definition_v1: %s\n" % e)
export-form-definitions-by-tenant-v1
List form definitions by tenant. No parameters required.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Query | offset | int | (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. The offset value is record-based, not page-based, and the index starts at 0. |
| Query | limit | int | (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. If it is not specified, a default limit is used. |
| Query | filters | str | (optional) | Filter results using the standard syntax described in V3 API Standard Collection Parameters 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 | str | (optional) (default to 'name') | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, description, created, modified |
Return type
List[ExportFormDefinitionsByTenantV1200ResponseInner]
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a list of form definition objects by tenant used by SP-Config | List[ExportFormDefinitionsByTenantV1200ResponseInner] | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.export_form_definitions_by_tenant_v1200_response_inner import ExportFormDefinitionsByTenantV1200ResponseInner
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | 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) # int | 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 # int | 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) # int | 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\"' # str | 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) # str | 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' # str | 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') # str | 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')
try:
# List form definitions by tenant.
results = CustomFormsApi(api_client).export_form_definitions_by_tenant_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).export_form_definitions_by_tenant_v1(offset, limit, filters, sorters)
print("The response of CustomFormsApi->export_form_definitions_by_tenant_v1:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant_v1: %s\n" % e)
get-file-from-s3-v1
Download definition file by fileid.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | FormDefinitionID Form definition ID |
| Path | file_id | str | True | FileID String specifying the hashed name of the uploaded file we are retrieving. |
Return type
bytearray
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | bytearray | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 503 | An external service is not available | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, image/jpeg, image/png, application/octet-stream
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
try:
# Download definition file by fileid.
results = CustomFormsApi(api_client).get_file_from_s3_v1(form_definition_id=form_definition_id, file_id=file_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_file_from_s3_v1(form_definition_id, file_id)
print("The response of CustomFormsApi->get_file_from_s3_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_file_from_s3_v1: %s\n" % e)
get-form-definition-by-key-v1
Return a form definition.
Parameter {formDefinitionID} should match a form definition ID.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | Form definition ID |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a form definition | Formdefinitionresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.formdefinitionresponse import Formdefinitionresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Return a form definition.
results = CustomFormsApi(api_client).get_form_definition_by_key_v1(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_definition_by_key_v1(form_definition_id)
print("The response of CustomFormsApi->get_form_definition_by_key_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_definition_by_key_v1: %s\n" % e)
get-form-instance-by-key-v1
Returns a form instance.
Parameter {formInstanceID} should match a form instance ID.
Only the assigned recipient (recipients[].id when type is IDENTITY) may call this.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_instance_id | str | True | Form instance ID |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a form instance by its key | Forminstanceresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.forminstanceresponse import Forminstanceresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
try:
# Returns a form instance.
results = CustomFormsApi(api_client).get_form_instance_by_key_v1(form_instance_id=form_instance_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_by_key_v1(form_instance_id)
print("The response of CustomFormsApi->get_form_instance_by_key_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_by_key_v1: %s\n" % e)
get-form-instance-file-v1
Download instance file by fileid.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_instance_id | str | True | FormInstanceID Form instance ID |
| Path | file_id | str | True | FileID String specifying the hashed name of the uploaded file we are retrieving. |
Return type
bytearray
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a file that is referred to by fileID and associated with the formInstanceID | bytearray | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 503 | An external service is not available | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, image/jpeg, image/png, application/octet-stream
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
try:
# Download instance file by fileid.
results = CustomFormsApi(api_client).get_form_instance_file_v1(form_instance_id=form_instance_id, file_id=file_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_file_v1(form_instance_id, file_id)
print("The response of CustomFormsApi->get_form_instance_file_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_file_v1: %s\n" % e)
import-form-definitions-v1
Import form definitions from export.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Body | body | []ImportFormDefinitionsV1RequestInner | (optional) | Body is the request payload to import form definitions |
Return type
ImportFormDefinitionsV1202Response
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 202 | Returns statuses of those form definition objects imported | ImportFormDefinitionsV1202Response | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.import_form_definitions_v1202_response import ImportFormDefinitionsV1202Response
from sailpoint.custom_forms.models.import_form_definitions_v1_request_inner import ImportFormDefinitionsV1RequestInner
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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"}}]''' # List[ImportFormDefinitionsV1RequestInner] | Body is the request payload to import form definitions (optional)
try:
# Import form definitions from export.
results = CustomFormsApi(api_client).import_form_definitions_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).import_form_definitions_v1(new_body)
print("The response of CustomFormsApi->import_form_definitions_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->import_form_definitions_v1: %s\n" % e)
patch-form-definition-v1
Patch a form definition.
Parameter {formDefinitionID} should match a form definition ID.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | Form definition ID |
| Body | body | []Dict[str, object] | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns the form definition updated | Formdefinitionresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.formdefinitionresponse import Formdefinitionresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
body = '''[{"op":"replace","path":"/description","value":"test-description"}]''' # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
try:
# Patch a form definition.
results = CustomFormsApi(api_client).patch_form_definition_v1(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_definition_v1(form_definition_id, new_body)
print("The response of CustomFormsApi->patch_form_definition_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_definition_v1: %s\n" % e)
patch-form-instance-v1
Patch a form instance.
Parameter {formInstanceID} should match a form instance ID.
Only the assigned recipient (recipients[].id when type is IDENTITY) may call this.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_instance_id | str | True | Form instance ID |
| Body | body | []Dict[str, object] | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns the form instance updated | Forminstanceresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 409 | An error with the request property conflicts with stored | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.forminstanceresponse import Forminstanceresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
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}}]''' # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
try:
# Patch a form instance.
results = CustomFormsApi(api_client).patch_form_instance_v1(form_instance_id=form_instance_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_instance_v1(form_instance_id, new_body)
print("The response of CustomFormsApi->patch_form_instance_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_instance_v1: %s\n" % e)
search-form-definitions-by-tenant-v1
Export form definitions by tenant. No parameters required.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Query | offset | int | (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. The offset value is record-based, not page-based, and the index starts at 0. |
| Query | limit | int | (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. If it is not specified, a default limit is used. |
| Query | filters | str | (optional) | Filter results using the standard syntax described in V3 API Standard Collection Parameters 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 | str | (optional) (default to 'name') | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, description, created, modified |
Return type
Listformdefinitionsbytenantresponse
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a list of form definitions by tenant | Listformdefinitionsbytenantresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.listformdefinitionsbytenantresponse import Listformdefinitionsbytenantresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | 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) # int | 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 # int | 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) # int | 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\"' # str | 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) # str | 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' # str | 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') # str | 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')
try:
# Export form definitions by tenant.
results = CustomFormsApi(api_client).search_form_definitions_by_tenant_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_definitions_by_tenant_v1(offset, limit, filters, sorters)
print("The response of CustomFormsApi->search_form_definitions_by_tenant_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant_v1: %s\n" % e)
search-form-element-data-by-element-idv1
Retrieves dynamic data by element.
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 | form_instance_id | str | True | Form instance ID |
| Path | form_element_id | str | True | Form element ID |
| Query | limit | int | (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. If it is not specified, a default limit is used. |
| Query | filters | str | (optional) | Filter results using the standard syntax described in V3 API Standard Collection Parameters 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 | str | (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
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 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 | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.listformelementdatabyelementidresponse import Listformelementdatabyelementidresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
form_element_id = '1' # str | Form element ID # str | Form element ID
limit = 250 # int | 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) # int | 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\"' # str | 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) # str | 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' # str | 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) # str | 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)
try:
# Retrieves dynamic data by element.
results = CustomFormsApi(api_client).search_form_element_data_by_element_idv1(form_instance_id=form_instance_id, form_element_id=form_element_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_element_data_by_element_idv1(form_instance_id, form_element_id, limit, filters, query)
print("The response of CustomFormsApi->search_form_element_data_by_element_idv1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_element_data_by_element_idv1: %s\n" % e)
search-form-instances-by-tenant-v1
List form instances by tenant. Returns a list of form instances for the tenant. Optionally filter by form definition ID.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Query | offset | int | (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. The offset value is record-based, not page-based, and the index starts at 0. |
| Query | limit | int | (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. If it is not specified, a default limit is used. |
| Query | filters | str | (optional) | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: formDefinitionId: eq |
Return type
List[Listforminstancesbytenantresponse]
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a list of form instances by tenant | List[Listforminstancesbytenantresponse] | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests. The list form instances operation is limited to 50 requests per 10 seconds per tenant; reduce call frequency or wait before retrying. | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.listforminstancesbytenantresponse import Listforminstancesbytenantresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | 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) # int | 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 # int | 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) # int | 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 = 'formDefinitionId eq \"351c1daa-56f6-4bbf-b32c-49844c0b716e\"' # str | 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: **formDefinitionId**: *eq* (optional) # str | 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: **formDefinitionId**: *eq* (optional)
try:
# List form instances by tenant.
results = CustomFormsApi(api_client).search_form_instances_by_tenant_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_instances_by_tenant_v1(offset, limit, filters)
print("The response of CustomFormsApi->search_form_instances_by_tenant_v1:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_instances_by_tenant_v1: %s\n" % e)
search-pre-defined-select-options-v1
List predefined select options. No parameters required.
Parameters
This endpoint does not need any parameter.
Return type
Listpredefinedselectoptionsresponse
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a list of available predefined select options | Listpredefinedselectoptionsresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.listpredefinedselectoptionsresponse import Listpredefinedselectoptionsresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List predefined select options.
results = CustomFormsApi(api_client).search_pre_defined_select_options_v1()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_pre_defined_select_options_v1()
print("The response of CustomFormsApi->search_pre_defined_select_options_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_pre_defined_select_options_v1: %s\n" % e)
show-preview-data-source-v1
Preview form definition data source.
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|---|---|---|---|
| Path | form_definition_id | str | True | Form definition ID |
| Query | limit | int | (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. If it is not specified, a default limit is used. |
| Query | filters | str | (optional) | Filter results using the standard syntax described in V3 API Standard Collection Parameters 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 | str | (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 | (optional) | Body is the request payload to create a form definition dynamic schema |
Return type
Responses
| Code | Description | Data Type | Response headers |
|---|---|---|---|
| 200 | Returns a preview of a form definition data source | Previewdatasourceresponse | - |
| 400 | An error with the request occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 401 | An error with the authorization occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 403 | An error with the user permissions occurred | SearchFormDefinitionsByTenantV1400Response | - |
| 404 | An error with the item not found | SearchFormDefinitionsByTenantV1400Response | - |
| 429 | Too many requests | Error | - |
| 500 | An internal server error occurred | SearchFormDefinitionsByTenantV1400Response | - |
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.custom_forms.api.custom_forms_api import CustomFormsApi
from sailpoint.custom_forms.api_client import ApiClient
from sailpoint.custom_forms.models.formelementpreviewrequest import Formelementpreviewrequest
from sailpoint.custom_forms.models.previewdatasourceresponse import Previewdatasourceresponse
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
limit = 10 # int | 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) # int | 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\"' # str | 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) # str | 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' # str | 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) # str | 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 = '''sailpoint.custom_forms.Formelementpreviewrequest()''' # Formelementpreviewrequest | Body is the request payload to create a form definition dynamic schema (optional)
try:
# Preview form definition data source.
results = CustomFormsApi(api_client).show_preview_data_source_v1(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).show_preview_data_source_v1(form_definition_id, limit, filters, query, new_formelementpreviewrequest)
print("The response of CustomFormsApi->show_preview_data_source_v1:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->show_preview_data_source_v1: %s\n" % e)