sailpoint.v2024.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/v2024

Method	HTTP request	Description
create-form-definition	POST /form-definitions	Creates a form definition.
create-form-definition-dynamic-schema	POST /form-definitions/forms-action-dynamic-schema	Generate JSON Schema dynamically.
create-form-definition-file-request	POST /form-definitions/{formDefinitionID}/upload	Upload new form definition file.
create-form-instance	POST /form-instances	Creates a form instance.
delete-form-definition	DELETE /form-definitions/{formDefinitionID}	Deletes a form definition.
export-form-definitions-by-tenant	GET /form-definitions/export	List form definitions by tenant.
get-file-from-s3	GET /form-definitions/{formDefinitionID}/file/{fileID}	Download definition file by fileId.
get-form-definition-by-key	GET /form-definitions/{formDefinitionID}	Return a form definition.
get-form-instance-by-key	GET /form-instances/{formInstanceID}	Returns a form instance.
get-form-instance-file	GET /form-instances/{formInstanceID}/file/{fileID}	Download instance file by fileId.
import-form-definitions	POST /form-definitions/import	Import form definitions from export.
patch-form-definition	PATCH /form-definitions/{formDefinitionID}	Patch a form definition.
patch-form-instance	PATCH /form-instances/{formInstanceID}	Patch a form instance.
search-form-definitions-by-tenant	GET /form-definitions	Export form definitions by tenant.
search-form-element-data-by-element-id	GET /form-instances/{formInstanceID}/data-source/{formElementID}	Retrieves dynamic data by element.
search-form-instances-by-tenant	GET /form-instances	List form instances by tenant.
search-pre-defined-select-options	GET /form-definitions/predefined-select-options	List predefined select options.
show-preview-data-source	POST /form-definitions/{formDefinitionID}/data-source	Preview form definition data source.

create-form-definition

Creates a form definition.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	body	CreateFormDefinitionRequest	(optional)	Body is the request payload to create form definition request

Return type

FormDefinitionResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_form_definition_request import CreateFormDefinitionRequest
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    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"
          } ]
        }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)

    try:
        # Creates a form definition.
        
        results = CustomFormsApi(api_client).create_form_definition()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).create_form_definition(new_body)
        print("The response of CustomFormsApi->create_form_definition:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e)

[Back to top]

create-form-definition-dynamic-schema

Generate JSON Schema dynamically.

API Spec

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	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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest
from sailpoint.v2024.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    body = '''{
          "description" : "A description",
          "attributes" : {
            "formDefinitionId" : "00000000-0000-0000-0000-000000000000"
          },
          "id" : "00000000-0000-0000-0000-000000000000",
          "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()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body)
        print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\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: %s\n" % e)

[Back to top]

create-form-definition-file-request

Upload new form definition file. Parameter {formDefinitionID} should match a form definition ID.

API Spec

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	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	Error	-
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

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_file_upload_response 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(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(form_definition_id, file)
        print("The response of CustomFormsApi->create_form_definition_file_request:\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: %s\n" % e)

[Back to top]

create-form-instance

Creates a form instance.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	body	CreateFormInstanceRequest	(optional)	Body is the request payload to create a form instance

Return type

FormInstanceResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.create_form_instance_request import CreateFormInstanceRequest
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    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
        }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional)

    try:
        # Creates a form instance.
        
        results = CustomFormsApi(api_client).create_form_instance()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).create_form_instance(new_body)
        print("The response of CustomFormsApi->create_form_instance:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e)

[Back to top]

delete-form-definition

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

API Spec

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	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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.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(form_definition_id=form_definition_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id)
        print("The response of CustomFormsApi->delete_form_definition:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e)

[Back to top]

export-form-definitions-by-tenant

List form definitions by tenant. No parameters required.

API Spec

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[ExportFormDefinitionsByTenant200ResponseInner]

Responses

Code	Description	Data Type	Response headers
200	Returns a list of form definition objects by tenant used by SP-Config	List[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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
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()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters)
        print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e)

[Back to top]

get-file-from-s3

Download definition file by fileId.

API Spec

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	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	Error	-
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

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.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(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(form_definition_id, file_id)
        print("The response of CustomFormsApi->get_file_from_s3:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e)

[Back to top]

get-form-definition-by-key

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	form_definition_id	str	True	Form definition ID

Return type

FormDefinitionResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_response 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(form_definition_id=form_definition_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
        print("The response of CustomFormsApi->get_form_definition_by_key:\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: %s\n" % e)

[Back to top]

get-form-instance-by-key

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	form_instance_id	str	True	Form instance ID

Return type

FormInstanceResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_instance_response 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(form_instance_id=form_instance_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
        print("The response of CustomFormsApi->get_form_instance_by_key:\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: %s\n" % e)

[Back to top]

get-form-instance-file

Download instance file by fileId.

API Spec

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	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	Error	-
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

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.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(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(form_instance_id, file_id)
        print("The response of CustomFormsApi->get_form_instance_file:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e)

[Back to top]

import-form-definitions

Import form definitions from export.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	body	[]ImportFormDefinitionsRequestInner	(optional)	Body is the request payload to import form definitions

Return type

ImportFormDefinitions202Response

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.import_form_definitions202_response import ImportFormDefinitions202Response
from sailpoint.v2024.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner
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[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional)

    try:
        # Import form definitions from export.
        
        results = CustomFormsApi(api_client).import_form_definitions()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).import_form_definitions(new_body)
        print("The response of CustomFormsApi->import_form_definitions:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e)

[Back to top]

patch-form-definition

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

API Spec

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

FormDefinitionResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_definition_response 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(form_definition_id=form_definition_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body)
        print("The response of CustomFormsApi->patch_form_definition:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e)

[Back to top]

patch-form-instance

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

API Spec

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

FormInstanceResponse

Responses

Code	Description	Data Type	Response headers
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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_instance_response 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(form_instance_id=form_instance_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body)
        print("The response of CustomFormsApi->patch_form_instance:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e)

[Back to top]

search-form-definitions-by-tenant

Export form definitions by tenant. No parameters required.

API Spec

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	SearchFormDefinitionsByTenant400Response	-
401	An error with the authorization occurred	SearchFormDefinitionsByTenant400Response	-
403	An error with the user permissions occurred	SearchFormDefinitionsByTenant400Response	-
429	Too many requests	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_definitions_by_tenant_response 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()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters)
        print("The response of CustomFormsApi->search_form_definitions_by_tenant:\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: %s\n" % e)

[Back to top]

search-form-element-data-by-element-id

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.

API Spec

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	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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_element_data_by_element_id_response 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_id(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_id(form_instance_id, form_element_id, limit, filters, query)
        print("The response of CustomFormsApi->search_form_element_data_by_element_id:\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_id: %s\n" % e)

[Back to top]

search-form-instances-by-tenant

List form instances by tenant. No parameters required.

API Spec

Parameters

This endpoint does not need any parameter.

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	SearchFormDefinitionsByTenant400Response	-
401	An error with the authorization occurred	SearchFormDefinitionsByTenant400Response	-
403	An error with the user permissions occurred	SearchFormDefinitionsByTenant400Response	-
429	Too many requests	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # List form instances by tenant.
        
        results = CustomFormsApi(api_client).search_form_instances_by_tenant()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).search_form_instances_by_tenant()
        print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e)

[Back to top]

search-pre-defined-select-options

List predefined select options. No parameters required.

API Spec

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	SearchFormDefinitionsByTenant400Response	-
401	An error with the authorization occurred	SearchFormDefinitionsByTenant400Response	-
403	An error with the user permissions occurred	SearchFormDefinitionsByTenant400Response	-
429	Too many requests	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_predefined_select_options_response 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()
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).search_pre_defined_select_options()
        print("The response of CustomFormsApi->search_pre_defined_select_options:\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: %s\n" % e)

[Back to top]

show-preview-data-source

Preview form definition data source.

API Spec

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	form_element_preview_request	FormElementPreviewRequest	(optional)	Body is the request payload to create a form definition dynamic schema

Return type

PreviewDataSourceResponse

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	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	Error	-
500	An internal server error occurred	SearchFormDefinitionsByTenant400Response	-

HTTP request headers

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

Example

from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.form_element_preview_request import FormElementPreviewRequest
from sailpoint.v2024.models.preview_data_source_response 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)
    form_element_preview_request = '''{
          "dataSource" : {
            "config" : {
              "indices" : [ "identities" ],
              "query" : "*",
              "aggregationBucketField" : "attributes.cloudStatus.exact",
              "objectType" : "IDENTITY"
            },
            "dataSourceType" : "STATIC"
          }
        }''' # 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(form_definition_id=form_definition_id)
        # Below is a request that includes all optional parameters
        # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request)
        print("The response of CustomFormsApi->show_preview_data_source:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e)

[Back to top]