Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Table of Contents

Table of Contents

...

🛒 How to order and get a report

1️⃣ Call to

Status
colourGreen
titlePOST
/v1/legal/reports/available to get a list of available reports.

2️⃣ Use id of the selected report as key to call

Status
colourGreen
titlePOST
/v1/legal/reports and place a report order.

3️⃣ Call

Status
colourBlue
titleGET
/v1/legal/reports/{id} with the id received from the
Status
colourGreen
titlePOST
/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

Status
colourBlue
titleGET
/v1/legal/reports/{id}/file with id of the order.

...

🔢 Endpoints (in a sequence of process)

Endpoint

Description

1

Status
colourGreen
titlePOST
/v1/legal/reports/available

Get a list of available reports.

2

Status
colourGreen
titlePOST
/v1/legal/reports

Order a report by its id in the list of available reports.

3

Status
colourBlue
titleGET
/v1/legal/reports/{id}

Check the status of the ordered report.

4

Status
colourBlue
titleGET
/v1/legal/reports/{id}/file

Get the report that has been delivered.

5

Status
colourGreen
titlePOST
/v1/legal/reports/filter

List all the ordered reports (the same as the list of reports in OS).

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
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth0
urlhttps://registries.ondato.com/swagger/v1/swagger.json
token
defaultModelRenderingexample
filterReports
password
expandlist
showCommonExtensionsfalse
filename
operations
maxDisplayedTags
attachfalse
showExtensionsfalse
displayRequestDurationfalse
username
order

...