mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
03d88f31b9
* PLTDP-3876: identity details report request body example changed
* PLTDP-3876: reports/{id}/cancel endpoint added
* PLTDP-3876: added 'reports/result' endpoint
* PLTDP-3876: lint errors fixed
* PLTDP-3876: spacing issue with examples for tequest bodies fixed
* PLTDP-3876: schema and example fixes for response bodies
* PLTDP-3876 PLTDP:3876: 'reporting/reports/{taskResultId}/{fileFormat}' endpoint described
* PLTDP-3876: added 'reporting/reports/{reportName}/genericReport' description, returns example schema updated
* PLTDP-3876: GenericReports schema fixed
* PLTDP-3876: unnecessary quates removed from generic reports path description
* PLTDP-3876: review changes - payloads changed, generic reports endpoint removed
* PLTDP-3876: unused examples removed
* PLTDP-3876: removed 'PDF' from examples as this type is going to be deprecated
* PLTDP-3876: nullable parameters added for nullable payloads
* PLTDP-3876: progress field for TaskResultDetails marked nullable
* PLTDP-3876: moved specs to beta till their endpoints will be callable and maintainable
* PLTDP-3876: moving api specs from internal beta to v3
* PLTDP-3876: changed security description, default value for path var fixed
* PLTDP-3876: schemas updated
* PLTDP-3876: schema for TaskResultDetails fixed
* PLTDP-3876: missing example added
* PLTDP-3876: taskDefName example gated with quotes
* PLTDP-3876: cleared beta files after merge with master
* PLTDP-3876: quotes restored for ReportDetails. It is the same as in master branch with extended description
* PLTDP-3876: review changes applied
* PLTDP-3876: mising example for completed query param added
* PLTDP-3876: changed type schema for 'completed' param
* PLTDP-3876: changed type schema for 'fileFormat' param, enum description should be within type
* PLTDP-3876: all necessary run report payloads to be published as public added.
* PLTDP-3876: report types moved to enum, all necessary arguments described as oneOf in the schema
* PLTDP-3876: description and example for report details added
* PLTDP-3876: description and example for reportType added
* PLTDP-3876: review changes - titles added for arguments, required added to the arguments properties, boolean properties types fixed
* PLTDP-3876: syntax of required fields changed
* PLTDP-3876: property for ACCOUNTS arguments schema cleaned up
* PLTDP-3876: attempt to fix example for arguments
* PLTDP-3876: second attempt to fix example for arguments
* PLTDP-3876: third attempt to fix 'cannot assign to this.SetS3Bucket'
* PLTDP-3876: most of proposed changes done. Need to discuss task result progress
* PLTDP-3876: examples updated according to changes
* PLTDP-3876: report result status updated
* PLTDP-3876: report result reportType fixed
* PLTDP-3876: 'setS3Bucket' property renamed to resolve go SDK collision
* PLTDP-3876: fixing beta api file
* PLTDP-3876: fixing beta api file, removed also next line
* Merged with master
* removed duplicate description key
---------
Co-authored-by: Colin McKibben <colin.mckibben@sailpoint.com>' by github action: 6813717402
42 lines
1.3 KiB
YAML
42 lines
1.3 KiB
YAML
post:
|
|
tags:
|
|
- Reports Data Extraction
|
|
description: >-
|
|
Runs a report according to input report details.
|
|
If non-concurrent task is already running then it returns, otherwise new task creates and returns.
|
|
operationId: startReport
|
|
summary: "Run Report"
|
|
security:
|
|
- UserContextAuth: [sp:report:create]
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/reports/ReportDetails.yaml'
|
|
examples:
|
|
Identities Details Report:
|
|
$ref: '../schemas/reports/examples/identities-details-report-details.yaml'
|
|
required: true
|
|
responses:
|
|
'200':
|
|
description: Details about running report task.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/reports/TaskResultDetails.yaml'
|
|
examples:
|
|
identityDetailsReport:
|
|
$ref: '../schemas/reports/examples/identities-details-report-task-result.yaml'
|
|
searchExportReport:
|
|
$ref: '../schemas/reports/examples/search-export-report-task-result.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|