Table of contents
🔢 Endpoints (in a sequence of process)
Endpoint | Description | |
|---|---|---|
| 1 | POST | get a list of available reports |
| 2 | POST | order a report by id in the available reports list |
| 3 | GET | check the ordered report status |
| 4 | GET | get the report that was delivered |
| 5 | POST | list all the ordered reports (the same as list of reports in OS) |
In the request header, Application-Id is mandatory. It is unique to each project and environment. Application IDs are provided by Ondato once the service is configured.
🛒 How to order and get a report
1️⃣ Call to POST /v1/legal/reports/available to get a list of available reports.
2️⃣ Use id of the selected report as key to call POST /v1/legal/reports and place a report order.
3️⃣ Call GET /v1/legal/reports/{id} with the id received from the POST /v1/legal/reports response to get the report order status and other details.
Once the order status is Finished a request to download the report can be made.
4️⃣ To get a report file once it is delivered call GET /v1/legal/reports/{id}/file with id of the order.
☁️ Swagger
…
0 Comments