KSC Reports

GETs (reading data)

KSC Reports API GET functions
Resource	Description
/ksc	Get a list of all KSC reports, including ID and label.
/ksc/{reportid}	Get a specific KSC report, by ID.
/ksc/count	Get a count of all KSC reports.

PUT (modifying data)

KSC Reports API PUT function
Resource	Description
/ksc/{reportid}	Modify a report with the given ID.

POSTs (Creating Data)

POST requires XML using application/xml as its Content-Type.

Resource

Description

/ksc

Create a report from an XML payload.

DELETEs (Removing Data)

Resource

Description

none

not supported

Examples using cURL

Get a list of all KSC reports

curl -u admin:admin "http://127.0.0.1:8980/opennms/rest/ksc"

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kscReports count="1" offset="0" totalCount="1">
  <kscReport id="0" label="Report_Title"/>
</kscReports>

Create a report

curl -u admin:admin -H 'Content-Type: application/xml' -d @ksc.xml http://localhost:8980/opennms/rest/ksc

XML Payload ksc.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kscReport
  id="1"(1)
  label="JVM Heap"(2)
  show_timespan_button="true"(3)
  show_graphtype_button="true"(4)
  graphs_per_line="2">(5)
  <kscGraph
     title="Heap Memory Usage"(6)
     timespan="7_day"(7)
     graphtype="heap.memory"(8)
     resourceId="node[selfmonitor:1].interfaceSnmp[opennms-jvm]"(9)
     />
</kscReport>

1	id is required.
2	label is required.
3	Optional; defaults to false
4	Optional; defaults to false
5	Optional; default 1
6	Graph title is required
7	Optional, defaults to 7 days
8	From graph definition in snmp-graph.properties.d, this is the report.name
9	Required; the timeseries resourceId.