User Guide
ReportConfiguration
Returns the framework of a report configuration.
URL
|
GET /api/Report/ReportConfiguration/Default |
ReportConfiguration method |
| Parameter | Required | Description | Type |
|---|---|---|---|
| engineSource | Required |
0 = SearchDb 1 = DataWarehouse Available values: 0,1 0 |
integer($int32) (query) |
Responses
| Code | Description | Links |
| 200 | Success | No links |
|
Media Type text/plain application/json text/json Controls Accept header |
||
| Example Value | Schema | ||
{ "report": { "top": 0,
"properties": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"engineSource": 0, "description": "string", "title": "string", "flags": 0,
"tuneFlags": 0,
"designNotes": "string",
"dateCreated": "2024-12-15T16:12:14.947Z",
"ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner": "string", "permission": 0 }, "links": [
{
"from": {
"reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "columnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}, "to": {
"reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"columnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
],
"filter": {
"valueType": 0,
"useExists": true, "operator": 0,
"values": [ {}
]
},
"joins": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"columns": [ {
"hidden": true, "format": "string",
"label": "string",
"sort": 0,
"aggregate": {
"type": 0,
"distinct": true,
"simpleTimeSeries": true,
"isSqlAggregation": true
},
"aggregationType": 0,
"hasAggregation": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": {
"entity": "string",
"field": "string", "isCustom": true
},
"type": 0,
"isUsed": true
} ],
"permissions": [
{
"roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "roleName": "string",
"value": 0
}
],
"version": 0
}, "dependent": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priority": 0,
"title": "string", "folderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"permission": 0,
"description": "string",
"flags": 0,
"isUsed": true, "dependent": [
"string"
]
}], "entities": [
{
"name": "string", "fields": [
{
"name": "string",
"title": "string", "type": 0,
"ref": "string",
"table": "string",
"column": "string",
"decryptedColumn": "string",
"definition": "string",
"aggregations": [
{
"type": 0,
"distinct": true,
"simpleTimeSeries": true,
"isSqlAggregation": true
} ], "excludes": [
{
"type": 0,
"element": {
"name": "string"
},
"ref": "string"
}
],
"entity": "string",
"flags": 0,
"customAggregationField": "string", "processor": {
"args": [
{
"name": "string",
"value": "string"
}
], "type": 0
},
"filters": [ {
"name": "string",
"title": "string",
"type": 0,
"ref": "string",
"table": "string",
"column": "string",
"decryptedColumn": "string",
"definition": "string",
"priority": 0,
"form": 0,
"listRef": "string",
"field": "string",
"list": {
"name": "string","isEnumFlags": true,
"needsDbToLoad": true,
"definition": "string",
"keyColumn": "string",
"displayColumn": "string",
"sortColumn": "string",
"type": 0,
"editor": "string", "useCustomSort": true
}, "declaration": {
"operator": "string", "values": [
"string"
]
},
"available": 0,
"group": "string",
"isInGroup": true,
"exists": "string"
}
],
"width": 0,
"align": 0,
"specialType": 0,
"permission": 0, "sortFieldRef": "string",
"sortField": "string","customAggregationFieldRef": "string",
"handlesTimeZone": true,
"fullName": "string"
}
], "title": "string",
"hidden": true, "isCustom": true,
"definition": {
"entities": [
"string"
],
"tables": [
{
"name": "string",
"border": true,
"definition": "string",
"allowedWhenBorder": [
{
"name": "string"
}
]
} ], "joins": [
{
"name": "string",
"primaryTable": "string",
"primaryKey": "string",
"foreignTable": "string", "foreignKey": "string", "definition": "string",
"type": 0
}
],
"sharedFilters": [
{
"name": "string",
"title": "string",
"type": 0,
"ref": "string",
"table": "string",
"column": "string",
"decryptedColumn": "string",
"definition": "string",
"priority": 0,
"form": 0,
"listRef": "string",
"field": "string",
"list": {
"name": "string", "isEnumFlags": true,
"needsDbToLoad": true,
"definition": "string",
"keyColumn": "string",
"displayColumn": "string",
"sortColumn": "string",
"type": 0,
"editor": "string",
"useCustomSort": true
},
"declaration": {
"operator": "string", "values": [
"string"
]
},
"available": 0,
"group": "string",
"isInGroup": true, "exists": "string"
}
], "valuesLists": [
{
"name": "string",
"isEnumFlags": true,
"needsDbToLoad": true,
"definition": "string",
"keyColumn": "string",
"displayColumn": "string", "sortColumn": "string",
"type": 0,
"editor": "string", "useCustomSort": true
}
],
"elementsSeparator": "string"
},
"permission": 0
}
], "filterListsValues": {
"additionalProp1": [ {
"name": "string",
"value": "string"
}
],
"additionalProp2": [
{
"name": "string",
"value": "string"
}
],
"additionalProp3": [
{
"name": "string", "value": "string" }
]} } |
||
| 400 |
Bad Request |
No links |
|
Media Type text/plain application/json text/json |
||
| Example Value | Schema | ||
{"type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } |
||
| 401 | Unauthorized | No links |