Generate Report (Reserved)

RESERVED: The keyword RESERVED annotation means that the API is available for use but is not yet part of the officially supported specification. Its behavior, interface, or output may change in future releases without backward compatibility guarantees.

Overview

Submits a request to generate a report for the specified application. Report generation runs asynchronously — the response contains a job identifier that can be used to track progress and download the result once complete.

The report to generate can be identified by report_id, report_name, or both. At least one of the two must be provided. When both are provided, they must refer to the same report, or the request is rejected with a 400 error.

URI

POST /rest/applications/{application}/reports

Path parameters

application (string) — Application name.

Query parameters

Parameter	Type	Required	Default	Description
report_id	integer	Conditional	—	Identifier of the report to generate. See the Report IDs table below. Required if `report_name` is not provided.
report_name	string	Conditional	—	Name of the report to generate (case-insensitive). See the Report IDs table below. Required if `report_id` is not provided.
file_type	string	No	`csv`	Output format. Accepted values: `csv`, `xlsx`, `json`.
date	string	No	—	Snapshot date for the report data.

Report IDs

ID	Report Name
1	Relation between Objects And DataSources
2	Relation between DBTables And DBObjects
3	Relation between DataSources And Transactions
4	Relation between Transactions And Objects
5	Relation between Transactions And DataSources
6	Transactions Complexity
7	Most Referenced Objects
8	Relation between Modules
9	Relation between Modules and Transactions
10	Modules’ Complexity
11	Relation between Modules and Objects
12	Most Referenced Data Objects
13	Lines of Code Per Technology Artifact
14	Number of linked transactions per data source
15	Added, Modified or Deleted Objects
16	Objects Relationships in App-to-App Dependencies
17	Unreferenced Objects

Responses

application/json

Success Response (200 OK)

{
  "results": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reportName": "Transactions Complexity",
    "fileType": "csv",
    "appName": "my-application"
  }
}

JSON representation

Property	Type	Description
results.id	string	Unique identifier of the report job. Use this with the Get Report Status and Get Report endpoints.
results.reportName	string	Name of the requested report.
results.fileType	string	Output format of the report (`csv`, `xlsx`, or `json`).
results.appName	string	Name of the application the report was requested for.

Error Response (400 Bad Request)

Returned when:

both report_id and report_name are omitted,
report_name does not match any known report, or
report_id and report_name are both provided but refer to different reports.