LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 13995602131

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-21 15:48:51 +00:00
parent 5109bc43f7
commit 7c85cb6669
213 changed files with 20334 additions and 23488 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md
View File

@@ -80,7 +80,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -205,7 +204,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition(new_create_form_definition_request)
print("The response of CustomFormsApi->create_form_definition:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e)
```
@@ -250,7 +249,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -375,7 +373,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_by_template(new_create_form_definition_request)
print("The response of CustomFormsApi->create_form_definition_by_template:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e)
```
@@ -421,7 +419,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest
from sailpoint.beta.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -444,7 +441,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body)
print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e)
```
@@ -493,7 +490,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -509,7 +505,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file)
print("The response of CustomFormsApi->create_form_definition_file_request:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e)
```
@@ -554,7 +550,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_instance_request import CreateFormInstanceRequest
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -589,7 +584,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_instance(new_body)
print("The response of CustomFormsApi->create_form_instance:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e)
```
@@ -633,7 +628,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -648,7 +642,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).delete_form_definition(form_definition_id)
print("The response of CustomFormsApi->delete_form_definition:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e)
```
@@ -695,7 +689,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -713,7 +706,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters)
print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e)
```
@@ -759,7 +752,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -775,7 +767,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id)
print("The response of CustomFormsApi->get_file_from_s3:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e)
```
@@ -820,7 +812,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -835,7 +826,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
print("The response of CustomFormsApi->get_form_definition_by_key:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e)
```
@@ -880,7 +871,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -895,7 +885,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
print("The response of CustomFormsApi->get_form_instance_by_key:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e)
```
@@ -941,7 +931,6 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -957,7 +946,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id)
print("The response of CustomFormsApi->get_form_instance_file:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e)
```
@@ -1002,7 +991,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.import_form_definitions202_response import ImportFormDefinitions202Response
from sailpoint.beta.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1017,7 +1005,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).import_form_definitions(new_body)
print("The response of CustomFormsApi->import_form_definitions:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e)
```
@@ -1063,7 +1051,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1079,7 +1066,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body)
print("The response of CustomFormsApi->patch_form_definition:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e)
```
@@ -1126,7 +1113,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1142,7 +1128,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body)
print("The response of CustomFormsApi->patch_form_instance:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e)
```
@@ -1189,7 +1175,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1207,7 +1192,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters)
print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e)
```
@@ -1257,7 +1242,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1276,7 +1260,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query)
print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e)
```
@@ -1317,7 +1301,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1331,7 +1314,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_instances_by_tenant()
print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e)
```
@@ -1372,7 +1355,6 @@ Code | Description | Data Type | Response headers |
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1386,7 +1368,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_pre_defined_select_options()
print("The response of CustomFormsApi->search_pre_defined_select_options:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e)
```
@@ -1436,7 +1418,6 @@ from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_element_preview_request import FormElementPreviewRequest
from sailpoint.beta.models.preview_data_source_response import PreviewDataSourceResponse
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -1465,7 +1446,7 @@ with ApiClient(configuration) as api_client:
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request)
print("The response of CustomFormsApi->show_preview_data_source:\n")
pprint(results)
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e)
```