ReportWrapper
| Field | NULL | Description | Note |
|---|---|---|---|
|
id string (GUID) |
The id of the report | ||
|
name string |
The system name of the report definition | ||
|
title string |
The title shown on the report header | ||
|
description string |
A summary description of the report | ||
|
accessPriority integer |
The weight applied when more than one access rule applies | ||
|
designerVersion integer |
The designer schema version - 0 = ReportDesignerV1 - 1 = ReportDesignerV2 |
||
|
filtersRailPosition string |
Where the filter rail is positioned One of Left, Right, or Top
|
||
|
tenantId string (GUID) |
Y | The id of the tenant, or null for a global report | |
|
type integer |
The category type of the report | ||
|
isGlobal boolean |
Whether child tenants can query this report | ||
|
category object |
A Category object | ||
|
subCategory object |
Y | A Category object | |
|
previewRecord integer |
The maximum number of records loaded in preview | ||
|
ownerId string (GUID) |
Y | The id of the user who created the report | |
|
owner string |
The username of the user who created the report | ||
|
reportDataSource array of objects |
An array of ReportDataSource objects | ||
|
reportPart array of objects |
An array of ReportPartDefinition objects | ||
|
reportRelationship array of objects |
An array of Relationship objects | ||
|
reportFilter object |
A ReportFilterSetting object | ||
|
calculatedFields array of objects |
An array of QuerySourceField objects | ||
|
layouts array of objects |
An array of ReportLayout objects | ||
|
schedules array of objects |
An array of Subscription objects | ||
|
accesses array of objects |
An array of UserPermission objects |
Sample:
{"id":"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d","name":"sales_performance_dashboard","title":"Sales Performance Grid","designerVersion":1,"tenantId":"e3d1a4b5-6c7d-8e9f-0a1b-2c3d4e5f6a7b","type":0,"isGlobal":false,"category":{"id":"f5e4d3c2-b1a0-9f8e-7d6c-5b4a3f2e1d0c","name":"Corporate sales","type":0,"tenantId":null,"isGlobal":false},"subCategory":null,"previewRecord":15,"owner":"System Administrator","ownerId":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","reportDataSource":[{"aliasId":"3e3409be-c87b-4670-ba47-d40e3a205670_Orders","querySourceId":"3e3409be-c87b-4670-ba47-d40e3a205670","querySourceName":"Orders","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[]}],"reportPart":[],"reportRelationship":[],"reportFilter":{"filterFields":[]},"calculatedFields":[],"layouts":[],"schedules":[],"accesses":[]}