Versions Compared

Old Version 6

changes.mady.by.user Ganesh Sahu

Saved on

compared with

New Version 7

changes.mady.by.user Abhija Jayan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Info
titleNote

A reference setup of the xconf dataservice is available at https://xconf.rdkcentral.com:9092/ for the community members to get acquainted with xconf. You can replace the <host> , <port> and protocol as xconf.rdkcentral.com, 9092 and https respectively in the placeholders mentioned below in the request samples. Or if you have deployed your own server instance then replace the host and port accordinngly.


Firmware Config

Retrieve a list of firmware configs

...

Code Block
languagephp
themeConfluence
Accept = application/json OR application/xml

applicationType parameter is not required, default value is stb

Response: 200 OK OR 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/firmwares.json OR http://localhost<host>:9091<port>/queries/firmwares


JSON response:

...

Response: 200 OK

Request: 

http://localhost<host>:9091<port>/queries/firmwares/b65962b5-1481-4eed-a010-2abfa8c3bbfd

 OR 

http://localhost<host>:9091<port>/queries/firmwares/b65962b5-1481-4eed-a010-2abfa8c3bbfd.json

...

Response: 200 OK OR 400 BAD REQUEST (if application type has a wrong value)

Request: 

http://localhost<host>:9091<port>/queries/firmwares/model/YETST.json

 OR 

http://localhost<host>:9091<port>/queries/firmwares/model/YETST

...

Responce: 200 OK and saved object (see get request for example); 400 BAD REQUEST (by validation error); 500 INTERNAL SERVER ERROR

Request: 

http://localhost<host>:9091<port>/updates/firmwares.json

 OR 

http://localhost<host>:9091<port>/updates/firmwares

Restrictions: 

...

Response: 204 NO CONTENT and text message: Firmware config successfully deleted OR Config doesn't exist.

Request:

http://localhost<host>:9091<port>/delete/firmwares/b65962b5-1481-4eed-a010-2abfa8c3bbfd

...

Response: 200 OK OR 400 BAD REQUEST (if application type has a wrong value)

Request: 

http://localhost<host>:9091<port>/queries/rules/ips.json

 OR 

http://localhost<host>:9091<port>/queries/rules/ips


JSON response

...

Response: 200 OK OR 400 BAD REQUEST (if application type has a wrong value)

Request: 

http://localhost<host>:9091<port>/queries/rules/ips/fsd.json

 OR 

http://localhost<host>:9091<port>/queries/rules/ips/fsd


JSON response

...

Name, environmentId, modelId should be not empty, IP address group should be specified

Request: 

http://localhost<host>:9091<port>/updates/rules/ips.json 

OR

 http://localhost<host>:9091<port>/updates/rules/ips


JSON request

...

Response: 204 NO CONTENT and message: IpRule successfully deleted OR Rule doesn't exists, 400 BAD REQUEST if applicationType is not valid;

Request: http://localhost<host>:9091<port>/delete/rules/ips/ruleName

...

Response: 200 OK OR 400 BAD REQUEST if applicationType is not valid

Request: 

http://localhost<host>:9091<port>/queries/filters/locations.json 

OR

 http://localhost<host>:9091<port>/queries/filters/locations

...

Response: 200 OK

Request: 

http://localhost<host>:9091<port>/queries/filters/locations/name.json

 OR 

http://localhost<host>:9091<port>/queries/filters/locations/name

...

Condition, models, environments, IPv4, location, any location (HTTP or firmware), IPv4/IPv6 should be valid

Request: 

http://localhost<host>:9091<port>/updates/filters/locations.json

 OR 

http://localhost<host>:9091<port>/updates/filters/locations

...

Response: 204 NO CONTENT and message: Location filter successfully deleted OR Filter doesn't exist with name: <filterName>, 400 BAD REQUEST if applicationType is not valid

Request: http://localhost<host>:9091<port>/delete/filters/location/name

...

Response: 200 OK, 400 BAD REQUEST if applicationType is not valid

Request: 

http://localhost<host>:9091<port>/queries/filters/downloadlocation.json

 OR 

http://localhost<host>:9091<port>/queries/filters/downloadlocation

...

Location URL, IPv4/IPv6 should be valid, percentage should be positive and within [0, 100], locations should be not duplicated

Request: 

http://localhost<host>:9091<port>/updates/filters/downloadlocation.json 

OR 

http://localhost<host>:9091<port>/updates/filters/downloadlocation.json

...

Response: 200 OK, 400 BAD REQUEST if applicationType is not valid

Request: 

http://localhost<host>:9091<port>/queries/rules/envModels.json 

OR 

http://localhost<host>:9091<port>/queries/rules/envModels


JSON response

...

Response: 200 OK, 400 BAD REQUEST if applicationType is not valid

Request: 

http://localhost<host>:9091<port>/queries/rules/envModels/testName.json 

OR 

http://localhost<host>:9091<port>/queries/rules/envModels/testName.json

...

