developer.sailpoint.com/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
reports-data-extraction	Reports_Data_Extraction	Reports_Data_Extraction	Reports_Data_Extraction	pythonsdk	python Python sdk Reports_Data_Extraction Reports_Data_Extraction	/tools/sdk/python/v3/methods/reports-data-extraction	SDK Software Development Kit Reports_Data_Extraction Reports_Data_Extraction

sailpoint.v3.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/v3

Method	HTTP request	Description
cancel-report	POST /reports/{id}/cancel	Cancel Report
get-report	GET /reports/{taskResultId}	Get Report File
get-report-result	GET /reports/{taskResultId}/result	Get Report Result
start-report	POST /reports/run	Run Report

cancel-report

Cancel Report Cancels a running report.

API Spec

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

from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
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=id)
        # Below is a request that includes all optional parameters
        # ReportsDataExtractionApi(api_client).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

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

from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
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
    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
        
        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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

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

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

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
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)

    try:
        # Get Report Result
        
        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")
        print(results.model_dump_json(by_alias=True, indent=4))
    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

Parameters

Param Type	Name	Data Type	Required	Description
Body	report_details	ReportDetails	True

Return type

TaskResultDetails

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

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
from sailpoint.v3.models.task_result_details import TaskResultDetails
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    report_details = '''{
          "reportType" : "ACCOUNTS",
          "arguments" : {
            "application" : "2c9180897e7742b2017e781782f705b9",
            "sourceName" : "Active Directory"
          }
        }''' # ReportDetails | 

    try:
        # Run Report
        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")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e)

[Back to top]