Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

GET method for ReportDefs

This method returns the definitions of reports.

Description

Returns the definitions of reports.

Privilege

VIEW

HTTP response codes

200

Example response body

{
 "@odata.context": "/api/$metadata#Collection(ReportService.ReportDef)",
 "@odata.count": 21,
 "value": [{
  "@odata.type": "#ReportService.ReportDef",
  "@odata.id": "/api/ReportService/ReportDefs(10042)",
  "Id": 10042,
  "Name": "Alert Counts per Device Report",
  "Description": "This report contains alert counts per severity and totals per Device.",
  "IsBuiltIn": true,
  "LastEditedBy": "admin",
  "LastRunDate": "2018-09-11 15:36:17.05",
  "LastRunBy": "admin",
  "LastRunDuration": "0.38",
  "QueryDef": {
   "FilterId": 10012,
   "ContextId": 2
  },
  "ColumnNames": [{
    "Id": 1000,
    "Name": "Device Name",
    "Width": 30,
    "Sequence": 1
   },
   {
    "Id": 1001,
    "Name": "Device Service Tag",
    "Width": 20,
    "Sequence": 2
   },
   {
    "Id": 1002,
    "Name": "Device Type",
    "Width": 20,
    "Sequence": 3
   },
   {
    "Id": 1003,
    "Name": "Device Model",
    "Width": 30,
    "Sequence": 4
   },
   {
    "Id": 1004,
    "Name": "Critical",
    "Width": 20,
    "Sequence": 5
   },
   {
    "Id": 1005,
    "Name": "Warning",
    "Width": 20,
    "Sequence": 6
   },
   {
    "Id": 1006,
    "Name": "Normal",
    "Width": 20,
    "Sequence": 7
   },
   {
    "Id": 1007,
    "Name": "Info",
    "Width": 20,
    "Sequence": 8
   },
   {
    "Id": 1008,
    "Name": "Total",
    "Width": 20,
    "Sequence": 9
   }
  ],
  "FilterGroupId": 0,
  "QsmQuery": false,
  "ReportResults": {
   "@odata.id": "/api/ReportService/ReportDefs(10042)/ReportResults"
  }
 }]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
Id	Report identifier
Name	Name of the report
Description	Description of the report
IsBuiltIn	Specifies whether it is a built-in report or a custom report
LastEditedBy	Time when report was last edited
LastRunDate	Time when the report was last run
LastRunBy	User who has run the report
LastRunDuration	Duration of the report run.
QueryDef	Information on the filters and context of the report
ColumnNames	Column names in the report
FilterGroupId	ID of the filter group in the report