Skip to content

Generate Report

Request

Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects.

Security
bearerAuth
Path
projectIdinteger, (int64), >= 1required

ID of the Project

Example:1
reportIdinteger, (int64), >= 1required

ID of the Report that is to be generated

Example:1
Bodyapplication/json

The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.

otherProjectIdinteger, (int32)

otherProjectId

Example:1
optionsobject

options

curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/projects/1/reports/1/generate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "otherProjectId": 1,
    "options": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK