Reports

Get Reports

Get existing reports.

Request

query Parameters

reportId	integer <int32> ID of the report to be used in search. Example: reportId=1
offset	integer <int32> Default: 1 Index of the page to start with. Example: offset=1 \| default: 1
limit	integer <int32> Default: 25 Number of records to fetch. Example: limit=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=1

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

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: Bearer JWT_TOKEN

Request Body schema: application/json

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

Payload

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": [{"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": "Set this property to true, if this parameter is mandatory to generate report",
"order": "4"
}
]
}

Update Report

Update existing report.

Request

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

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

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/reports

Request samples

Payload

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\nthan one project.\n",
"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": "Set this property to true, if this parameter is mandatory to generate report",
"order": "4"
}
]
}

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: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/reports/{reportId}

Delete Report

Delete the report.

Request

path Parameters

reportName

required

string

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/reports/{reportName}/

➔ Next to Rules