mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update to python SDK docs: 13820107626
This commit is contained in:
developer-relations-sp
@@ -47,6 +47,14 @@ Method | HTTP request | Description
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -79,7 +87,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.create_form_definition_request import CreateFormDefinitionRequest
|
||||
@@ -88,9 +95,11 @@ from pprint import pprint
|
||||
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 = {
|
||||
body = '''{
|
||||
"owner" : {
|
||||
"name" : "Grant Smith",
|
||||
"id" : "2c9180867624cbd7017642d8c8c81f67",
|
||||
@@ -200,17 +209,17 @@ with ApiClient(configuration) as api_client:
|
||||
},
|
||||
"key" : "department"
|
||||
} ]
|
||||
} # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
|
||||
}''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
|
||||
|
||||
try:
|
||||
# Creates a form definition.
|
||||
|
||||
results =CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).create_form_definition(x_sail_point_experimental, new_body)
|
||||
print("The response of CustomFormsApi->create_form_definition:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -222,6 +231,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -255,7 +272,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest
|
||||
@@ -264,9 +280,11 @@ from pprint import pprint
|
||||
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 = {
|
||||
body = '''{
|
||||
"description" : "A description",
|
||||
"attributes" : {
|
||||
"formDefinitionId" : "00000000-0000-0000-0000-000000000000"
|
||||
@@ -274,17 +292,17 @@ with ApiClient(configuration) as api_client:
|
||||
"id" : "00000000-0000-0000-0000-000000000000",
|
||||
"type" : "action",
|
||||
"versionNumber" : 1
|
||||
} # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional)
|
||||
}''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional)
|
||||
|
||||
try:
|
||||
# Generate JSON Schema dynamically.
|
||||
|
||||
results =CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(x_sail_point_experimental, new_body)
|
||||
print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -296,6 +314,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -333,7 +359,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse
|
||||
@@ -341,6 +366,8 @@ from pprint import pprint
|
||||
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')
|
||||
@@ -349,12 +376,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Upload new form definition file.
|
||||
|
||||
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=form_definition_id, x_sail_point_experimental=x_sail_point_experimental, 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)
|
||||
print("The response of CustomFormsApi->create_form_definition_file_request:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -366,6 +393,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -398,7 +433,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.create_form_instance_request import CreateFormInstanceRequest
|
||||
@@ -407,9 +441,11 @@ from pprint import pprint
|
||||
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 = {
|
||||
body = '''{
|
||||
"formInput" : {
|
||||
"input1" : "Sales"
|
||||
},
|
||||
@@ -429,17 +465,17 @@ with ApiClient(configuration) as api_client:
|
||||
"formDefinitionId" : "00000000-0000-0000-0000-000000000000",
|
||||
"state" : "ASSIGNED",
|
||||
"ttl" : 1571827560
|
||||
} # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional)
|
||||
}''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional)
|
||||
|
||||
try:
|
||||
# Creates a form instance.
|
||||
|
||||
results =CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).create_form_instance(x_sail_point_experimental, new_body)
|
||||
print("The response of CustomFormsApi->create_form_instance:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -451,6 +487,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -484,13 +528,14 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from pprint import pprint
|
||||
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')
|
||||
@@ -498,12 +543,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Deletes a form definition.
|
||||
|
||||
results =CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental)
|
||||
results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).delete_form_definition(form_definition_id, x_sail_point_experimental)
|
||||
print("The response of CustomFormsApi->delete_form_definition:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -515,6 +560,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -550,7 +603,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
|
||||
@@ -558,6 +610,8 @@ from pprint import pprint
|
||||
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)
|
||||
@@ -568,12 +622,12 @@ 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, )
|
||||
results = CustomFormsApi(api_client).export_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -585,6 +639,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -620,13 +682,14 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from pprint import pprint
|
||||
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.
|
||||
@@ -635,12 +698,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Download definition file by fileId.
|
||||
|
||||
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=form_definition_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->get_file_from_s3:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -652,6 +715,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -685,7 +756,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
|
||||
@@ -693,6 +763,8 @@ from pprint import pprint
|
||||
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')
|
||||
@@ -700,12 +772,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Return a form definition.
|
||||
|
||||
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=form_definition_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->get_form_definition_by_key:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -717,6 +789,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -750,7 +830,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
|
||||
@@ -758,6 +837,8 @@ from pprint import pprint
|
||||
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')
|
||||
@@ -765,12 +846,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Returns a form instance.
|
||||
|
||||
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=form_instance_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->get_form_instance_by_key:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -782,6 +863,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -817,13 +906,14 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from pprint import pprint
|
||||
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.
|
||||
@@ -832,12 +922,12 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Download instance file by fileId.
|
||||
|
||||
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=form_instance_id, file_id=file_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->get_form_instance_file:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -849,6 +939,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -881,7 +979,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
|
||||
@@ -890,21 +987,21 @@ from pprint import pprint
|
||||
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')
|
||||
[{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[ExportFormDefinitionsByTenant200ResponseInner] | 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[ExportFormDefinitionsByTenant200ResponseInner] | 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[ExportFormDefinitionsByTenant200ResponseInner] | 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, )
|
||||
results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).import_form_definitions(x_sail_point_experimental, new_body)
|
||||
print("The response of CustomFormsApi->import_form_definitions:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -916,6 +1013,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -950,7 +1055,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse
|
||||
@@ -958,22 +1062,22 @@ from pprint import pprint
|
||||
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)
|
||||
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)
|
||||
|
||||
try:
|
||||
# Patch a form definition.
|
||||
|
||||
results =CustomFormsApi(api_client).patch_form_definition(form_definition_id, x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->patch_form_definition:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -985,6 +1089,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -1020,7 +1132,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_instance_response import FormInstanceResponse
|
||||
@@ -1028,22 +1139,22 @@ from pprint import pprint
|
||||
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)
|
||||
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)
|
||||
|
||||
try:
|
||||
# Patch a form instance.
|
||||
|
||||
results =CustomFormsApi(api_client).patch_form_instance(form_instance_id, x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->patch_form_instance:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -1055,6 +1166,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -1090,7 +1209,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse
|
||||
@@ -1098,6 +1216,8 @@ from pprint import pprint
|
||||
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)
|
||||
@@ -1108,12 +1228,12 @@ 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, )
|
||||
results = CustomFormsApi(api_client).search_form_definitions_by_tenant(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -1125,6 +1245,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
@@ -1163,7 +1291,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse
|
||||
@@ -1171,6 +1298,8 @@ from pprint import pprint
|
||||
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
|
||||
@@ -1182,12 +1311,12 @@ 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_element_id, 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, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -1199,6 +1328,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -1230,7 +1367,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse
|
||||
@@ -1238,18 +1374,20 @@ from pprint import pprint
|
||||
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)
|
||||
results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).search_form_instances_by_tenant(x_sail_point_experimental)
|
||||
print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -1261,6 +1399,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
@@ -1292,7 +1438,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse
|
||||
@@ -1300,18 +1445,20 @@ from pprint import pprint
|
||||
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)
|
||||
results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = CustomFormsApi(api_client).search_pre_defined_select_options(x_sail_point_experimental)
|
||||
print("The response of CustomFormsApi->search_pre_defined_select_options:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e)
|
||||
```
|
||||
|
||||
@@ -1323,6 +1470,14 @@ with ApiClient(configuration) as api_client:
|
||||
:::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.
|
||||
|
||||
|
||||
@@ -1360,7 +1515,6 @@ Code | Description | Data Type | Response headers |
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.custom_forms_api import CustomFormsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.form_element_preview_request import FormElementPreviewRequest
|
||||
@@ -1369,13 +1523,15 @@ from pprint import pprint
|
||||
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)
|
||||
form_element_preview_request = {
|
||||
form_element_preview_request = '''{
|
||||
"dataSource" : {
|
||||
"config" : {
|
||||
"indices" : [ "identities" ],
|
||||
@@ -1385,17 +1541,17 @@ with ApiClient(configuration) as api_client:
|
||||
},
|
||||
"dataSourceType" : "STATIC"
|
||||
}
|
||||
} # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional)
|
||||
}''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional)
|
||||
|
||||
try:
|
||||
# Preview form definition data source.
|
||||
|
||||
results =CustomFormsApi(api_client).show_preview_data_source(form_definition_id, x_sail_point_experimental, )
|
||||
results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# 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)
|
||||
print("The response of CustomFormsApi->show_preview_data_source:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
except Exception as e:
|
||||
print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user