/services/reportout

Provides APIs to retrieve output of report runs.

The following resources are applicable:

/reportout/{id}/{colIndex}/{rowId}

GET

Gets the CSV content specified by the jobid, column index and rowId. This API is used to retrieve the CSV content of a row in the report.

Parameters

name description type default
id Job ID path
colIndex The column number in the report output table. path
rowId (no documentation provided) path

Response Body

element: (custom)
media types: application/json

(no documentation provided)

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable

/reportout/{jobid}

GET

Gets the report output for a job (defined by jobid)

Parameters

name description type default
jobid the ID of the report job path
page starting page (default is first page) query 1
nPerPage number of rows per page query
sorts the sort direction query
filters the sort (column) filter query

Response Body

element: jobReportOutput
media types: text/plain
application/json

the output for the job

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable

/reportout/{jobid}/summary

GET

Gets the summary a table for the report. The summary table includes 2 columns: the left column are the parameters of the report and the right column includes the values for these parameters.

Example: The following query 

matelive/services/reportout/56/summary

returns a typical summary table that may look something like (in JSON format) 

{
  "summary": [
    [ "Group",  "10000"    ],
    [ "Sub-Group", "10000" ],
    [ "Generated on", "2014-08-20 21:14:58" ],
    [ "Time range", "2012-12-31 19:30:00 - 2013-01-07 19:30:00" ],
    [ "Measurements", "TraffIn over TraffOut (P95)" ],
    [ "Raw Interval", "900000" ],
    [ "Output Mode", "Individual Objects" ],
    [ "Definition ID", "62" ],
    [ "Category", "Interfaces" ],
    [ "Report Type", "Ad Hoc" ]
  ]
}

Parameters

name description type default
jobid the report job ID path

Response Body

element: uiReportSummaryTable
media types: text/plain
application/json

summary table for the report

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable

/reportout/{jobid}/table

GET

Gets the data table output for the report identified by ID jobid. This API supports pagination via query parameters.

Example:matelive/report/56/table?page=1

returns a UiTable that may look like 

{
  "jsType": "UiTable",
    "tableName": null,
    "headers": [
      "Node",
      "Name",
      "TraffIn over TraffOut (P95)",
      "rowId"
    ],
    "dataTypes": [
      "String",
      "String",
      "Double",
      "int"
    ],
  "drillDowns": ["false","false", "false", null],
  "keyColumns": [ 0, 1 ],
  "rows": null,
  "currentPage": 1,
  "sorts": [
    {
      "colIndex": 0,
      "sortDir": "inc"
    },
    {
      "colIndex": 1,
      "sortDir": "inc"
    }
  ],
  "totalRows": 7069,
  "origRows": 0,
  "nPerPage": 0,
  "csvUrl": "data/report/56_62_20140820T211424/0.csv",
  "filters": null
}

Parameters

name description type default
jobid the ID of the report job path
page (optional) the page to retrieve query 1
nPerPage (optional) the number of rows per page query
sorts (optional) the sort column indexes query
filters (optional) the filters query
format (optional) query parameter specifying what format to return. This applies to ML object types that support hierarchical structure (e.g., Inventory). If specified as tree, the hierarchical table is returned query

Response Body

element: uiTable
media types: text/plain
application/json

(no documentation provided)

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable

/reportout/{jobid}/tableData

GET

Gets the table output for the report

Parameters

name description type default
jobid (no documentation provided) path

Response Body

element: uiTable
media types: text/plain
application/json

(no documentation provided)

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable

/reportout/{jobid}/title

GET

Gets the title of the report produced by report job (jobid)

Parameters

name description type default
jobid the ID of the report job path

Response Body

element: (custom)
media types: text/plain

the title of the report

Status Codes

HTTP Status Code Description
200 OK OK; the resource was updated successfully
400 Bad Request bad or malformed request
404 Not Found the resource does not exist
406 Not Acceptable required representation is not supported by the server
500 Internal Server Error internal server error
503 Service Unavailable service is unavailable