From e03dd527fbd2cb34d4422620c2802f8fbe2d2eca Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Wed, 26 Mar 2025 13:47:28 +0000 Subject: [PATCH] Update to python SDK docs: 14084891379 --- .../Reference/V2024/Methods/CustomFormsApi.md | 332 ++---------------- .../v2024/python_code_examples_overlay.yaml | 108 ++---- 2 files changed, 74 insertions(+), 366 deletions(-) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md index 91773ef3f..133dde49a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md @@ -44,17 +44,6 @@ Method | HTTP request | Description ## create-form-definition -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Creates a form definition. @@ -64,7 +53,6 @@ Creates a form definition. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request ### Return type @@ -94,10 +82,8 @@ from sailpoint.v2024.models.form_definition_response import FormDefinitionRespon from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "owner" : { "name" : "Grant Smith", @@ -213,9 +199,9 @@ with ApiClient(configuration) as api_client: try: # Creates a form definition. - results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).create_form_definition() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body) + # 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: @@ -227,17 +213,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## create-form-definition-dynamic-schema -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Generate JSON Schema dynamically. @@ -247,7 +222,6 @@ Generate JSON Schema dynamically. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema ### Return type @@ -278,10 +252,8 @@ from sailpoint.v2024.models.form_definition_dynamic_schema_response import FormD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "description" : "A description", "attributes" : { @@ -295,9 +267,9 @@ with ApiClient(configuration) as api_client: try: # Generate JSON Schema dynamically. - results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, new_body) + # 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: @@ -309,17 +281,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## create-form-definition-file-request -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Upload new form definition file. Parameter `{formDefinitionID}` should match a form definition ID. @@ -330,7 +291,6 @@ Parameter `{formDefinitionID}` should match a form definition ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_definition_id | **str** | True | FormDefinitionID String specifying FormDefinitionID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. | file | **bytearray** | True | File specifying the multipart ### Return type @@ -363,19 +323,17 @@ from sailpoint.v2024.models.form_definition_file_upload_response import FormDefi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental, file=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, x_sail_point_experimental, file) + # 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: @@ -387,17 +345,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## create-form-instance -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Creates a form instance. @@ -407,7 +354,6 @@ Creates a form instance. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance ### Return type @@ -437,10 +383,8 @@ from sailpoint.v2024.models.form_instance_response import FormInstanceResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "formInput" : { "input1" : "Sales" @@ -466,9 +410,9 @@ with ApiClient(configuration) as api_client: try: # Creates a form instance. - results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).create_form_instance() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body) + # 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: @@ -480,17 +424,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## delete-form-definition -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Deletes a form definition. Parameter `{formDefinitionID}` should match a form definition ID. @@ -501,7 +434,6 @@ Parameter `{formDefinitionID}` should match a form definition ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_definition_id | **str** | True | Form definition ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. ### Return type **object** @@ -529,18 +461,16 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Deletes a form definition. - results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -552,17 +482,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## export-form-definitions-by-tenant -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: List form definitions by tenant. No parameters required. @@ -572,7 +491,6 @@ No parameters required. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. Query | limit | **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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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](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* @@ -604,10 +522,8 @@ from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -616,9 +532,9 @@ with ApiClient(configuration) as api_client: try: # List form definitions by tenant. - results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, offset, limit, filters, sorters) + # 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: @@ -630,17 +546,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-file-from-s3 -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Download definition file by fileId. @@ -652,7 +557,6 @@ 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. - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. ### Return type **bytearray** @@ -681,19 +585,17 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true 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. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Download definition file by fileId. - results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -705,17 +607,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-form-definition-by-key -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Return a form definition. Parameter `{formDefinitionID}` should match a form definition ID. @@ -726,7 +617,6 @@ Parameter `{formDefinitionID}` should match a form definition ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_definition_id | **str** | True | Form definition ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. ### Return type [**FormDefinitionResponse**](../models/form-definition-response) @@ -755,18 +645,16 @@ from sailpoint.v2024.models.form_definition_response import FormDefinitionRespon from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Return a form definition. - results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -778,17 +666,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-form-instance-by-key -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Returns a form instance. Parameter `{formInstanceID}` should match a form instance ID. @@ -799,7 +676,6 @@ Parameter `{formInstanceID}` should match a form instance ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_instance_id | **str** | True | Form instance ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. ### Return type [**FormInstanceResponse**](../models/form-instance-response) @@ -828,18 +704,16 @@ from sailpoint.v2024.models.form_instance_response import FormInstanceResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Returns a form instance. - results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -851,17 +725,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-form-instance-file -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Download instance file by fileId. @@ -873,7 +736,6 @@ 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. - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. ### Return type **bytearray** @@ -902,19 +764,17 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true 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. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Download instance file by fileId. - results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -926,17 +786,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## import-form-definitions -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Import form definitions from export. @@ -946,7 +795,6 @@ Import form definitions from export. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions ### Return type @@ -976,18 +824,16 @@ from sailpoint.v2024.models.import_form_definitions_request_inner import ImportF from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).import_form_definitions() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body) + # 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: @@ -999,17 +845,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## patch-form-definition -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Patch a form definition. Parameter `{formDefinitionID}` should match a form definition ID. @@ -1020,7 +855,6 @@ Parameter `{formDefinitionID}` should match a form definition ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_definition_id | **str** | True | Form definition ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com ### Return type @@ -1050,19 +884,17 @@ from sailpoint.v2024.models.form_definition_response import FormDefinitionRespon from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, new_body) + # 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: @@ -1074,17 +906,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## patch-form-instance -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Patch a form instance. Parameter `{formInstanceID}` should match a form instance ID. @@ -1095,7 +916,6 @@ Parameter `{formInstanceID}` should match a form instance ID. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_instance_id | **str** | True | Form instance ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. Body | body | **[]Dict[str, object]** | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com ### Return type @@ -1126,19 +946,17 @@ from sailpoint.v2024.models.form_instance_response import FormInstanceResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, new_body) + # 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: @@ -1150,17 +968,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## search-form-definitions-by-tenant -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Export form definitions by tenant. No parameters required. @@ -1170,7 +977,6 @@ No parameters required. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. Query | limit | **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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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](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* @@ -1202,10 +1008,8 @@ from sailpoint.v2024.models.list_form_definitions_by_tenant_response import List from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -1214,9 +1018,9 @@ with ApiClient(configuration) as api_client: try: # Export form definitions by tenant. - results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, offset, limit, filters, sorters) + # 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: @@ -1228,17 +1032,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## search-form-element-data-by-element-id -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: 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. @@ -1251,7 +1044,6 @@ 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 - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` Query | query | **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. @@ -1283,12 +1075,10 @@ from sailpoint.v2024.models.list_form_element_data_by_element_id_response import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true 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 - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -1296,9 +1086,9 @@ with ApiClient(configuration) as api_client: 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, limit, filters, query) + # 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: @@ -1310,27 +1100,13 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## search-form-instances-by-tenant -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: List form instances by tenant. No parameters required. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant) ### Parameters - -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. +This endpoint does not need any parameter. ### Return type [**List[ListFormInstancesByTenantResponse]**](../models/list-form-instances-by-tenant-response) @@ -1358,17 +1134,15 @@ from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFo from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List form instances by tenant. - results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental) + # 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: @@ -1380,27 +1154,13 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## search-pre-defined-select-options -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: List predefined select options. No parameters required. [API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options) ### Parameters - -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. +This endpoint does not need any parameter. ### Return type [**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) @@ -1428,17 +1188,15 @@ from sailpoint.v2024.models.list_predefined_select_options_response import ListP from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List predefined select options. - results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental) + # 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: @@ -1450,17 +1208,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## show-preview-data-source -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Preview form definition data source. @@ -1471,7 +1218,6 @@ Preview form definition data source. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | form_definition_id | **str** | True | Form definition ID - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` Query | query | **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. @@ -1505,11 +1251,9 @@ from sailpoint.v2024.models.preview_data_source_response import PreviewDataSourc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -1528,9 +1272,9 @@ with ApiClient(configuration) as api_client: try: # Preview form definition data source. - results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, limit, filters, query, new_form_element_preview_request) + # 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: diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 872c97879..244b9c88c 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -4939,10 +4939,8 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "owner" : { "name" : "Grant Smith", @@ -5057,9 +5055,9 @@ try: # Creates a form definition. - results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).create_form_definition() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body) + # 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: @@ -5077,10 +5075,8 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "description" : "A description", "attributes" : { @@ -5093,9 +5089,9 @@ try: # Generate JSON Schema dynamically. - results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, new_body) + # 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: @@ -5112,18 +5108,16 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental, file=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, x_sail_point_experimental, file) + # 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: @@ -5141,10 +5135,8 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') body = '''{ "formInput" : { "input1" : "Sales" @@ -5169,9 +5161,9 @@ try: # Creates a form instance. - results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).create_form_instance() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body) + # 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: @@ -5187,17 +5179,15 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Deletes a form definition. - results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -5214,10 +5204,8 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5225,9 +5213,9 @@ try: # List form definitions by tenant. - results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, offset, limit, filters, sorters) + # 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: @@ -5243,18 +5231,16 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true 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. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Download definition file by fileId. - results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -5271,17 +5257,15 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Return a form definition. - results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -5298,17 +5282,15 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Returns a form instance. - results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -5324,18 +5306,16 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true 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. - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # Download instance file by fileId. - results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental) + # 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: @@ -5353,17 +5333,15 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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(x_sail_point_experimental=x_sail_point_experimental) + results = CustomFormsApi(api_client).import_form_definitions() # Below is a request that includes all optional parameters - # results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body) + # 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: @@ -5380,18 +5358,16 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, new_body) + # 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: @@ -5408,18 +5384,16 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, new_body) + # 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: @@ -5436,10 +5410,8 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5447,9 +5419,9 @@ try: # Export form definitions by tenant. - results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental, offset, limit, filters, sorters) + # 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: @@ -5466,21 +5438,19 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true 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 - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, limit, filters, query) + # 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: @@ -5497,16 +5467,14 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List form instances by tenant. - results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental) + # 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: @@ -5523,16 +5491,14 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') try: # List predefined select options. - results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental=x_sail_point_experimental) + 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(x_sail_point_experimental) + # 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: @@ -5550,11 +5516,9 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') 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) @@ -5572,9 +5536,9 @@ try: # Preview form definition data source. - results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental) + 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, x_sail_point_experimental, limit, filters, query, new_form_element_preview_request) + # 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: