Update to python SDK docs: 13820107626

This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions

View File

@@ -61,7 +61,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform import Transform
@@ -70,23 +69,23 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
transform = {
transform = '''{
"name" : "Timestamp To Date",
"attributes" : "{}",
"type" : "dateFormat"
} # Transform | The transform to be created.
}''' # Transform | The transform to be created.
try:
# Create transform
new_transform = Transform()
new_transform.from_json(transform)
results =TransformsApi(api_client).create_transform(new_transform)
new_transform = Transform.from_json(transform)
results = TransformsApi(api_client).create_transform(transform=new_transform)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).create_transform(new_transform)
print("The response of TransformsApi->create_transform:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TransformsApi->create_transform: %s\n" % e)
```
@@ -127,23 +126,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete
try:
# Delete a transform
TransformsApi(api_client).delete_transform(id)
TransformsApi(api_client).delete_transform(id=id)
# Below is a request that includes all optional parameters
# TransformsApi(api_client).delete_transform(id)
except Exception as e:
except Exception as e:
print("Exception when calling TransformsApi->delete_transform: %s\n" % e)
```
@@ -184,7 +183,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform_read import TransformRead
@@ -192,18 +190,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve
try:
# Transform by ID
results =TransformsApi(api_client).get_transform(id)
results = TransformsApi(api_client).get_transform(id=id)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).get_transform(id)
print("The response of TransformsApi->get_transform:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TransformsApi->get_transform: %s\n" % e)
```
@@ -248,7 +247,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform_read import TransformRead
@@ -256,6 +254,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -266,12 +265,12 @@ with ApiClient(configuration) as api_client:
try:
# List transforms
results =TransformsApi(api_client).list_transforms()
results = TransformsApi(api_client).list_transforms()
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters)
print("The response of TransformsApi->list_transforms:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TransformsApi->list_transforms: %s\n" % e)
```
@@ -313,7 +312,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.transforms_api import TransformsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.transform import Transform
@@ -322,23 +320,24 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update
transform = {
transform = '''{
"name" : "Timestamp To Date",
"attributes" : "{}",
"type" : "dateFormat"
} # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional)
}''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional)
try:
# Update a transform
results =TransformsApi(api_client).update_transform(id, )
results = TransformsApi(api_client).update_transform(id=id)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).update_transform(id, new_transform)
print("The response of TransformsApi->update_transform:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling TransformsApi->update_transform: %s\n" % e)
```