REST — GetExecute

Use the GetExecute methods to execute reports in the API without opening an instance of Exago. If executing as text, that is HTML, CSV, or JSON, then the output data is returned directly in the ExecuteData property.

If executing as binary (that is PDF, RTF, or Excel workbook), then ExecuteData will return different responses depending on if Exago is running in a web-farm environment or not.

All requests require a Session Id URL parameter and basic request headers. In the following topic, headers are omitted in the interest of brevity.

Since GetExecute does not load the full Exago user interface, report interactivity is not supported for these functions. However, the following Server Events are triggered by GetExecute in order to ensure that the data returned accurately reflects the report design:

• Global Event: OnReportExecuteInit
• Global Event: OnReportExecuteStart
• Global Event: OnReportExecuteEnd
• Global Event: OnAfterReportExportSuccess

Report JSON

The path to the report is passed as part of a JSON object, with optional sorts and filters. Any sorts and filters are added only for this execution, and do not persist throughout the session.

Execute a Report

Type indicates which format you want to receive the output data: html, csv, pdf, pdfsnapshot, rtf, excel, json.

POST /Reports/Execute/{Type}

Using curl

curl http://{webservice}/rest/Reports/Execute/csv?sid={sid} -X POST ^
	-d "{'ReportPath':'Inventory\\Products'}"

Windows file paths are delimited with double-backslashes: \\. With Storage Management in v2020.1+, the double slash is no longer necessary.

Output JSON

GetExecute returns the following JSON object:

Examples

Output a CSV file:

POST /rest/Reports/Execute/csv

Status: 200 OK

{
  "ReportPath":  "Inventory\\Categories",
  "ExportType":  "csv",
  "DataType":    "Data",
  "ExecuteData": ""Categories"\r\n"Beverages"\r\n"Condiments"\r\n"Confections"\r\n"Dairy Products"\r\n"Grains/Cereals"\r\n"Meat/Poultry"\r\n"Produce"\r\n"Seafood"\r\n",
  "IsError":     false,
  "ErrorList":   null
}

Output a PDF file:

POST /rest/Reports/Execute/pdf

Status: 200 OK
{
	"ReportPath": "Products",
	"ExportType": "Pdf",
	"DataType": "Data",
	"ExecuteData": "JVBERi0xLjQKJeLjz9MKMyAwIG9iaiA8PC9MZW5ndGggNDE5NC9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nO2dW3PbNhaA3/0r+NCZdmfWXBAEL3h00jbbrdu0SbDAxODgyNCAwMDAwMCBuIAowMDAwMDE5MjU2IDAwMDAwIG4gCjAwMDAwMTkzMDEgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDE2L0luZm8gMTUgMCBSL0lEIFs8ZDEyNmY0ZDQ2ZDI4OGUwNTA1YWM2MGZlYTMwOTBmYTM+PDYwNTE5NjU1NGM1OWVlODI2YmNkNzdiNDFjZmM4YWI5Pl0vUm9vdCAxNCAwIFI+PgpzdGFydHhyZWYKMTk0NDYKJSVFT0YK",
	"IsError": false,
	"ErrorList": null
}

Sort JSON

Each run-time sort is supplied using the following JSON object:

Filter JSON

Each run-time filter is supplied using the following JSON object:

DateTime strings passed as filter values must be able to be parsed by the .NET method DateTime.Parse using the current thread culture.

Execute with Sorts and Filters

Type indicates which format you want to receive the output data: html, csv, pdf, pdfsnapshot, rtf, excel, json.

POST /rest/Reports/Execute/{Type}

Using curl

curl http://{webservice}/rest/Reports/Execute/csv?sid={sid} -X POST ^
	-d @reportExecuteResource.txt

reportExecuteResource.txt

"{
  'ReportPath': 'Inventory\\Categories',
  'Sorts': [
    {
      'EntityName': 'Categories',
      'ColumnName': 'CategoryName',
      'AscendingFlag': false
    }
  ],
  'Filters': [
    {
      'FilterText': 'Category.CategoryName'
      'DataType': 'string',
      'Operator': 14,
      'Values': [
        'Beverages',
        'Produce',
        'Seafood'
      ],
    }
  ]
}"

Example response

Status: 200 OK

{
  "ReportPath":  "Inventory\\Categories",
  "ExportType":  "csv",
  "DataType":    "Data",
  "ExecuteData": ""Categories"\r\n"Seafood"\r\n"Produce"\r\n"Beverages"\r\n",
  "IsError":     false,
  "ErrorList":   null
}