GetStoredReportConfiguration

Returns the attributes that define the configuration of the provided Report ID.

URL

GET /api/Report/GetStoredReportConfiguration/{id}

GetStoredReportConfiguration method

 

Parameter Required Description Type
id Required Report Id

string ($uuid)

(path)

Responses

Code Description Links
200 Success No links
 

Media Type

text/plain

application/json

text/json

  
  Example Value | Schema  
  
{
  "info": {
    "start": 0,
    "limit": 0,
    "isPaging": true,
    "pageIndex": 0,
    "order": [
      {
        "ascending": true,
        "field": "string"
      }
    ],
    "groups": [
      {
        "ascending": true,
        "field": "string"
      }  
] 
},
  "filter": {
    "valueType": 0,
    "useExists": true,
    "operator": 0,
    "values": [
      {}
    ]
  },
  "cancellationToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "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-13T19:21:58.604Z",
      "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
  }
}
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