Name, environment, model should be not empty, name is used only once, env/model should not overlap each other

Request: 

http://localhost<host>:9091<port>/updates/rules/envModels.json

 OR 

http://localhost<host>:9091<port>/updates/rules/envModels


JSON request

...

Response: 204 NO CONTENT and message: Rule successfully deleted OR Rule doesn't exist with name: <ruleName>, 400 if applicationType is not valid

Request: http://localhost<host>:9091<port>/delete/rules/envModels/testName.json

...

Responce: 200 OK, 400 BAD REQUEST

Request: 

http://localhost<host>:9091<port>/queries/filters/ips.json

 OR 

http://localhost<host>:9091<port>/queries/filters/ips 


JSON response

...

Responce: 200 OK, 400 BAD REQUEST if applicationType is not valid

Request: 

http://localhost<host>:9091<port>/queries/filters/ips/namef.json 

OR 

http://localhost<host>:9091<port>/queries/filters/ips/namef.json

...

Name, IP address group should be not empty

Request: 

http://localhost<host>:9091<port>/updates/filters/ips.json

 OR 

http://localhost<host>:9091<port>/updates/filters/ips


JSON request

...

Response: 204 NO CONTENT and message: IpFilter successfully deleted OR Filter doesn't exist with name: <filterName>, 400 BAD REQUEST if applicationType is not valid

Request: http://localhost<host>:9091<port>/delete/filters/ips/namef

...

Responce: 200 OK, 400 BAD REQUEST if applicationType is not valid


Request: 

http://localhost<host>:9091<port>/queries/filters/percent.json 

OR 

http://localhost<host>:9091<port>/queries/filters/percent


Note

...

Responce: 200 OK, 400 BAD REQUEST if applicationType is not valid

Request: http://localhost<host>:9091<port>/queries/filters/percent?field=fieldName

...

Percentage should be positive and within [0, 100],  

Request: 

http://localhost<host>:9091<port>/updates/filters/percent.json 

OR

http://localhost<host>:9091<port>/updates/filters/percent


JSON request

...

Responce: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/percentageBean


JSON response

...

Responce: 200 OK OR 404 if envModelPercentage is not found

Request: http://localhost<host>:9091<port>/queries/percentageBean/4c2cea9e-c1be-4219-8f2a-70084f1cb648

...

Responce: 200 OK, 404 NOT FOUND, 409 CONFLICT, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/percentageBean

Restrictions:

...

Responce: 200 OK, 404 NOT FOUND, 409 CONFLICT, 400 BAD REQUEST

 Request: http://localhost<host>:9091<port>/queries/percentageBean 

Restrictions:

...

Response: 204 NO CONTENT OR 404 NOT FOUND

Request example: http://localhost<host>:9091<port>/delete/percentageBean/testId

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/filters/time.json OR http://localhost<host>:9091<port>/queries/filters/time

JSON response

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/filters/time/xcc.td.json OR http://localhost<host>:9091<port>/queries/filters/time/xcc.td

...

Name should be unique

Request: http://localhost<host>:9091<port>/updates/filters/time.json OR http://localhost<host>:9091<port>/updates/filters/time

JSON request

...

Response: 204 NO CONTENT and message: Time Filter successfully deleted OR Filter doesn't exist with name: <filterName>

Request example: http://localhost<host>:9091<port>/delete/filters/time/name

...

Response: 200 OK

Request: http://localhost<host>:9091<port>/queries/environments OR http://localhost<host>:9091<port>/queries/environments.json

...

Response: 200 OK; 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/environments/DEV OR http://localhost<host>:9091<port>/queries/environments/DEV.json

...

Environment name should be valid by pattern: ^[a-zA-Z0-9]+$, name should be unique

Request: http://localhost<host>:9091<port>/updates/environments OR http://localhost<host>:9091<port>/updates/environments.json

...

Environment should be not used

Request: http://localhost<host>:9091<port>/delete/environments/DEV

IP address group

...

Request: Request: http://localhost<host>:9091<port>/queries/ipAddressGroups OR http://localhost<host>:9091<port>/queries/ipAddressGroups.json

...

Response: 200 OK; 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/ipAddressGroups/byName/test/.json OR http://localhost<host>:9091<port>/queries/ipAddressGroups/byName/test/

...

Response: 200 OK; 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/ipAddressGroups/byIp/192.11.11.121/.json OR http://localhost<host>:9091<port>/queries/ipAddressGroups/byIp/192.11.11.121/

...

Name should be not empty and unique

Request: http://localhost<host>:9091<port>/updates/ipAddressGroups.json OR http://localhost<host>:9091<port>/updates/ipAddressGroups

XML request

...

ipAddressGroup with current id should be exist, see restrictions for create operation

Request: http://localhost<host>:9091<port>/updates/ipAddressGroups/ipAddressGroup_name/addData.json OR http://localhost<host>:9091<port>/updates/ipAddressGroups/ipAddressGroup_name/addData

...

