RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Page History
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "12b620bd-2e74-4467-91e5-c29657022c05", |
...
"name": "re", |
...
"firmwareConfig": { |
...
"id": "f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1", |
...
"description": "prav_Firm", |
...
"supportedModelIds": [ |
...
"PX013ANM", |
...
"PX013ANC" |
...
], |
...
"firmwareFilename": "PX013AN_2.1s11_VBN_HYBse-signed.bin", |
...
"firmwareVersion": "PX013AN_2.1s11_VBN_HYBse-signed" |
...
}, |
...
"environmentId": "TEST", |
...
"modelId": "PX013ANC" |
...
}, |
...
{ |
...
"id": "3609a195-ecd3-4950-8583-ceb2f6f6f16b", |
...
"name": "uuuuuuu", |
...
"environmentId": "DEV", |
...
"modelId": "YETST" |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <id>12b620bd-2e74-4467-91e5-c29657022c05</ |
...
id> <name>re</name> <firmwareConfig> <id>f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1</ |
...
id> <description>prav_Firm</ |
...
description> <supportedModelIds> <supportedModelIds>PX013ANM</supportedModelIds> <supportedModelIds>PX013ANC</supportedModelIds> </supportedModelIds> <firmwareFilename>PX013AN_2.1s11_VBN_HYBse-signed.bin</ |
...
firmwareFilename> <firmwareVersion>PX013AN_2.1s11_VBN_HYBse-signed</ |
...
firmwareVersion> </firmwareConfig> <environmentId>TEST</environmentId> <modelId>PX013ANC</modelId> </item> <item> <id>3609a195-ecd3-4950-8583-ceb2f6f6f16b</ |
...
id> <name>uuuuuuu</name> <environmentId>DEV</environmentId> <modelId>YETST</modelId> </item> </ArrayList> |
Retrieve an environment model rule by name
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{ |
...
"id": "12b620bd-2e74-4467-91e5-c29657022c05", |
...
"name": "testName", |
...
"firmwareConfig": { |
...
"id": "f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1", |
...
"description": "prav_Firm", |
...
"supportedModelIds": [ |
...
"PX013ANM", |
...
"PX013ANC" |
...
], |
...
"firmwareFilename": "PX013AN_2.1s11_VBN_HYBse-signed.bin", |
...
"firmwareVersion": "PX013AN_2.1s11_VBN_HYBse-signed" |
...
}, |
...
"environmentId": "TEST", |
...
"modelId": "PX013ANC" |
...
} |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<EnvModelRuleBean> <id>12b620bd-2e74-4467-91e5-c29657022c05</ |
...
id> <name>testName</name> <firmwareConfig> <id>f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1</ |
...
id> <description>prav_Firm</ |
...
description> <supportedModelIds> <supportedModelIds>PX013ANM</supportedModelIds> <supportedModelIds>PX013ANC</supportedModelIds> </supportedModelIds> <firmwareFilename>PX013AN_2.1s11_VBN_HYBse-signed.bin</ |
...
firmwareFilename> <firmwareVersion>PX013AN_2.1s11_VBN_HYBse-signed</ |
...
firmwareVersion> </firmwareConfig> <environmentId>TEST</environmentId> <modelId>PX013ANC</modelId> </EnvModelRuleBean> |
Create/update an environment model rule
If EnvModelRule is missing it will be being created, otherwise updated. For update operation id field is not needed.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "id": "12b620bd-2e74-4467-91e5-c29657022c05", |
...
"name": "testName", |
...
"firmwareConfig": { |
...
"id": "f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1", |
...
"description": "prav_Firm", |
...
"supportedModelIds": [ |
...
"PX013ANM", |
...
"PX013ANC" |
...
], |
...
"firmwareFilename": "PX013AN_2.1s11_VBN_HYBse-signed.bin", |
...
"firmwareVersion": "PX013AN_2.1s11_VBN_HYBse-signed" |
...
}, |
...
"environmentId": "TEST", |
...
"modelId": "PX013ANC" |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<EnvModelRuleBean> <id>12b620bd-2e74-4467-91e5-c29657022c05</ |
...
id> <name>testName</name> <firmwareConfig> <id>f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1</ |
...
id> <description>prav_Firm</ |
...
description> <supportedModelIds> <supportedModelIds>PX013ANM</supportedModelIds> <supportedModelIds>PX013ANC</supportedModelIds> </supportedModelIds> <firmwareFilename>PX013AN_2.1s11_VBN_HYBse-signed.bin</ |
...
firmwareFilename> <firmwareVersion>PX013AN_2.1s11_VBN_HYBse-signed</ |
...
firmwareVersion> </firmwareConfig> <environmentId>TEST</environmentId> <modelId>PX013ANC</modelId> </EnvModelRuleBean> |
Delete an environment model rule
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "8bdb3493-a18b-4230-9b25-fd44df38863b", |
...
"name": "name", |
...
"ipAddressGroup": { |
...
"id": "2c184325-f9eb-4edc-85c3-5b6466fc3c5c", |
...
"name": "test", |
...
"ipAddresses": [ |
...
"192.11.11.11" |
...
] |
...
}, |
...
"warehouse": false |
...
}, |
...
{ |
...
"id": "f9c5a6e8-d34f-4dc6-ae41-9016b70552ae", |
...
"name": "namef", |
...
"ipAddressGroup": { |
...
"id": "2c184325-f9eb-4edc-85c3-5b6466fc3c5c", |
...
"name": "test", |
...
"ipAddresses": [ |
...
"192.11.11.11" |
...
] |
...
}, |
...
"warehouse": false |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <id>8bdb3493-a18b-4230-9b25-fd44df38863b</ |
...
id> <name>name</name> <ipAddressGroup> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </ipAddressGroup> <warehouse>false</warehouse> </item> <item> <id>f9c5a6e8-d34f-4dc6-ae41-9016b70552ae</ |
...
id> <name>namef</name> <ipAddressGroup> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </ipAddressGroup> <warehouse>false</warehouse> </item> </ArrayList> |
Retrieve an ip filter by name
GET http://<host>:<port>/queries/filters/ips/{ipFilterName}?applicationType={type}
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{ |
...
"id": "f9c5a6e8-d34f-4dc6-ae41-9016b70552ae", |
...
"name": "namef", |
...
"ipAddressGroup": { |
...
"id": "2c184325-f9eb-4edc-85c3-5b6466fc3c5c", |
...
"name": "test", |
...
"ipAddresses": [ |
...
"192.11.11.11" |
...
] |
...
}, |
...
"warehouse": false |
...
} |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<IpFilter> <id>8bdb3493-a18b-4230-9b25-fd44df38863b</ |
...
id> <name>name</name> <ipAddressGroup> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </ipAddressGroup> <warehouse>false</warehouse> </IpFilter> |
Create/update an IP filter
If IpFilter is missing it will be being created, otherwise updated. For update operation id field is not needed.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "id": "f9c5a6e8-d34f-4dc6-ae41-9016b70552ae", |
...
"name": "namef", |
...
"ipAddressGroup": { |
...
"id": "2c184325-f9eb-4edc-85c3-5b6466fc3c5c", |
...
"name": "test", |
...
"ipAddresses": [ |
...
"192.11.11.11" |
...
] |
...
}, |
...
"warehouse": false |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<IpFilter> <id>8bdb3493-a18b-4230-9b25-fd44df38863b</ |
...
id> <name>name</name> <ipAddressGroup> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </ipAddressGroup> <warehouse>false</warehouse> </IpFilter> |
Delete IP filter
Response: 200 OK and message: IpRuleId is empty OR IpFilter successfully deleted
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
{ "type":"com.comcast.xconf.queries.beans.PercentFilterWrapper", "id":"PERCENT_FILTER_VALUE", "whitelist": { "id":"66e77146-2542-4173-99fb-2acfe52b9c06", "name":"All warehouses", "ipAddresses": [ "2345678","76.20.128.0/21", "76.106.43.0/24", ","162.150.244.212" ] }, "percentage":100.0, "EnvModelPercentages": [ |
...
{ "percentage":100.0, "active":true, "firmwareCheckRequired":true, "rebootImmediately":true, "lastKnownGood":"","intermediateVersion":"", "firmwareVersions": [ "addtestedit" ], "name":"!@" }, { "percentage":50.0, "active":true, "firmwareCheckRequired":true, "rebootImmediately":true, "lastKnownGood":"PR150BN_2.4p6s3_VBN_HYBsd", "intermediateVersion":"PR150BN_2.3p7s1_PROD_HYBse", "firmwareVersions": [ "PR150BN_2.4p6s3_VBN_HYBsd", |
...
"PR150BN_2.4p8s3_VBN_HYBsd-signed", "PR150BN_2.3p7s1_PROD_HYBse" ], "name":"IV_6a" } ] } |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<PercentFilterWrapper type="com.comcast.xconf.queries.beans.PercentFilterWrapper"> |
...
<id>PERCENT_FILTER_VALUE</ |
...
id> <percentage>99.0</ |
...
percentage> <EnvModelPercentages> <percentage>100.0</ |
...
percentage> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <lastKnownGood/> <intermediateVersion/> <firmwareVersions/> <name>123</name> </EnvModelPercentages> <EnvModelPercentages> <percentage>50.0</percentage> <active>true</active> <firmwareCheckRequired>true</firmwareCheckRequired> <rebootImmediately>true</rebootImmediately> <lastKnownGood>PR150BN_2.4p6s3_VBN_HYBsd</ |
...
lastKnownGood> <intermediateVersion>PR150BN_2.3p7s1 |
...
_PROD_HYBse</intermediateVersion> <firmwareVersions> <firmwareVersions>PR150BN_2.4p6s3_VBN_HYBsd</ |
...
firmwareVersions> <firmwareVersions>PR150BN_2.4p8s3_VBN_HYBsd-signed</ |
...
firmwareVersions> <firmwareVersions>PR150BN_2.3p7s1_PROD_HYBse</ |
...
firmwareVersions> </firmwareVersions> <name>IV_6a</ |
...
name> </EnvModelPercentages> </PercentFilterWrapper> |
Retrieve percent filter field values
GET http://<host>:<port>/queries/filters/percent?field=fieldName&applicationType={type}
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
{ "firmwareVersions": [ "firmwareVersion1", "firmwareVersion2" ] } |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
<SingletonMap>
<SingletonMap> <fieldName>value1</fieldName> |
...
<fieldName>value2</fieldName> |
...
</SingletonMap> |
Update percent filter
POST http://<host>:<port>/updates/filters/percent?applicationType={type}
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{ |
...
"type": "com.comcast.xconf.queries.beans.PercentFilterWrapper", |
...
"id": "PERCENT_FILTER_VALUE", |
...
"percentage": 99.0, |
...
"EnvModelPercentages": [ |
...
{ |
...
"percentage": 100.0, |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [ |
...
...
], |
...
"name": "re" |
...
}, |
...
{ |
...
"percentage": 100.0, |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [ |
...
...
], |
...
"name": "uuuuuuu" |
...
} |
...
] |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} | ||||
<PercentFilterWrapper type="com.comcast.xconf.queries.beans.PercentFilterWrapper" |
...
> <id>PERCENT_FILTER_VALUE</ |
...
id> <percentage>99.0</ |
...
percentage> <EnvModelPercentages> <EnvModelPercentages> <percentage>100.0</percentage> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <name>re</name> </EnvModelPercentages> <EnvModelPercentages> <percentage>100.0</percentage> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <name>uuuuuuu</name> </EnvModelPercentages> </EnvModelPercentages> </PercentFilterWrapper> |
Retrive EnvModelPercentages
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "4c2cea9e-c1be-4219-8f2a-70084f1cb648", |
...
"name": "Percent Test 2", |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [], |
...
"environment": "envId", |
...
"model": "modelId", |
...
"distributions": [ |
...
{ |
...
"configId": "0c176c01-b4cf-4706-9e41-5118e30f68cb", |
...
"percentage": 100.0 |
...
} |
...
] |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
| |||
<ArrayList> <item> <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</ |
...
id> <name>Percent Test 2</ |
...
name> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <environment>envId</environment> <model>modelId</model> <distributions> <distributions> <configId>29ab0494-0ee9-406a-9189-a81598988a54</ |
...
configId> <percentage>100.0</ |
...
percentage> </distributions> </distributions> </item> </ArrayList> |
Retrive EnvModelPercentage by id
GET http://<host>:<port>/queries/percentageBean/id
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{ |
...
"id": "4c2cea9e-c1be-4219-8f2a-70084f1cb648", |
...
"name": "Percent Test 2", |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [], |
...
"environment": "envId", |
...
"model": "modelId", |
...
"distributions": [ |
...
{ |
...
"configId": "0c176c01-b4cf-4706-9e41-5118e30f68cb", |
...
"percentage": 100.0 |
...
} |
...
] |
...
} |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<PercentageBean> <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</ |
...
id> <ttlMap/> <name>Percent Test 2</name> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <environment>envId</environment> <model>modelId</model> <distributions> <distributions> <configId>0c176c01-b4cf-4706-9e41-5118e30f68cb</ |
...
configId> <percentage>100.0</ |
...
percentage> </distributions> </distributions> </PercentageBean> |
Create envModelPercentage
POST http://<host>:<port>/updates/percentageBean?applicationType={type}
...
Name should be unique and not blank, environment and model should be not empty, at least one firmware version should be in minCheck list if firmwareCheckRequired=true, percentage within [0, 100], distribution firmware version should be in minCheck list if firmwareCheckRequired=true, total distribution percentage is within [0, 100], last known good is not empty if total distribution percentage < 100, last known good should be selected in minCheck list.
JSON request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
| ||||
{ "id": "4c2cea9e-c1be-4219-8f2a-70084f1cb648", |
...
"name": "Percent Test 2", |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [], |
...
"environment": "envId", |
...
"model": "modelId", |
...
"distributions": [ |
...
{ |
...
"configId": "0c176c01-b4cf-4706-9e41-5118e30f68cb", |
...
"percentage": 100.0 |
...
} |
...
] |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<PercentageBean> <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</ |
...
id> <ttlMap/> <name>Percent Test 2</name> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <environment>envId</environment> <model>modelId</model> <distributions> <distributions> <configId>0c176c01-b4cf-4706-9e41-5118e30f68cb< |
...
/configId> <percentage>100.0</ |
...
percentage> </distributions> </distributions> </PercentageBean> |
Update EnvModelPercentage
PUT http://<host>:<port>/updates/percentageBean?applicationType={type}
Headers:
Content-Type = application/json OR application/xml
...
Request: http://localhost:9091/queries/percentageBean
RestrictionsRestrictions:
Name should be unique and not blank, environment and model should be not empty, at least one firmware version should be in minCheck list if firmwareCheckRequired=true, percentage within [0, 100], distribution firmware version should be in minCheck list if firmwareCheckRequired=true, total distribution percentage is within [0, 100], last known good is not empty if total distribution percentage < 100, last known good should be selected in minCheck list.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "id": "4c2cea9e-c1be-4219-8f2a-70084f1cb648", |
...
"name": "Percent Test 2", |
...
"active": false, |
...
"firmwareCheckRequired": false, |
...
"rebootImmediately": false, |
...
"firmwareVersions": [], |
...
"environment": "envId", |
...
"model": "modelId", |
...
"distributions": [ |
...
{ |
...
"configId": "0c176c01-b4cf-4706-9e41-5118e30f68cb", |
...
"percentage": 100.0 |
...
} |
...
] |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<PercentageBean> <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</ |
...
id> <ttlMap/> <name>Percent Test 2</name> <active>false</active> <firmwareCheckRequired>false</firmwareCheckRequired> <rebootImmediately>false</rebootImmediately> <firmwareVersions/> <environment>envId</environment> <model>modelId</model> <distributions> <distributions> <configId>0c176c01-b4cf-4706-9e41-5118e30f68cb</ |
...
configId> <percentage>100.0</ |
...
percentage> </distributions> </distributions> </PercentageBean> |
Delete envModelPercentage
DELETE http://<host>:<port>/delete/percentageBean/id
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "cef2b340-2109-467e-a5d2-a70f0cddb432", |
...
"name": "abc", |
...
"ipWhitelist": { |
...
"id": "0e277b6a-7d95-4421-b390-415b03de04b4", |
...
"name": "60.70.80.90", |
...
"ipAddresses": [ |
...
"60.70.80.90" |
...
] |
...
}, |
...
"envModelWhitelist": { |
...
"id": "0f8110a3-4b60-489b-854e-c69e25b18abc", |
...
"environmentId": "QA", |
...
"modelId": "SR150BNC" |
...
}, |
...
"neverBlockRebootDecoupled": true, |
...
"neverBlockHttpDownload": true, |
...
"startTime": "01:00", |
...
"endTime": "02:00", |
...
"localTime": true |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
<ArrayList>
<item>
| ||||
<ArrayList> <item> <id>cef2b340-2109-467e-a5d2-a70f0cddb432</id> |
...
<name>abc</name> |
...
<ipWhitelist> |
...
<id>0e277b6a-7d95-4421-b390-415b03de04b4</id> |
...
<name>60.70.80.90</name> |
...
<ipAddresses> |
...
<ipAddresses>60.70.80.90</ipAddresses> |
...
</ipAddresses> |
...
</ipWhitelist> |
...
<envModelWhitelist> |
...
<id>0f8110a3-4b60-489b-854e-c69e25b18abc</id> |
...
<environmentId>QA</environmentId> |
...
<modelId>SR150BNC</modelId> |
...
</envModelWhitelist> |
...
<neverBlockRebootDecoupled>true</neverBlockRebootDecoupled> |
...
<neverBlockHttpDownload>true</neverBlockHttpDownload> |
...
<startTime>01:00</startTime> |
...
<endTime>02:00</endTime> |
...
<localTime>true</localTime> |
...
</item> |
...
</ArrayList> |
Retrieve time filter by name
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "id": "cef2b340-2109-467e-a5d2-a70f0cddb432", |
...
"name": "abc", |
...
"ipWhitelist": { |
...
"id": "0e277b6a-7d95-4421-b390-415b03de04b4", |
...
"name": "60.70.80.90", |
...
"ipAddresses": [ |
...
"60.70.80.90" |
...
] |
...
}, |
...
"envModelWhitelist": { |
...
"id": "0f8110a3-4b60-489b-854e-c69e25b18abc", |
...
"environmentId": "QA", |
...
"modelId": "SR150BNC" |
...
}, |
...
"neverBlockRebootDecoupled": true, |
...
"neverBlockHttpDownload": true, |
...
"startTime": "01:00", |
...
"endTime": "02:00", |
...
"localTime": true |
...
} |
XML response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
<TimeFilterWrapper> |
...
<id>cef2b340-2109-467e-a5d2-a70f0cddb432</id> |
...
<name>abc</name> |
...
<ipWhitelist> |
...
<id>0e277b6a-7d95-4421-b390-415b03de04b4</id> |
...
<name>60.70.80.90</name> |
...
<ipAddresses> |
...
<ipAddresses>60.70.80.90</ipAddresses> |
...
</ipAddresses> |
...
</ipWhitelist> |
...
<envModelWhitelist> |
...
<id>0f8110a3-4b60-489b-854e-c69e25b18abc</id> |
...
<environmentId>QA</environmentId> |
...
<modelId>SR150BNC</modelId> |
...
</envModelWhitelist> |
...
<neverBlockRebootDecoupled>true</neverBlockRebootDecoupled> |
...
<neverBlockHttpDownload>true</neverBlockHttpDownload> |
...
<startTime>01:00</startTime> |
...
<endTime>02:00</endTime> |
...
<localTime>true</localTime> |
...
</TimeFilterWrapper> |
Create/update time filter
If time filter is missing it will be being created, otherwise updated. For update operation id field is not needed.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "id": "cef2b340-2109-467e-a5d2-a70f0cddb432", |
...
"name": "abc", |
...
"ipWhitelist": { |
...
"id": "0e277b6a-7d95-4421-b390-415b03de04b4", |
...
"name": "60.70.80.90", |
...
"ipAddresses": [ |
...
"60.70.80.90" |
...
] |
...
}, |
...
"envModelWhitelist": { |
...
"id": "0f8110a3-4b60-489b-854e-c69e25b18abc", |
...
"environmentId": "QA", |
...
"modelId": "SR150BNC" |
...
}, |
...
"neverBlockRebootDecoupled": true, |
...
"neverBlockHttpDownload": true, |
...
"startTime": "01:00", |
...
"endTime": "02:00", |
...
"localTime": true |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
<TimeFilterWrapper>
<TimeFilterWrapper> <id>cef2b340-2109-467e-a5d2-a70f0cddb432</id> |
...
<name>abc</name> |
...
<ipWhitelist> |
...
<id>0e277b6a-7d95-4421-b390-415b03de04b4</id> |
...
<name>60.70.80.90</name> |
...
<ipAddresses> |
...
<ipAddresses>60.70.80.90</ipAddresses> |
...
</ipAddresses> |
...
</ipWhitelist> |
...
<envModelWhitelist> |
...
<id>0f8110a3-4b60-489b-854e-c69e25b18abc</id> |
...
<environmentId>QA</environmentId> |
...
<modelId>SR150BNC</modelId> |
...
</envModelWhitelist> |
...
<neverBlockRebootDecoupled>true</neverBlockRebootDecoupled> |
...
<neverBlockHttpDownload>true</neverBlockHttpDownload> |
...
<startTime>01:00</startTime> |
...
<endTime>02:00</endTime> |
...
<localTime>true</localTime> |
...
</TimeFilterWrapper> |
Delete time filter by name
DELETE http://<host>:<port>/delete/filters/time/{timeFilterName}?applicationType={type}
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <id>DEV</id> <description>ff</description> </item> <item> <id>TEST</id> <description>do not delete</description> </item> </ArrayList> |
JSON response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
[{"id":"DEV","description":"ff"},{"id":"TEST","description":"do not delete"}] |
Retrieve environment by id
GET http://<host>:<port>/queries/environments/<environmentId>
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} | ||||
{"id":"DEV","description":"ff"} |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET<Environment> http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<id>DEV</id> <description>ff</description> </Environment> |
Create an environment
POST http://<host>:<port>/updates/environments
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET<Environment> http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<id>testName</id> <description>some description</description> </Environment> |
JSON request
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{"id":"testName","description":"some description"} |
Delete environment by id
DELETE http://<host>:<port>/delete/environments/<environmentId>
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
| |
<ArrayList> <item> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </item> </ArrayList> |
JSON response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "2c184325-f9eb-4edc-85c3-5b6466fc3c5c", |
...
"name": "test", |
...
"ipAddresses": [ |
...
"192.11.11.11" |
...
] |
...
} |
...
] |
Retrieve an IP address group by name
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
[{"id":"2c184325-f9eb-4edc-85c3-5b6466fc3c5c","name":"test","ipAddresses":["192.11.11.11"]}] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c< |
...
/id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </item> </ArrayList> |
Retrieve an IP address group by IP
GET http://<host>:<port>/queries/ipAddressGroups/byIp/<ipAddressGroupIp>/
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} | ||||
[{"id":"2c184325-f9eb-4edc-85c3-5b6466fc3c5c","name":"test","ipAddresses":["192.11.11.11"]}] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11</ |
...
ipAddresses> </ipAddresses> </item> </ArrayList> |
Create an IP address group
POST http://<host>:<port>/updates/ipAddressGroups
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<IpAddressGroupExtended> <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</ |
...
id> <name>test</name> <ipAddresses> <ipAddresses>192.11.11.11< |
...
/ipAddresses> </ipAddresses> </IpAddressGroupExtended> |
JSON request
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{"id":"2c184325-f9eb-4edc-85c3-5b6466fc3c5c","name":"test","ipAddresses":["192.11.11.11"]} |
Add data to IP Address Group(dev in progress)
POST http://<host>:<port>/updates/ipAddressGroups/<ipAddressGroup_name>/addData
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
{
{ "list": [ |
...
"1.1.1.1" |
...
] |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<StringListWrapper> <list> <list>1.1.1.1</ |
...
list> </list> </StringListWrapper> |
Delete data from IP Address Group(dev in progress)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| GET http://<host>:<port>/queries/firmwares?applicationType={type}||||||
{ |
...
"list": [ |
...
"1.1.1.1" |
...
] |
...
} |
XML request
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
| ||
<StringListWrapper> <list> <list>1.1.1.1</ |
...
list> </list> </StringListWrapper> |
Delete an IP address group by id
DELETE http://<host>:<port>/delete/ipAddressGroups/<ipAddressGroupId>
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "name": "test", |
...
"macListRef": "macs", |
...
"targetedModelIds": [ |
...
"YETST" |
...
], |
...
"firmwareConfig": { |
...
"id": "b65962b5-1481-4eed-a010-2abfa8c3bbfd", |
...
"description": "_-", |
...
"supportedModelIds": [ |
...
"YETST" |
...
], |
...
"firmwareFilename": "_-", |
...
"firmwareVersion": "_-" |
...
} |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
...
<ArrayList> <item> <name>test</name> <macListRef>macs</macListRef> <targetedModelIds> <targetedModelIds>YETST</targetedModelIds> </targetedModelIds> <firmwareConfig> <id>b65962b5-1481-4eed-a010-2abfa8c3bbfd</ |
...
id> <description>_-</ |
...
description> <supportedModelIds> <supportedModelIds>YETST</supportedModelIds> </supportedModelIds> <firmwareFilename>_-</ |
...
firmwareFilename> <firmwareVersion>_-</ |
...
firmwareVersion> </firmwareConfig> </item> </ArrayList> |
Retrieve a mac rule list (v2)
GET http://<host>:<port>/queries/rules/macs?version=2&applicationType={type}
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET http://<host>:<port>/queries/firmwares?applicationType={type} |
[
{
[ { "id": "18542fe1-94f2-487c-8f41-9f20965648f5", |
...
"name": "test", |
...
"macListRef": "macs", |
...
"targetedModelIds": [ |
...
"YETST" |
...
], |
...
"firmwareConfig": { |
...
"id": "b65962b5-1481-4eed-a010-2abfa8c3bbfd", |
...
"description": "_-", |
...
"supportedModelIds": [ |
...
"YETST" |
...
], |
...
"firmwareFilename": "_-", |
...
"firmwareVersion": "_-" |
...
}, |
...
"macList": [ |
...
"AA:AA:AA:AA:AA:AA" |
...
] |
...
} |
...
] |
XML response
| Code Block | ||||
|---|---|---|---|---|
| ||||
<ArrayList>
<item>
<id>18542fe1-94f2-487c-8f41-9f20965648f5</id>
<name>test</name>
<macListRef>macs</macListRef>
<targetedModelIds>
<targetedModelIds>YETST</targetedModelIds>
</targetedModelIds>
<firmwareConfig>
<id>b65962b5-1481-4eed-a010-2abfa8c3bbfd</id>
<description>_-</description>
<supportedModelIds>
<supportedModelIds>YETST</supportedModelIds>
</supportedModelIds>
<firmwareFilename>_-</firmwareFilename>
<firmwareVersion>_-</firmwareVersion>
</firmwareConfig>
<macList>
<macList>AA:AA:AA:AA:AA:AA</macList>
</macList>
</item>
</ArrayList> |
...
Overview
Community Forums
Content Tools
Tasks