Web Services

Execute a report

Execute a Report.

POST

/web-services/gb/reporting/executeReport

Execute a report

curl --request POST \
  --url https://api.catch-e.com/web-services/gb/reporting/executeReport \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/vnd.catch-e-api.v1+json' \
  --data '
{
  "arguments": {
    "use_supplied_report_path_flag": "no"
  },
  "parameters": {
    "date_filter": "01/02/2023",
    "fbt_year_ending": "2023,",
    "filter_suspend_date": "00/00/0000",
    "fm_con_contract_id": "123456",
    "fm_con_fbt_email_flag": "no",
    "fm_con_reg_no": "ABC123",
    "fm_dri_driver_id": "123456",
    "module_code": "fm_",
    "report_date": "01/07/2023",
    "t1.contract_id": "123456"
  },
  "report_format": "PDF",
  "report_path": "/core/fleet/reports/pdf_novated_driver_budgeted_with_transactions.phpo"
}
'

<string>

This method requires the WebServices permission to be associated with your role.

This API invokes the legacy executeReport web service. Note, this endpoint will be deprecated once a full service replacement has been developed.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

JSON payload

argumentsobject

(Optional) Report execution modifier arguments

parametersobjectrequired

Report parameters

These parameters will vary significantly depending on the report_path specified

report_formatenum<string>default:PDFrequired

Type	Description
PDF	Creates 1 or multiple PDF documents directly using FPDF
Text(CSV)	Creates a CSV file
ExcelXml	Replaces field placeholders with record data in a text based template
Field-List	Used to generate a list of available fields from the report template

Available options: PDF, Text(CSV), ExcelXml, Field-List

report_pathstringrequired

Report path to execute

Example: /core/fleet/reports/pdf_novated_driver_budgeted_with_transactions.phpo

Response

Success

bodystring

Still need help? Ask the team