Skip to main content

Report setting

PropertyTypeDescriptionInformation
idintIdentifierUnique for single Report setting.
namestringReport's name--
client_idintClient id--
responsible_user_idintUser id--
typeintType of reportMust be enumerator of report_setting_type
is_livebooleanReport is livetrue for live report, false for not live report
task_filterintTask filters of reportMust be enumerator of report_setting_type
is_bug_field_hidden_from_clientboolShould bug filed be hidden in report detailMust be bool, default value is false
is_automatically_created_by_projectboolWas created by Project flagMust be bool, default value is false
one_time_fromdateFrom date of reportDate, when report is calculated from
one_time_todateTo date of reportDate, when report is calculated to
regular_startdateMonth of report's startDate, when report starts. On end of interval will be generated (is not live).
regular_intervalintRegular report's intervalMust be enumerator of report_setting_interval
created_atdateReport setting creation dateDate of Report setting creation.
updated_atdateReport setting latest update dateDate of Report setting latest update.

Example:

{
"id": 11,
"name": "Test live",
"client_id": 1,
"responsible_user_id": 2,
"type": "1",
"is_live": true,
"task_filter": "1",
"is_bug_field_hidden_for_client": false,
"one_time_from": "2022-12-31T23:00:00.000000Z",
"one_time_to": "2023-01-30T23:00:00.000000Z",
"regular_start": null,
"regular_interval": null,
"created_at": "2023-01-11T15:46:49+0100",
"updated_at": "2023-01-11T15:46:49+0100",
"_links": [
{
"href": "/api/v0/report-settings/11",
"rel": "self",
"type": "GET"
}
]
}