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 to python SDK docs: 13820107626

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md
View File

@@ -56,23 +56,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel
try:
# Cancel Report
ReportsDataExtractionApi(api_client).cancel_report(id)
ReportsDataExtractionApi(api_client).cancel_report(id=id)
# Below is a request that includes all optional parameters
# ReportsDataExtractionApi(api_client).cancel_report(id)
except Exception as e:
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e)
```
@@ -116,13 +116,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file
@@ -132,12 +132,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Report File
results =ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, )
results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format)
# Below is a request that includes all optional parameters
# results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable)
print("The response of ReportsDataExtractionApi->get_report:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e)
```
@@ -178,7 +178,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_results import ReportResults
@@ -186,6 +185,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False)
@@ -193,12 +193,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Report Result
results =ReportsDataExtractionApi(api_client).get_report_result(task_result_id, )
results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id)
# Below is a request that includes all optional parameters
# results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed)
print("The response of ReportsDataExtractionApi->get_report_result:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e)
```
@@ -238,7 +238,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_details import ReportDetails
@@ -247,25 +246,25 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_details = {
report_details = '''{
"reportType" : "ACCOUNTS",
"arguments" : {
"application" : "2c9180897e7742b2017e781782f705b9",
"sourceName" : "Active Directory"
}
} # ReportDetails |
}''' # ReportDetails |
try:
# Run Report
new_report_details = ReportDetails()
new_report_details.from_json(report_details)
results =ReportsDataExtractionApi(api_client).start_report(new_report_details)
new_report_details = ReportDetails.from_json(report_details)
results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details)
# Below is a request that includes all optional parameters
# results = ReportsDataExtractionApi(api_client).start_report(new_report_details)
print("The response of ReportsDataExtractionApi->start_report:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e)
```