RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
Headers: Content-Type = application/json OR application/xml Accept = application/json OR application/xml
Response: 200 OK; 400 BAD REQUEST; 404 NOT FOUND, 500 INTERNAL SERVER ERROR
Request: http://localhost:9091/updates/models.json OR http://localhost:9091/updates/models
JSON Request
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "test", "description": "description update" } |
...
{"firmwareVersions":["PR150BN_2.1p5s2_VBN_HYBse","PXD01ANI_2.1p10s1_PROD_sdy"]}
GET http://<host>:<port>/firmwareruletemplate/filtered?name=MAC_RULE&key=someKey
Headers: Accept = application/json, Content-Type = application/json
Request params:
Parameters could be combined:
'?name=someName&value=testValue'
POST http://<host>:<port>/firmwareruletemplate/importAll
Headers: Accept = application/json
Content-Type = application/json
Request body is list of firmware rule templates:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "a1",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "ipAddress"
},
"operation": "IS",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": ""
}
}
}
},
"compoundParts": []
},
"applicableAction": {
"type": ".RuleAction",
"ttlMap": {},
"actionType": "RULE_TEMPLATE",
"active": true,
"firmwareCheckRequired": false,
"rebootImmediately": false
},
"priority": 15,
"requiredFields": [],
"byPassFilters": [],
"editable": true
}
] |
Return list of firmware rule templates' ids which were imported or not:
Response body:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"NOT_IMPORTED": [],
"IMPORTED": []
} |
Response codes: 200, 400, 404, 409
GET http://<host>:<port>/firmwarerule Headers: Accept = application/json
Response body
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "7bc69543-c33a-42c5-97dc-7c21ecf06cdb",
"name": "testName",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "eStbMac"
},
"operation": "IN_LIST",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "mac list"
}
}
}
}
},
"applicableAction": {
"type": ".DefinePropertiesAction",
"ttlMap": {},
"actionType": "DEFINE_PROPERTIES",
"properties": {
"rebootImmediately": "true"
},
"byPassFilters": [],
"activationFirmwareVersions": {}
},
"type": "RI_MACLIST",
"active": true,
"applicationType": "stb"
}
] |
GET http://<host>:<port>/firmwarerule/filtered?tepmlateId=TEST_ID&key=firmwareVersion
Headers: Accept = application/json, Content-Type = application/json
Request params:
'applicationType' param is required.
Parameters could be combined:
'?applicationType=stb&value=someValue'
POST http://<host>:<port>/firmwarerule/importAll
Headers: Accept = application/json Content-Type = application/json
Request body is list of firmware rules:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "7bc69543-c33a-42c5-97dc-7c21ecf06cdb",
"name": "testName",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "eStbMac"
},
"operation": "IN_LIST",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "mac list"
}
}
}
}
},
"applicableAction": {
"type": ".DefinePropertiesAction",
"ttlMap": {},
"actionType": "DEFINE_PROPERTIES",
"properties": {
"rebootImmediately": "true"
},
"byPassFilters": [],
"activationFirmwareVersions": {}
},
"type": "RI_MACLIST",
"active": true,
"applicationType": "stb"
}
] |
Return list of imported and not imported firmware rules' names:
Response body:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"NOT_IMPORTED": [],
"IMPORTED": ["testName"]
} |
Response codes: 200, 400, 404, 409
GET http://<host>:<port>/feature
Headers: Accept = application/json
Response body
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "27a9d55e-0f0c-4809-b171-8357613f0efa",
"name": "name",
"featureName": "featureName",
"effectiveImmediate": false,
"enable": false,
"whitelisted": false,
"configData": {
"key1": "value1"
},
"whitelistProperty": {},
"applicationType": "stb"
}
] |
GET http://<host>:<port>/feature/filtered?
Headers: Accept = application/json, Content-Type = application/json
Request params:
'APPLICATION_TYPE' param is required.
Parameters could be combined:
'?APPLICATION_TYPE=stb&FIXED_ARG=someValue'
POST http://<host>:<port>/feature/importAll
Headers: Accept = application/json Content-Type = application/json
Request body is list of features:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "27a9d55e-0f0c-4809-b171-8357613f0efa",
"name": "name",
"featureInstance": "featureInstance",
"effectiveImmediate": false,
"enable": false,
"whitelisted": false,
"configData": {
"key1": "value1"
},
"whitelistProperty": {},
"applicationType": "stb"
}
] |
Return list of imported and not imported feature ID's:
Response body:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"NOT_IMPORTED": [],
"IMPORTED": ["featureID"]
} |
Response codes: 200, 400, 409
POST http://<host>:<port>/feature
Headers: Accept = application/json Content-Type = application/json
Request body is feature json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "27a9d55e-0f0c-4809-b171-8357613f0efa",
"name": "name",
"featureInstance": "featureInstance",
"effectiveImmediate": false,
"enable": false,
"whitelisted": false,
"configData": {
"key1": "value1"
},
"whitelistProperty": {},
"applicationType": "stb"
} |
Response codes: 201, 400, 409.
Response body: created feature.
PUT http://<host>:<port>/feature
Headers: Accept = application/json Content-Type = application/json
Request body is feature json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "27a9d55e-0f0c-4809-b171-8357613f0efa",
"name": "name",
"featureInstance": "featureInstance",
"effectiveImmediate": false,
"enable": false,
"whitelisted": false,
"configData": {
"key1": "value1"
},
"whitelistProperty": {},
"applicationType": "stb"
} |
Response codes: 201, 400, 404, 409.
Response body: created feature.
DELETE http://<host>:<port>/feature/{id}
Response codes: 204, 404, 409.
GET http://<host>:<port>/featurerule
Headers: Accept = application/json
Response body
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "963b2b7c-d198-4c23-820a-b56ac809c333",
"name": "instance_test",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "testKey"
},
"operation": "IS",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "testValue"
}
}
}
},
"compoundParts": []
},
"priority": 1,
"featureIds": [
"27a9d55e-0f0c-4809-b171-8357613f0efa"
],
"applicationType": "stb"
}
] |
Response codes: 200.
GET http://<host>:<port>/featurerule/filtered?
Headers: Accept = application/json, Content-Type = application/json
Request params:
'APPLICATION_TYPE' param is required.
Parameters could be combined:
'?APPLICATION_TYPE=stb&FIXED_ARG=someValue'
If feature rule with provided id does not exist it is imported otherwise updated.
POST http://<host>:<port>/featurerule/importAll
Headers: Accept = application/json Content-Type = application/json
Request body is list of feature rules:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "963b2b7c-d198-4c23-820a-b56ac809c333",
"name": "instance_test",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "testKey"
},
"operation": "IS",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "testValue"
}
}
}
},
"compoundParts": []
},
"priority": 1,
"featureIds": [
"27a9d55e-0f0c-4809-b171-8357613f0efa"
],
"applicationType": "stb"
}
] |
Return list of imported and not imported feature rule IDs:
Response body:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"NOT_IMPORTED": [],
"IMPORTED": ["featureRuleId"]
} |
Response codes: 200, 400, 404, 409
POST http://<host>:<port>/featurerule
Headers: Accept = application/json Content-Type = application/json
Request body is feature rule json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "963b2b7c-d198-4c23-820a-b56ac809c333",
"name": "instance_test",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "testKey"
},
"operation": "IS",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "testValue"
}
}
}
},
"compoundParts": []
},
"priority": 1,
"featureIds": [
"27a9d55e-0f0c-4809-b171-8357613f0efa"
],
"applicationType": "stb"
} |
Response codes: 201, 400, 404, 409.
Response body: created feature rule.
PUT http://<host>:<port>/featurerule
Headers: Accept = application/json Content-Type = application/json
Request body is feature rule json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "963b2b7c-d198-4c23-820a-b56ac809c333",
"name": "instance_test",
"rule": {
"negated": false,
"condition": {
"freeArg": {
"type": "STRING",
"name": "testKey"
},
"operation": "IS",
"fixedArg": {
"bean": {
"value": {
"java.lang.String": "testValue"
}
}
}
},
"compoundParts": []
},
"priority": 1,
"featureIds": [
"27a9d55e-0f0c-4809-b171-8357613f0efa"
],
"applicationType": "stb"
} |
Response codes: 201, 400, 404, 409.
Response body: created feature rule.
DELETE http://<host>:<port>/featurerule/{id}
Response codes: 204, 404, 409.
GET http://<host>:<port>/amv
Headers: Accept = application/json
Response body
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "42670af7-6ea2-485f-9aee-1fa5895d655b",
"applicationType": "stb",
"description": "Activation Version",
"regularExpressions": [],
"model": "MX011AN",
"firmwareVersions": [
"FIRMWARE_VERSION"
]
}
] |
Response codes: 200.
GET http://<host>:<port>/amv/filtered?
Headers: Accept = application/json, Content-Type = application/json
Request params:
'applicationType' param is required.
Parameters could be combined:
'?APPLICATION_TYPE=stb&MODEL=modelId'
If activation minimum version with provided id does not exist it is imported otherwise updated.
POST http://<host>:<port>/amv/importAll
Headers: Accept = application/json Content-Type = application/json
Request body is list of activation minimum version:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"id": "42670af7-6ea2-485f-9aee-1fa5895d655b",
"applicationType": "stb",
"description": "Activation Version",
"regularExpressions": [],
"model": "MX011AN",
"firmwareVersions": [
"FIRMWARE_VERSION"
]
}
] |
Return list of imported and not imported activation minimum version IDs:
Response body:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"NOT_IMPORTED": [],
"IMPORTED": ["42670af7-6ea2-485f-9aee-1fa5895d655b"]
}
|
Response codes: 200, 400, 404, 409
POST http://<host>:<port>/amv
Headers: Accept = application/json Content-Type = application/json
Request body is activation minimum version json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "42670af7-6ea2-485f-9aee-1fa5895d655b",
"applicationType": "stb",
"description": "Activation Version",
"regularExpressions": [],
"model": "MX011AN",
"firmwareVersions": [
"FIRMWARE_VERSION"
]
} |
Response codes : 201, 400, 404, 409.
Response body: created activation minimum version.
PUT http://<host>:<port>/amv Headers: Accept = application/json Content-Type = application/json
Request body is activation minimum version json object
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "42670af7-6ea2-485f-9aee-1fa5895d655b",
"applicationType": "stb",
"description": "Activation Version",
"regularExpressions": [],
"model": "MX011AN",
"firmwareVersions": [
"FIRMWARE_VERSION"
]
} |
Response codes: 201, 400, 404, 409.
Response body: created activation minimum version.
DELETE http://<host>:<port>/amv/{id}
Response codes: 204, 404, 409.