Powered by Redocly

Reports

Get Reports

Get existing reports

SecuritybearerAuth
Request
query Parameters
reportId
integer <int64> >= 1

ID of the Report to be used in search

Example: reportId=1
offset
integer <int64> >= 1
Default: 1

Index of the page to start with

limit
integer <int64> >= 1
Default: 25

Number Of Records to fetch

name
string

Name of the Report to be used in search

path
string

Path of the Script to be used in search

enabled
boolean

Enabled status of the Report to be used in search

default
boolean

Default status of the Report to be used in search

order
integer <int64>

Order of the Report to be used in search (Example: 1)

Responses
200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/reports

Update Report

Update existing report

SecuritybearerAuth
Request
Request Body schema: application/json
required

Update existing report.

id
integer <int32>

id

name
required
string

name

path
required
string

path

enabled
boolean

enabled

order
required
integer <int32> >= 1

order

enableProjectPicker
boolean

enableProjectPicker

Array of objects (ReportCriteriaModel)
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/reports
Request samples
application/json
{
  • "id": 1,
  • "name": "Name of the report",
  • "path": "Path of the report",
  • "enabled": true,
  • "order": 4,
  • "enableProjectPicker": false,
  • "reportOptions": [
    ]
}

Create Report

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

SecuritybearerAuth
Request
Request Body schema: application/json
required

Add new report.

name
required
string

name

path
required
string

path

enabled
boolean

enabled

order
required
integer <int32> >= 1

order

enableProjectPicker
boolean

enableProjectPicker

Array of objects (ReportCriteriaModel)
Responses
201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/reports
Request samples
application/json
{
  • "name": "Name of the report",
  • "path": "Path of the report",
  • "enabled": true,
  • "order": 4,
  • "enableProjectPicker": false,
  • "reportOptions": [
    ]
}

Get Report By Id

Get existing report by reportId

SecuritybearerAuth
Request
path Parameters
reportId
required
integer <int32>
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/reports/{reportId}

Delete Report by Id

Delete the report by report id

SecuritybearerAuth
Request
path Parameters
reportId
required
integer <int32>
Default: 0
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/reports/{reportId}
➔ Next to Rules