Table of contents
...
Contents
...
🛒 How to order and get a report
1️⃣ Call to
/v1/legal/reports/available to get a list of available reports.2️⃣ Use id of the selected report as key to call
/v1/legal/reports and place a report order.3️⃣ Call
/v1/legal/reports/{id} with the id received from the /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
/v1/legal/reports/{id}/file with id of the order....
🔢 Endpoints (in a sequence of process)
get /v2/company-reports/company-reports-search | /v1/legal/reports/available | Get a list of available reports. |
| 2 | /v1/ |
v2company-order based on the previous report3 | /v2/company-in the list of available reports. |
| 3 | /v1/legal/reports/{id} |
/statuscheck | Check the status of the ordered report. |
| 4 | |
4 | /v2/company- /v1/legal/reports/{id}/file |
get was /v2/company-reports/statuslist List all the ordered reports (the same as the list of reports in OS). |
| Panel |
|---|
| panelIconId | atlassian-info |
|---|
| panelIcon | :info: |
|---|
| bgColor | #F4F5F7 |
|---|
|
…| Info |
|---|
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. |
...
☁️ Swagger
| Swagger open api macro |
|---|
| displayOperationId | false |
|---|
| methods | none,get,put,post,delete,options,head,patch,trace |
|---|
| validator | |
|---|
| defaultModelsExpandDepth | -10 |
|---|
| url | https://sandbox-registries.ondato.com/swagger/v1/swagger.json |
|---|
| token | |
|---|
| defaultModelRendering | example |
|---|
| filter | Reports |
|---|
| password | |
|---|
| expand | list |
|---|
| showCommonExtensions | false |
|---|
| filename | |
|---|
| operations | |
|---|
| maxDisplayedTags | |
|---|
| attach | false |
|---|
| displayRequestDurationshowExtensions | false |
|---|
| showExtensionsdisplayRequestDuration | false |
|---|
| username | |
|---|
| order | |
|---|
|
|
...