Function | Request | Response | Remarks |
---|
cacheContains | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.cacheContains","params":{"key":"sampleKey"}}' | {"jsonrpc":"2.0","id":3,"result":{"success":true}} |
|
clearLastDeepSleepReason | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.clearLastDeepSleepReason","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"success":true}} |
|
getAvailableStandbyModes | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getAvailableStandbyModes","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"supportedStandbyModes":["LIGHT_SLEEP", "DEEP_SLEEP"],"success":true}} |
|
getCachedValue | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCachedValue","params":{"key":"sampleKey"}}' | {"jsonrpc":"2.0","id":3,"result":{"sampleKey":"4343.3434","success":true}} |
|
getCoreTemperature | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCoreTemperature","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"temperature":48.000000,"success":true}} |
|
getDeviceInfo | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDeviceInfo","params":{"paramparams":["estb_mac"]}}' | {"jsonrpc":"2.0","id":3,"result":{"ecm_mac/estb_mac":"AA:BB:CC:DD:EE:FF:GG","success":true}} |
|
getDownloadedFirmwareInfo | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDownloadedFirmwareInfo","params":{}}' | {"jsonrpc":"2.0","id"3,"result" {"currentFWVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy",
"downloadedFWVersion":"AX061AEI_VBN_1911_sprint_20200510040450sdy",
"downloadedFWLocation":"","isRebootDeferred":false,"success":true}}
|
|
getFirmwareDownloadPercent | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareDownloadPercent","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"downloadPercent":25,"success":true}} |
|
getFirmwareUpdateInfo | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateInfo","params":{"param":{"GUID":"1234abcd"}}}' | {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true}} |
|
getFirmwareUpdateState | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateState","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"firmwareUpdateState":"Download Complete","success":true}} |
|
getLastDeepSleepReason | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getLastDeepSleepReason","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"lastDeepSleepReason":"thermal_deepsleep_critical_threshold","success":true}} |
|
getMacAddresses | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMacAddresses","params":{"GUID":"61734787891723481"}}' | {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true,"success":true}} |
|
getMilestones | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.getMilestones","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"milestones":["RDK_STARTED:8893","SEND_DHCP_REQUEST:9530","RECV_DHCP_RESPONSE:9602","UPNP_START_DISCOVERY:12863","UPNP_START_DISCOVERY:13618","IP_ACQUISTION_COMPLETED:15716","IP_ACQUISTION_COMPLETED:16470","2020 Sep 24 20:32:49.688454 raspberrypi-rdk-mc systemd[1]: Starting Log RDK Started Service...","-- Subject: Unit log-rdk-start.service has begun start-up","-- Defined-By: systemd","-- Support: http://lists.freedesktop.org/mailman/listinfo/systemd-devel","-- ","-- Unit log-rdk-start.service has begun starting up.","2020 Sep 24 20:32:50.088253 raspberrypi-rdk-mc systemd[1]: Started Log RDK Started Service.","-- Subject: Unit log-rdk-start.service has finished start-up","-- Defined-By: systemd","-- Support: http://lists.freedesktop.org/mailman/listinfo/systemd-devel","-- ","-- Unit log-rdk-start.service has finished starting up.","-- ","-- The start-up result is done."],"success":true}} |
|
getMode | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMode","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"modeInfo":{"mode":"NORMAL","duration":0},"success":true}} |
|
getPowerState | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPowerState","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"powerState":"ON", "success":true}} |
|
getPreferredStandbyMode | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreferredStandbyMode","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"preferredStandbyMode":"DEEP_SLEEP","success":true}} |
|
getPreviousRebootInfo | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfo","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"timeStamp":"20200128083540","reason":"Triggered from System Plugin API Validation","success":true}} |
|
getPreviousRebootInfo2 | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfo2","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"rebootInfo":{"timestamp":"Tue Jan 28 08:35:40 UTC 2020","source":"SystemPlugin","reason":"FIRMWARE_FAILURE","customReason":"API Validation","lastHardPowerReset":"Tue Jan 28 08:22:22 UTC 2020"},"success":true}} |
|
getPreviousRebootReason | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootReason","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"RFCConfig":{"Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID":"1181405614235499371","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled":"Empty response received","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled":"Empty response received","Device.DeviceInfo.MemoryStatus.Total":"1144560","Device.DeviceInfo.MemoryStatus.Free":"732144"},"success":true}} |
|
getRFCConfig | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getRFCConfig","params":{"rfcList":["Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled","Device.DeviceInfo.MemoryStatus.Total","Device.DeviceInfo.MemoryStatus.Free"]}}' | {"jsonrpc":"2.0","id":3,"result":{"RFCConfig":{"Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID":"1181405614235499371","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled":"Empty response received","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled":"Empty response received","Device.DeviceInfo.MemoryStatus.Total":"1144560","Device.DeviceInfo.MemoryStatus.Free":"732144"},"success":true}} |
|
getSerialNumber | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSerialNumber","params":{}}' | {"jsonrpc":"2.0","id":3,"result":{"serialNumber":"M11806TK0024","success":true}} |
|
getStateInfo | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getStateInfo","params":{"param":"com.comcast.channel_map"}}' | {"jsonrpc":"2.0","id":3,"result":{"com.comcast.channel_map”:2, “success”:true}} |
|
getSystemVersions | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSystemVersions","params":{}}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"stbVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","receiverVersion":"3.14.0.0","stbTimestamp":"Thu 09 Jan 2020 04:04:24 AP UTC","success":true }}
|
|
getTemperatureThresholds | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTemperatureThresholds","params":{}}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"temperatureThresholds":{"WARN":"100.000000","MAX":"110.000000","temperature":"48.000000"},"success":true} }
|
|
getTimeZoneDST | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.getTimeZoneDST" , "params" :{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"timeZone":"America/New_York","success":true }}
|
|
getXconfParams | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.getXconfParams" , "params" :{}} '
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"xconfParams":{"env":"vbn","eStbMac":"20:F1:9E:EE:62:08","model":"AX061AEI","firmwareVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy"},"success":true }}
|
|
hasRebootBeenRequested | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.hasRebootBeenRequested" , "params" :{ }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "rebootRequested" :false, "success" :true}}
|
|
isGzEnabled | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.isGzEnabled" , "params" :{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "enabled":false , "success" :true}}
|
|
queryMocaStatus | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.queryMocaStatus" , "params" :{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "mocaEnabled" :true, "success" :true}}
|
|
reboot | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.reboot" , "params" :{ "rebootReason":"API Validation" }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"IARM_Bus_Call_STATUS":1,"success":true} }
|
|
removeCacheKey | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.removeCacheKey" , "params" :{key:"sampleKey" }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"success":true} }
|
|
requestSystemUptime | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.requestSystemUptime" , "params" :{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"systemUptime":"1666.92","success":true }}
|
|
setCachedValue | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setCachedValue" , "params" :{"key":"sampleKey","value":4343.3434 }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"success":true} }
|
|
setDeepSleepTimer | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setDeepSleepTimer" , "params" :{ "seconds" :3 }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
setGzEnabled | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setGzEnabled" , "params" :{ "enabled" :true}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
set STB mode | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setGzEnabled" , "params" :{ "modeInfo" :{ "mode" : "NORMAL" , "duration" :20 }}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
setGzEnabled | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setPowerState" , "params" :{"powerState":"STANDBY", "standbyReason":"APIUnitTest" }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
setPreferredStandbyMode | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setPreferredStandbyMode" , "params" :{"standbyMode":"DEEP_SLEEP" }}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
setTemperatureThresholds | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setTemperatureThresholds" , "params" :{"thresholds":{"WARN":"50.000000","MAX":"80.000000" }}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{"success":true} }
|
|
setTimeZoneDST | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.setTimeZoneDST" , "params" :{"timeZone":"UTC-5"}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|
updateFirmware | curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.System.1.updateFirmware" , "params" :{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" :true}}
|
|