Powered by Redocly

Reports

Get Reports

Get existing reports

Request
query Parameters
reportId
integer <int32>

ID of the Report to be used in search

Example: reportId=E.g. 1
offset
integer <int32>
Default: 1

Index of the page to start with

Example: offset=E.g. 1 | default: 1
limit
integer <int32>
Default: 25

Number Of Records to fetch

Example: limit=E.g. 25 | default: 25
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 <int32>

Order of the Report to be used in search

Example: order=E.g. 1
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/reports

Create Report

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

Request
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Request Body schema: application/json
required

Add new report.

name
required
string

name

path
required
string

path

enabled
boolean
Default: false

enabled

order
required
integer <int32> >= 1

order

enableProjectPicker
boolean
Default: false

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": "Set this property to true, if this report is applicable across more than one project.",
  • "reportOptions": [
    ]
}

Update Report

Update existing report

Request
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Request Body schema: application/json
required

Update existing report.

id
integer <int32>

id

name
required
string

name

path
required
string

path

enabled
boolean
Default: false

enabled

order
required
integer <int32> >= 1

order

enableProjectPicker
boolean
Default: false

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": "Set this property to true, if this report is applicable across more than one project.",
  • "reportOptions": [
    ]
}

Get Report By Id

Get existing report by reportId

Request
path Parameters
reportId
required
integer <int32>
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
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

Request
path Parameters
reportId
required
integer <int32>
Default: 0
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: E.g. Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/reports/{reportId}
➔ Next to Rules