Skip to content

Create Report

Request

Add new report. All the report options, if given will have datatype as String/text.

Security
bearerAuth
Bodyapplication/jsonrequired

Add new report.

namestringrequired

name

Example:"Name of the report"
pathstringrequired

path

Example:"Path of the report"
enabledboolean

enabled

Example:true
orderinteger, (int32), >= 1required

order

Example:4
enableProjectPickerboolean

enableProjectPicker

Example:false
reportOptionsArray of objects(ReportCriteriaModel)
curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Name of the report",
    "path": "Path of the report",
    "enabled": true,
    "order": 4,
    "enableProjectPicker": false,
    "reportOptions": [
      {
        "name": "Name of the Report Parameter",
        "label": "Display Name of the Report Parameter",
        "description": "Description of the Report Parameter",
        "type": "Type of the Report Parameter",
        "defaultValue": "Default value of the Report Parameter",
        "required": false,
        "order": 4
      }
    ]
  }'

Responses

Created