mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
starting point for adding python sdk docs
This commit is contained in:
darrell-thobe-sp
@@ -0,0 +1,264 @@
|
||||
---
|
||||
id: v2024-reports-data-extraction
|
||||
title: Reports_Data_Extraction
|
||||
pagination_label: Reports_Data_Extraction
|
||||
sidebar_label: Reports_Data_Extraction
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Reports_Data_Extraction', 'V2024Reports_Data_Extraction']
|
||||
slug: /tools/sdk/python/v2024/methods/reports-data-extraction
|
||||
tags: ['SDK', 'Software Development Kit', 'Reports_Data_Extraction', 'V2024Reports_Data_Extraction']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.ReportsDataExtractionApi
|
||||
Use this API to implement reports lifecycle managing and monitoring.
|
||||
With this functionality in place, users can run reports, view their results, and cancel reports in progress.
|
||||
This can be potentially helpful for auditing purposes.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**cancel_report**](ReportsDataExtractionApi#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report
|
||||
[**get_report**](ReportsDataExtractionApi#get-report) | **GET** `/reports/{taskResultId}` | Get Report File
|
||||
[**get_report_result**](ReportsDataExtractionApi#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
|
||||
[**start_report**](ReportsDataExtractionApi#start-report) | **POST** `/reports/run` | Run Report
|
||||
|
||||
|
||||
## cancel-report
|
||||
Cancel Report
|
||||
Cancels a running report.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | ID of the running Report to cancel
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel
|
||||
|
||||
try:
|
||||
# Cancel Report
|
||||
|
||||
api_instance.cancel_report(id)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_instance.cancel_report(id)
|
||||
except Exception as e:
|
||||
print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-report
|
||||
Get Report File
|
||||
Gets a report in file format.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | task_result_id | **str** | True | Unique identifier of the task result which handled report
|
||||
Query | file_format | **str** | True | Output format of the requested report file
|
||||
Query | name | **str** | (optional) | preferred Report file name, by default will be used report name from task result.
|
||||
Query | auditable | **bool** | (optional) (default to False) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId.
|
||||
|
||||
### Return type
|
||||
**bytearray**
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Report file in selected format. CSV by default. | bytearray | * Content-disposition - The requested report's filename |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/csv, application/pdf, application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
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
|
||||
name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional)
|
||||
auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False)
|
||||
|
||||
try:
|
||||
# Get Report File
|
||||
|
||||
api_response = api_instance.get_report(task_result_id, file_format, )
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_report(task_result_id, file_format, name, auditable)
|
||||
print("The response of ReportsDataExtractionApi->get_report:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-report-result
|
||||
Get Report Result
|
||||
Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report-result)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | task_result_id | **str** | True | Unique identifier of the task result which handled report
|
||||
Query | completed | **bool** | (optional) (default to False) | state of task result to apply ordering when results are fetching from the DB
|
||||
|
||||
### Return type
|
||||
[**ReportResults**](../models/report-results)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Details about report that was run or is running. | ReportResults | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.report_results import ReportResults
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
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)
|
||||
|
||||
try:
|
||||
# Get Report Result
|
||||
|
||||
api_response = api_instance.get_report_result(task_result_id, )
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_report_result(task_result_id, completed)
|
||||
print("The response of ReportsDataExtractionApi->get_report_result:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## start-report
|
||||
Run Report
|
||||
Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-report)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | report_details | [**ReportDetails**](../models/report-details) | True |
|
||||
|
||||
### Return type
|
||||
[**TaskResultDetails**](../models/task-result-details)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Details about running report task. | TaskResultDetails | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.models.report_details import ReportDetails
|
||||
from sailpoint.v2024.models.task_result_details import TaskResultDetails
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
report_details = {
|
||||
"reportType" : "ACCOUNTS",
|
||||
"arguments" : {
|
||||
"application" : "2c9180897e7742b2017e781782f705b9",
|
||||
"sourceName" : "Active Directory"
|
||||
}
|
||||
} # ReportDetails |
|
||||
|
||||
try:
|
||||
# Run Report
|
||||
Result = report_details.from_json(report_details)
|
||||
api_response = api_instance.start_report(Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.start_report(Result)
|
||||
print("The response of ReportsDataExtractionApi->start_report:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user