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 layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -77,11 +77,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_form_definition_request = {
"owner" : {
"name" : "Grant Smith",
@@ -197,13 +201,12 @@ from pprint import pprint
try:
# Creates a form definition.
api_response = api_instance.create_form_definition()
results =CustomFormsApi(api_client).create_form_definition()
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition(Result)
# results = CustomFormsApi(api_client).create_form_definition(new_create_form_definition_request)
print("The response of CustomFormsApi->create_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e)
```
@@ -244,11 +247,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_form_definition_request = {
"owner" : {
"name" : "Grant Smith",
@@ -364,13 +371,12 @@ from pprint import pprint
try:
# Create a form definition by template.
api_response = api_instance.create_form_definition_by_template()
results =CustomFormsApi(api_client).create_form_definition_by_template()
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition_by_template(Result)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_by_template: %s\n" % e)
```
@@ -412,11 +418,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = {
"description" : "A description",
"attributes" : {
@@ -430,13 +440,12 @@ from pprint import pprint
try:
# Generate JSON Schema dynamically.
api_response = api_instance.create_form_definition_dynamic_schema()
results =CustomFormsApi(api_client).create_form_definition_dynamic_schema()
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition_dynamic_schema(Result)
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body)
print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e)
```
@@ -482,23 +491,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID
file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart
try:
# Upload new form definition file.
api_response = api_instance.create_form_definition_file_request(form_definition_id, file)
results =CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_definition_file_request(form_definition_id, 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")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e)
```
@@ -539,11 +551,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = {
"formInput" : {
"input1" : "Sales"
@@ -569,13 +585,12 @@ from pprint import pprint
try:
# Creates a form instance.
api_response = api_instance.create_form_instance()
results =CustomFormsApi(api_client).create_form_instance()
# Below is a request that includes all optional parameters
# api_response = api_instance.create_form_instance(Result)
# results = CustomFormsApi(api_client).create_form_instance(new_body)
print("The response of CustomFormsApi->create_form_instance:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e)
```
@@ -617,21 +632,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.rest import ApiException
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()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Deletes a form definition.
api_response = api_instance.delete_form_definition(form_definition_id)
results =CustomFormsApi(api_client).delete_form_definition(form_definition_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_form_definition(form_definition_id)
# results = CustomFormsApi(api_client).delete_form_definition(form_definition_id)
print("The response of CustomFormsApi->delete_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e)
```
@@ -675,10 +693,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -687,13 +709,12 @@ from pprint import pprint
try:
# List form definitions by tenant.
api_response = api_instance.export_form_definitions_by_tenant()
results =CustomFormsApi(api_client).export_form_definitions_by_tenant()
# Below is a request that includes all optional parameters
# api_response = api_instance.export_form_definitions_by_tenant(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")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e)
```
@@ -737,22 +758,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.rest import ApiException
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()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
try:
# Download definition file by fileId.
api_response = api_instance.get_file_from_s3(form_definition_id, file_id)
results =CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_file_from_s3(form_definition_id, file_id)
# results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id)
print("The response of CustomFormsApi->get_file_from_s3:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e)
```
@@ -794,22 +818,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Return a form definition.
api_response = api_instance.get_form_definition_by_key(form_definition_id)
results =CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_definition_by_key(form_definition_id)
# results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
print("The response of CustomFormsApi->get_form_definition_by_key:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e)
```
@@ -851,22 +878,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
try:
# Returns a form instance.
api_response = api_instance.get_form_instance_by_key(form_instance_id)
results =CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_instance_by_key(form_instance_id)
# results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
print("The response of CustomFormsApi->get_form_instance_by_key:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e)
```
@@ -910,22 +940,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
from sailpoint.beta.rest import ApiException
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()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
try:
# Download instance file by fileId.
api_response = api_instance.get_form_instance_file(form_instance_id, file_id)
results =CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_form_instance_file(form_instance_id, file_id)
# results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id)
print("The response of CustomFormsApi->get_form_instance_file:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e)
```
@@ -966,11 +999,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{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)
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)
@@ -978,13 +1015,12 @@ from pprint import pprint
try:
# Import form definitions from export.
api_response = api_instance.import_form_definitions()
results =CustomFormsApi(api_client).import_form_definitions()
# Below is a request that includes all optional parameters
# api_response = api_instance.import_form_definitions(Result)
# results = CustomFormsApi(api_client).import_form_definitions(new_body)
print("The response of CustomFormsApi->import_form_definitions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e)
```
@@ -1027,10 +1063,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
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)
@@ -1039,13 +1079,12 @@ from pprint import pprint
try:
# Patch a form definition.
api_response = api_instance.patch_form_definition(form_definition_id, )
results =CustomFormsApi(api_client).patch_form_definition(form_definition_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_form_definition(form_definition_id, Result)
# results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body)
print("The response of CustomFormsApi->patch_form_definition:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e)
```
@@ -1089,10 +1128,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
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)
@@ -1101,13 +1144,12 @@ from pprint import pprint
try:
# Patch a form instance.
api_response = api_instance.patch_form_instance(form_instance_id, )
results =CustomFormsApi(api_client).patch_form_instance(form_instance_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_form_instance(form_instance_id, Result)
# results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body)
print("The response of CustomFormsApi->patch_form_instance:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e)
```
@@ -1151,10 +1193,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
filters = 'name sw \"my form\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional)
@@ -1163,13 +1209,12 @@ from pprint import pprint
try:
# Export form definitions by tenant.
api_response = api_instance.search_form_definitions_by_tenant()
results =CustomFormsApi(api_client).search_form_definitions_by_tenant()
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_definitions_by_tenant(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")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e)
```
@@ -1216,10 +1261,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
form_element_id = '1' # str | Form element ID # str | Form element ID
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
@@ -1229,13 +1278,12 @@ from pprint import pprint
try:
# Retrieves dynamic data by element.
api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, )
results =CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_element_data_by_element_id(form_instance_id, form_element_id, 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")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e)
```
@@ -1273,21 +1321,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List form instances by tenant.
api_response = api_instance.search_form_instances_by_tenant()
results =CustomFormsApi(api_client).search_form_instances_by_tenant()
# Below is a request that includes all optional parameters
# api_response = api_instance.search_form_instances_by_tenant()
# results = CustomFormsApi(api_client).search_form_instances_by_tenant()
print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e)
```
@@ -1325,21 +1376,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List predefined select options.
api_response = api_instance.search_pre_defined_select_options()
results =CustomFormsApi(api_client).search_pre_defined_select_options()
# Below is a request that includes all optional parameters
# api_response = api_instance.search_pre_defined_select_options()
# results = CustomFormsApi(api_client).search_pre_defined_select_options()
print("The response of CustomFormsApi->search_pre_defined_select_options:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e)
```
@@ -1385,11 +1439,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.beta
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 sailpoint.beta.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10)
filters = 'value eq \"ID01\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional)
@@ -1409,13 +1467,12 @@ from pprint import pprint
try:
# Preview form definition data source.
api_response = api_instance.show_preview_data_source(form_definition_id, )
results =CustomFormsApi(api_client).show_preview_data_source(form_definition_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.show_preview_data_source(form_definition_id, limit, filters, query, Result)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e)
```