List contains IPs, which should be present in current Namespaced list, namespaced list should contain at least one IP address, and restrictions for create operation

Request: http://localhost<host>:9091<port>/updates/ipAddressGroups/ipAddressGroup_name/removeData.json OR http://localhost<host>:9091<port>/updates/ipAddressGroups/ipAddressGroup_name/removeData

...

IP address group should be not used

Request: http://localhost<host>:9091<port>/delete/ipAddressGroups/607b315b-c744-4c43-87fa-51b17aa92b09

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/rules/macs.json OR http://localhost<host>:9091<port>/queries/rules/macs

JSON response

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/rules/macs.json?version=2 OR http://localhost<host>:9091<port>/queries/rules/macs?version=2

...

Response: 200 OK; 

Request: http://localhost<host>:9091<port>/queries/rules/macs/test.json OR http://localhost<host>:9091<port>/queries/rules/macs/test

JSON response

...

Response: 200 OK; 

Request: http://localhost<host>:9091<port>/queries/rules/macs/test.json?version=2 OR http://localhost<host>:9091<port>/queries/rules/macs/test?version=2

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/rules/macs/address/AA:AA:AA:AA:AA:AA.json OR http://localhost<host>:9091<port>/queries/rules/macs/address/AA:AA:AA:AA:AA:AA

...

 Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/rules/macs/address/AA:AA:AA:AA:AA:AA.json?version=2 OR http://localhost<host>:9091<port>/queries/rules/macs/address/AA:AA:AA:AA:AA:AA?version=2

...

Name, mac address list, model list, mac list, firmware configuration should be not empty, mac address list is never used in another rule, model list contain only existed model, firmware config should support given models

Request: http://localhost<host>:9091<port>/updates/rules/macs.json OR http://localhost<host>:9091<port>/updates/rules/macs

JSON request

...

Response: 204 NO CONTENT and message: MacRule does'n exist OR MacRule deleted successfully, 400 BAD REQUEST

Request example: http://localhost<host>:9091<port>/delete/rules/macs/macRuleName

...

Response: 200 OK

Request: http://localhost<host>:9091<port>/queries/models.json OR http://localhost<host>:9091<port>/queries/models

JSON response

...

Response: 200 OK; 204 NO CONTENT

Request: http://localhost<host>:9091<port>/queries/models/YETST.json OR http://localhost<host>:9091<port>/queries/models/YETST

JSON response

...

Model name should be unique and valid by pattern: ^[a-zA-Z0-9]+$ 

Request: http://localhost<host>:9091<port>/updates/models.json OR http://localhost<host>:9091<port>/updates/models

JSON request

...

Model should be not used in another places

Request: http://localhost<host>:9091<port>/delete/models/YETST

NamespacedList

...

Response: 200 OK

Request: http://localhost<host>:9091<port>/queries/nsLists.json OR http://localhost<host>:9091<port>/queries/nsLists

JSON response

...

Response: 200 OK

Request: http://localhost<host>:9091<port>/queries/nsLists/byId/macs.json OR http://localhost<host>:9091<port>/queries/nsLists/byId/macs

...

Response: 200 OK

Request: http://localhost<host>:9091<port>/queries/nsLists/byMacPart/AA:AA.json OR http://localhost<host>:9091<port>/queries/nsLists/byMacPart/AA:AA

...

Name should be valid by pattern: ^[a-zA-Z0-9]+$, list data should be not empty and contain valid mac addresses, mac address should be used only in one NS list

Request: http://localhost<host>:9091<port>/updates/nsLists.json OR http://localhost<host>:9091<port>/updates/nsLists

JSON request

...

NS list with current id should be exist, see restrictions for create operation

Request: http://localhost<host>:9091<port>/updates/nsLists/listName/addData.json OR http://localhost<host>:9091<port>/updates/nsLists/listName/addData

...

List contains MACs, which should be present in current Namespaced list, namespaced list should contain at least one MAC address, and restrictions for create operation

Request: http://localhost<host>:9091<port>/updates/nsLists/listName/removeData.json OR http://localhost<host>:9091<port>/updates/nsLists/listName/removeData

...

NS list should be not used in another places

Request: http://localhost<host>:9091<port>/delete/nsLists/listName.json OR http://localhost<host>:9091<port>/delete/nsLists/listName

RebootImmediately filter

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/filters/ri.json OR http://localhost<host>:9091<port>/queries/filters/ri

JSON response

...

Response: 200 OK, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/queries/filters/ri/testName.json OR http://localhost<host>:9091<port>/queries/filters/ri/testName

...

Name should be not empty, at least one of filter criteria should be specified, mac addresses should be valid

Request: http://localhost<host>:9091<port>/updates/filters/ri.json OR http://localhost<host>:9091<port>/updates/filters/ri

JSON request

...

Response: 204 NO CONTENT and message: Filter does't exist OR Successfully deleted, 400 BAD REQUEST

Request: http://localhost<host>:9091<port>/delete/filters/ri/testName

...