LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md
View File

@@ -20,10 +20,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report
[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File
[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result
[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report
[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report
[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file
[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result
[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run report
## cancel-report
@@ -57,7 +57,7 @@ Code | Description | Data Type
```powershell
$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel
# Cancel Report
# Cancel report
try {
Suspend-V2024Report -Id $Id
@@ -109,7 +109,7 @@ $FileFormat = "csv" # String | Output format of the requested report file
$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional)
$Auditable = $true # Boolean | 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)
# Get Report File
# Get report file
try {
Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat
@@ -156,7 +156,7 @@ Code | Description | Data Type
$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report
$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false)
# Get Report Result
# Get report result
try {
Get-V2024ReportResult -TaskResultId $TaskResultId
@@ -207,7 +207,7 @@ $ReportDetails = @"{
}
}"@
# Run Report
# Run report
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails