Versions Compared

Version Old Version 7 New Version 8
Changes made by

Svajunas

Svajunas

Saved on

Key

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

Table of contents

Table of Contents

...

🔢 Endpoints (in a sequence of process)

Endpoint

Description

1

Status
colourGreen
titlePOST
/v1/v2legal/company-reports/company-reports-searchavailable

get a list of available reports

2

Status
colourGreen
titlePOST
/v2v1/legal/company-reports

order a report by id based on the previous reportin the available reports list

3

Status
colourBlue
titleGET
/v1/v2legal/company-reports/{id}/status

check the ordered report status

4

Status
colourBlue
titleGET
/v2v1/legal/company-reports/{id}/file

get the report that was delivered

5

Status
colourGreen
titlePOST
/v2v1/legal/company-reports/status/filter

list all the ordered reports  (the same as 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.

...

How to order and get a report

  1. Call to

    Status
    colourGreen
    titlePOST
    /v1/v2legal/company-reports/company-reports-searchavailable 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

    1. 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

...

☁️ API

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

…

Swagger open api macro
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth-10
urlhttps://sandbox-registries.ondato.com/swagger/v1/swagger.json
token
defaultModelRenderingexample
filterReports
password
expandlist
showCommonExtensionsfalse
filename
operations
maxDisplayedTags
attachfalse
showExtensionsdisplayRequestDurationfalse
displayRequestDurationshowExtensionsfalse
username
order
...