Cisco Cisco Prime Home 6.3 Entwickleranleitung
Cisco Prime Home – Integration Guide
OL-28558-01 v5.1
23
Web Services
API Catalog
Unless otherwise specified, all web service endpoints use JSON as their transfer
encoding.
Full Text Search
Endpoint:
.../prime-home/portal/query/execute
Method
In
Out
POST
A CAQL String
A JSON array of search results
Endpoint:
.../prime-home/portal/query/execute/name.extension
Method
In
Out
GET
name:
The filename of
the results, extension: the
results file format.
Supports ".csv" and
".json"
A file containing search results in
extension format.
See the CAQL documentation in the previous chapter for more information.
Provisioning & Management
Devices
Data Types :
device
element device {
attribute deviceId {number}?
attribute subscriberCode {string}?
(
(attribute oui {string}, attribute sn {string}) |
(attribute provisioningCode {string}) |
(attribute cpProvisioningId {int})
)
attribute manufacturer {string}? [out]
attribute friendlyManufacturerName {string}? [out]
attribute deviceTypeId {number}? [out]
attribute friendlyName {string}? [out]
attribute softwareVersion {string}? [out]
attribute disposition {"FUTURE_DEVICE"|"MANAGED_DEVICE"}?
[out]
attribute excludeFromBulkOperation {boolean}?
attribute lastInform {date}?
attribute firstInform {date}?
attribute informCount {number}?
element labels {(
attribute name {string}
attribute fgcolor {string} [out]
attribute bgcolor {string} [out]
)*}
element applications {map({string}, {(
attribute deviceId {number}?
attribute subscriberCode {string}?
(
(attribute oui {string}, attribute sn {string}) |
(attribute provisioningCode {string}) |
(attribute cpProvisioningId {int})
)
attribute manufacturer {string}? [out]
attribute friendlyManufacturerName {string}? [out]
attribute deviceTypeId {number}? [out]
attribute friendlyName {string}? [out]
attribute softwareVersion {string}? [out]
attribute disposition {"FUTURE_DEVICE"|"MANAGED_DEVICE"}?
[out]
attribute excludeFromBulkOperation {boolean}?
attribute lastInform {date}?
attribute firstInform {date}?
attribute informCount {number}?
element labels {(
attribute name {string}
attribute fgcolor {string} [out]
attribute bgcolor {string} [out]
)*}
element applications {map({string}, {(