LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +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

114
docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -69,23 +69,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_stats import SedBatchStats
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Submit Sed Batch Stats Request
api_response = api_instance.get_sed_batch_stats(batch_id, x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sed_batch_stats(batch_id, x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e)
```
@@ -131,22 +134,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_status import SedBatchStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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 Sed Batch Request
api_response = api_instance.get_sed_batches(x_sail_point_experimental)
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sed_batches(x_sail_point_experimental)
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e)
```
@@ -212,10 +218,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed import Sed
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
limit = limit=25 # int | 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) # int | 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)
filters = 'displayName co \"Read and Write\"' # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
@@ -228,13 +238,12 @@ from pprint import pprint
try:
# List Suggested Entitlement Descriptions
api_response = api_instance.list_seds(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e)
```
@@ -281,11 +290,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed import Sed
from sailpoint.v2024.models.sed_patch import SedPatch
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed 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')
[sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request
@@ -298,14 +311,14 @@ from pprint import pprint
try:
# Patch Suggested Entitlement Description
Result = sed_patch.from_json(sed_patch)
api_response = api_instance.patch_sed(id, x_sail_point_experimental, Result)
new_sed_patch = SedPatch()
new_sed_patch.from_json(sed_patch)
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sed(id, x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e)
```
@@ -352,11 +365,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_approval import SedApproval
from sailpoint.v2024.models.sed_approval_status import SedApprovalStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
[sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval
sed_approval = {
@@ -366,14 +383,14 @@ from pprint import pprint
try:
# Submit Bulk Approval Request
Result = sed_approval.from_json(sed_approval)
api_response = api_instance.submit_sed_approval(x_sail_point_experimental, Result)
new_sed_approval = SedApproval()
new_sed_approval.from_json(sed_approval)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_approval(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e)
```
@@ -420,11 +437,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_assignment import SedAssignment
from sailpoint.v2024.models.sed_assignment_response import SedAssignmentResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sed_assignment = {
"assignee" : {
@@ -436,14 +457,14 @@ from pprint import pprint
try:
# Submit Sed Assignment Request
Result = sed_assignment.from_json(sed_assignment)
api_response = api_instance.submit_sed_assignment(x_sail_point_experimental, Result)
new_sed_assignment = SedAssignment()
new_sed_assignment.from_json(sed_assignment)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_assignment(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e)
```
@@ -490,11 +511,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v2024
from sailpoint.v2024.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.sed_batch_request import SedBatchRequest
from sailpoint.v2024.models.sed_batch_response import SedBatchResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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')
sed_batch_request = {
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
@@ -504,13 +529,12 @@ from pprint import pprint
try:
# Submit Sed Batch Request
api_response = api_instance.submit_sed_batch_request(x_sail_point_experimental, )
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, )
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_sed_batch_request(x_sail_point_experimental, Result)
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, new_sed_batch_request)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e)
```