ReportConfiguration

Returns the report configuration as JSON for a given report ID.

URL

GET /api/Report/ReportConfiguration/{id}

ReportConfiguration method

 

Parameter Required Description Type
id Required id

string($uuid)

(path)

Responses

Code Description Links
200 Success No links
 

Media Type

text/plain

application/json

text/json

Controls Accept header

 
  Example Value | Schema  
 
{
 "reportDesign": {
 "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-15T15:13:46.003Z",
"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"
}
]
}
},
"schedule": {
"startBoundary": "2024-12-15T15:13:46.003Z",
"endBoundary": "2024-12-15T15:13:46.003Z",
"afterStartMinutesBase": 0,
"beforeStartMinutesBase": 0,
"maxRunTime": {
"ticks": 0,
"days": 0,
"hours": 0,
"milliseconds": 0,
"microseconds": 0,
"nanoseconds": 0,
"minutes": 0,
"seconds": 0,
"totalDays": 0,
"totalHours": 0,
"totalMilliseconds": 0,
"totalMicroseconds": 0,
"totalNanoseconds": 0,
"totalMinutes": 0,
"totalSeconds": 0
},
"scheduleByDay": {
"daysInterval": 0,
"isRunOnce": true
},
"scheduleByWeek": {
"daysOfWeek": [
0
],
"weeksInterval": 0,
"daysOfWeekSpecified": true
},
"scheduleByMonth": {
"daysOfMonth": [
0
],
"dayOfWeek": {
"number": 0,
"day": 0
},
"months": [
1
],
"daysOfMonthSpecified": true,
"monthsSpecified": true,
"dayOfWeekSpecified": true
},
"currentSchedule": {},
"isRandomStart": true,
"scheduleType": 0,
"repetition": {
"interval": {
"ticks": 0,
"days": 0,
"hours": 0,
"milliseconds": 0,
"microseconds": 0,
"nanoseconds": 0,
"minutes": 0,
"seconds": 0,
"totalDays": 0,
"totalHours": 0,
"totalMilliseconds": 0,
"totalMicroseconds": 0,
"totalNanoseconds": 0,
"totalMinutes": 0,
"totalSeconds": 0
},
"duration": {
"ticks": 0,
"days": 0,
"hours": 0,
"milliseconds": 0,
"microseconds": 0,
"nanoseconds": 0,
"minutes": 0,
"seconds": 0,
"totalDays": 0,
"totalHours": 0,
"totalMilliseconds": 0,
"totalMicroseconds": 0,
"totalNanoseconds": 0,
"totalMinutes": 0,
"totalSeconds": 0
 },
 "resumeWhenIdle": true,
 "stopAtDurationEnd": true,
 "xmlInterval": "string",
 "xmlDuration": "string",
 "resumeWhenIdleSpecified": true,
 "stopAtDurationEndSpecified": true
},
"isRunOnce": true,
"xmlMaxRunTime": "string",
"enabled": true,
"scheduleTime": "2024-12-15T15:13:46.004Z",
"startRun": "2024-12-15T15:13:46.004Z",
"beginRun": "2024-12-15T15:13:46.004Z",
"lastRun": "2024-12-15T15:13:46.004Z",
"startBoundarySpecified": true,
"endBoundarySpecified": true,
"afterStartMinutesBaseSpecified": true,
"beforeStartMinutesBaseSpecified": true,
"maxRunTimeSpecified": true,
"context": {
 "scheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
 "type": 0,
 "name": "string",
 "description": "string",
 "state": 0,
 "scheduleXml": "string",
 "startRun": "2024-12-15T15:13:46.004Z",
 "beginRun": "2024-12-15T15:13:46.004Z",
 "lastRun": "2024-12-15T15:13:46.004Z",
 "executeNow": true,
 "removeWhenDone": true
 }
 }
}
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