Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

User will need an opDashOperatorRole access for this API

Run reportby reference:

GET /op/api/v1/reports/00000000-0000-0000-0000-a10000000001

{  
  "executionID":51,
  "reportName":"Device CPU",
  "message":"Report Executed",
  "status":"OK"
}

Example of an error:

{
"summary":"Exception:Reference 2F522097-7F15-4C91-91C7-4B566ABA136X not found in Reports table (org.montier.reports.rest.ReportResource.executeReport(ReportResource.java:59))",
"message":"Reference 2F522097-7F15-4C91-91C7-4B566ABA136X not found in Reports table",
"status":"error"
}


Get all available reports:

GET  /op/api/v1/reports/
The lastUpdateTime field returns the last time the alert was updated in epoch time format

{
"reports":[
{
"name":"Executed Transactions Report",
"description":"List of all executed transactions",
"URI":"/op/api/v1/reports/e123a124-647f-4de0-9b3e-71875e7eee90",
"lastUpdateTime":1529941818967
},
{
"name":"Device Resources Report",
"description":"All device resources samples",
"URI":"/op/api/v1/reports/65beb0d6-7f78-4b48-a6cb-cd21a7c3a983",
"lastUpdateTime":1529941818971
},
{
"name":"Message Codes Count Report",
"description":"Message codes distribution",
"URI":"/op/api/v1/reports/61e12f8f-97bc-4cd2-8fc3-b9c4dc9b0d8e",
"lastUpdateTime":1529941818976
},
{
"name":"Device CPU",
"description":"Devices ordered by average CPU",
"URI":"/op/api/v1/reports/2F522097-7F15-4C91-91C7-4B566ABA136F",
"lastUpdateTime":1529852908149
}
]
}