Configuration

Heterarchy API

GET: List of Children Superzone IDs of a Heterarchy Element

Description

The call retrieves children superzone IDs of a heterarchy element and, under them, the AES IDs of the nested children floors. The element is identified by the path of the API call (either the full path or the id of the element- see Add/Update zones or tags for details on obtaining the element id).

HTTP Method

GET

Resource URI

/api/config/v1/heterarchy/:pathSegments/childrenfloors

Requires Basic Auth

Parameters

Table 1. Parameter Details
Name	Required	Default	Type	Location	Description
pathSegments	N	—	String	pathReplace	Full path to the element or element id.
validDate	N	—	String	query	Show elements valid at given date (yyyy-mm-dd HH:mm:ss) Allowed values/formats: yyyy-mm-dd HH:mm:ss.
level	N	—	String	query	Level name (SUPERZONE, FLOOR, AP, POI, or ZONE) Allowed values/formats: SUPERZONE FLOOR AP ZONE POI.

Content Type

application/json

API History

Table 2. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: Children Superzone IDs of Hiterarchy Element

Description

The call retrieves children superzone IDs of an heterarchy element and, under them, the counts of all the nested children elements. The element is identified by the path of the API call (either the full path or the ID of the element- see Add/Update zones or tags for details on obtaining the element id). Specifying a level retrieves only children of that level.

HTTP Method

GET

Resource URI

/api/config/v1/heterarchy/:pathSegments/childrencounts

Requires Basic Auth

Parameters

Table 3. Parameter Details
Name	Required	Default	Type	Location	Description
pathSegments	N	—	String	pathReplace	Full path to the element or element ID.
validDate	N	—	String	query	Show elements valid from given date (yyyy-mm-dd HH:mm:ss) Allowed values/formats: yyyy-mm-dd HH:mm:ss.
level	N	—	String	query	Level name (SUPERZONE, FLOOR, AP, POI, or ZONE) Allowed values/formats: SUPERZONE FLOOR AP ZONE POI.

Content Type

application/json

API History

Table 4. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

Sites API

GET: All Sites

Description

This API returns all the presence sites.

HTTP Method

GET

Resource URI

/api/config/v1/sites

Requires OAuth

Parameters

None.

Content Type

application/json

Example

[{"changedOn":0,"aesUId":1487056035936,"name":"PSL NOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":3,"timezone":"Asia/Kolkata","aesUidString":"1487056035936","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb 28, 2017 3:37:50 PM","objectVersion":0},{"changedOn":0,"aesUId":1487260407843,"name":"NOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":1,"timezone":"Asia/Kolkata","aesUidString":"1487260407843","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb 28, 2017 3:37:50 PM","objectVersion":0}]

GET: Site Details by ID or Name

Description

This API returns the presence site for the specified ID or Name.

HTTP Method

GET

Resource URI

/api/config/v1/sites/:id

Requires OAuth

Parameters

None.

Content Type

application/json

Map resources API

GET: Count of All Map Elements

Description

This API provides count of campuses, buildings, and floors.

HTTP Method

GET

Resource URI

/api/config/v1/maps/count

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

{
    "totalCampuses": 2,
    "totalBuildings": 3,
    "totalFloors": 8,
    "totalAps": 158,
    "campusCounts": [
        {
            "campusName": "Nortech Campus",
            "totalBuildings": 1,
            "buildingCounts": [
                {
                    "buildingName": "Nortech-1",
                    "totalFloors": 1,
                    "floorCounts": [
                        {
                            "floorName": "1st Floor",
                            "apCount": 14
                        }
                    ]
                }
            ]
        },
        {
            "campusName": "System Campus",
            "totalBuildings": 2,
            "buildingCounts": [
                {
                    "buildingName": "SJC23",
                    "totalFloors": 3,
                    "floorCounts": [
                        {
                            "floorName": "1st floor (CCW remodel)",
                            "apCount": 25
                        },
                        {
                            "floorName": "2nd floor (CCW remodel)",
                            "apCount": 25
                        },
                        {
                            "floorName": "3rd floor (CCW remodel)",
                            "apCount": 24
                        }
                    ]
                },
                {
                    "buildingName": "SJC24",
                    "totalFloors": 4,
                    "floorCounts": [
                        {
                            "floorName": "2nd floor (CCW remodel)",
                            "apCount": 21
                        },
                        {
                            "floorName": "2nd floor (Area Addition)",
                            "apCount": 0
                        },
                        {
                            "floorName": "3rd floor (CCW remodel)",
                            "apCount": 24
                        },
                        {
                            "floorName": "1st floor (CCW remodel)",
                            "apCount": 25
                        }
                    ]
                }
            ]
        }
    ]
}

GET: List of all Building Names.

Description

This API provides a list of all buildings.

HTTP Method

GET

Resource URI

/api/config/v1/maps/building/list/:name

Requires Basic Auth

Parameters

Table 5. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Campus Name

Content Type

application/json

API History

Table 6. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: List of all Building Names

Description

This API provides a list of all buildings.

HTTP Method

GET

Resource URI

/api/config/v1/maps/building/list

Requires Basic Auth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
    "Nortech Campus>Nortech-1",
    "System Campus>SJC24",
    "System Campus>SJC23"
]

API History

Table 7. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: List of all Floor Names

Description

This API provides a list of all Floors in the system.

HTTP Method

GET

Resource URI

/api/config/v1/maps/floor/list/:name

Requires Basic Auth

Parameters

Table 8. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Building Name

Content Type

application/json

API History

Table 9. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: List of all Floor Names

Description

This API provides a list of all floors in the system.

HTTP Method

GET

Resource URI

/api/config/v1/maps/floor/list

Requires Basic Auth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
    "System Campus>SJC23>3rd floor (CCW remodel)",
    "System Campus>SJC23>2nd floor (CCW remodel)",
    "Nortech Campus>Nortech-1>1st Floor",
    "System Campus>SJC23>1st floor (CCW remodel)",
    "System Campus>SJC24>2nd floor (CCW remodel)",
    "System Campus>SJC24>3rd floor (CCW remodel)",
    "System Campus>SJC24>2nd floor (Area Addition)",
    "System Campus>SJC24>1st floor (CCW remodel)"
]

API History

Table 10. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: All Maps

Description

This API returns all maps.

HTTP Method

GET

Resource URI

/api/config/v1/maps

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)


{
    "version": 0,
    "campuses": [
        {
            "objectVersion": 0,
            "name": "System Campus",
            "dimension": {
                "length": 99999,
                "width": 99999,
                "height": 99999,
                "offsetX": 0,
                "offsetY": 0,
                "unit": "FEET"
            },
            "image": null,
            "buildingList": [
                {
                    "aesUid": -6105692415270583000,
                    "objectVersion": 0,
                    "name": "SJC23",
                    "dimension": {
                        "length": 300,
                        "width": 500,
                        "height": 10,
                        "offsetX": 0,
                        "offsetY": 0,
                        "unit": "FEET"
                    },
                    "image": null,
                    "floorList": [
                        {
                            "aesUid": -5970502993869536000,
                            "calibrationModelId": -5970502993867530000,
                            "objectVersion": 0,
                            "name": "1st floor (CCW remodel)",
                            "dimension": {
                                "length": 249.9,
                                "width": 299.9,
                                "height": 10,
                                "offsetX": 0,
                                "offsetY": 0,
                                "unit": "FEET"
                            },
                            "isOutdoor": false,
                            "floorNumber": 1,
                            "image": {
                                "imageName": "cadConversion_1463400556649_f.jpg",
                                "zoomLevel": 5,
                                "width": 3276,
                                "height": 2715,
                                "size": 3276,
                                "maxResolution": 16,
                                "colorDepth": 8
                            },
                            "gpsMarkers": null,
                            "zones": null,
                            "obstacles": [
                                {
                                    "type": "THICK_WALL",
                                    "attenuation": 0,
                                    "obstacleCoordinates": [
                                        {
                                            "x": 2.0488472,
                                            "y": 3.2261696,
                                            "z": 0,
                                            "unit": "FEET"
                                        },
                                        {
                                            "x": 2.561059,
                                            "y": 236.22719,
                                            "z": 0,
                                            "unit": "FEET"
                                        }
                                    ]
                                },
                                {
                                    "type": "NORMAL_WALL",
                                    "attenuation": 0,
                                    "obstacleCoordinates": [
                                        {
                                            "x": 91.68591,
                                            "y": 233.66675,
                                            "z": 0,
                                            "unit": "FEET"
                                        },
                                        {
                                            "x": 93.73476,
                                            "y": 212.15895,
                                            "z": 0,
                                            "unit": "FEET"
                                        }
                                    ]
                                }
                            ],
                            "accessPoints": [
                                {
                                    "floorId": -5970502993869536000,
                                    "angle": 1.57,
                                    "apType": 2,
                                    "switchName": null,
                                    "name": "sjc23-11-cap1",
                                    "radioMacAddress": "00:42:68:a2:2a:80",
                                    "ethMacAddress": null,
                                    "ipAddress": null,
                                    "numOfSlots": 2,
                                    "mapCoordinates": {
                                        "x": 12.216251,
                                        "y": 13.826434,
                                        "z": 10,
                                        "unit": "FEET"
                                    },
                                    "apMode": "LOCAL",
                                    "apInterfaces": [
                                        {
                                            "band": "IEEE_802_11_B",
                                            "slotNumber": 0,
                                            "channelAssignment": 1,
                                            "channelNumber": 1,
                                            "txPowerLevel": 8,
                                            "antennaPattern": "Internal-3700-2.4GHz",
                                            "antennaAngle": 1.5707964,
                                            "antennaElevAngle": 0,
                                            "antennaGain": 8,
                                            "antennaDiversity": 3,
                                            "antennaMode": 1,
                                            "antennaType": 1,
                                            "txPowerControl": 1,
                                            "unit": "RADIAN",
                                            "dualBandSlot": false
                                        },
                                        {
                                            "band": "IEEE_802_11_A",
                                            "slotNumber": 1,
                                            "channelAssignment": 1,
                                            "channelNumber": 36,
                                            "txPowerLevel": 3,
                                            "antennaPattern": "Internal-3700-5GHz",
                                            "antennaAngle": 1.5707964,
                                            "antennaElevAngle": 0,
                                            "antennaGain": 8,
                                            "antennaDiversity": 3,
                                            "antennaMode": 1,
                                            "antennaType": 1,
                                            "txPowerControl": 1,
                                            "unit": "RADIAN",
                                            "dualBandSlot": false
                                        }
                                    ],
                                    "floorIdString": "-5970502993869536658",
                                    "geoCoordinate": null,
                                    "deviceDetails": null
                                },
                                {
                                    "floorId": -5970502993869536000,
                                    "angle": 1.57,
                                    "apType": 2,
                                    "switchName": null,
                                    "name": "sjc23-11-cap10",
                                    "radioMacAddress": "00:42:68:ae:2c:20",
                                    "ethMacAddress": null,
                                    "ipAddress": null,
                                    "numOfSlots": 2,
                                    "mapCoordinates": {
                                        "x": 22.229992,
                                        "y": 100.062416,
                                        "z": 10,
                                        "unit": "FEET"
                                    },
                                    "apMode": "LOCAL",
                                    "apInterfaces": [
                                        {
                                            "band": "IEEE_802_11_B",
                                            "slotNumber": 0,
                                            "channelAssignment": 1,
                                            "channelNumber": 1,
                                            "txPowerLevel": 8,
                                            "antennaPattern": "Internal-3700-2.4GHz",
                                            "antennaAngle": 1.5707964,
                                            "antennaElevAngle": 0,
                                            "antennaGain": 8,
                                            "antennaDiversity": 3,
                                            "antennaMode": 1,
                                            "antennaType": 1,
                                            "txPowerControl": 1,
                                            "unit": "RADIAN",
                                            "dualBandSlot": false
                                        },
                                        {
                                            "band": "IEEE_802_11_A",
                                            "slotNumber": 1,
                                            "channelAssignment": 1,
                                            "channelNumber": 64,
                                            "txPowerLevel": 4,
                                            "antennaPattern": "Internal-3700-5GHz",
                                            "antennaAngle": 1.5707964,
                                            "antennaElevAngle": 0,
                                            "antennaGain": 8,
                                            "antennaDiversity": 3,
                                            "antennaMode": 1,
                                            "antennaType": 1,
                                            "txPowerControl": 1,
                                            "unit": "RADIAN",
                                            "dualBandSlot": false
                                        }
                                    ],
                                    "floorIdString": "-5970502993869536658",
                                    "geoCoordinate": null,
                                    "deviceDetails": null
                                }
                                    ],
                                    "floorIdString": "-5970502993869536658",
                                    "geoCoordinate": null,
                                    "deviceDetails": null
                                }
                            ],
                            "referenceMarkers": null,
                            "exciters": null,
                            "filterRegions": [
                                {
                                    "regionType": "OUTSIDE",
                                    "regionCoordinates": [
                                        {
                                            "x": 0,
                                            "y": 0,
                                            "z": 0,
                                            "unit": "FEET"
                                        },
                                        {
                                            "x": 299.9,
                                            "y": 0,
                                            "z": 0,
                                            "unit": "FEET"
                                        },
                                        {
                                            "x": 299.9,
                                            "y": 249.9,
                                            "z": 0,
                                            "unit": "FEET"
                                        },
                                        {
                                            "x": 0,
                                            "y": 249.9,
                                            "z": 0,
                                            "unit": "FEET"
                                        }
                                    ],
                                    "isDefault": false
                                }
                            ],
                            "filterRails": null,
                            "hierarchyName": "System Campus>SJC23>1st floor (CCW remodel)",
                            "aesUidString": "-5970502993869536658",
                            "geoLocationCapable": "NO_GPS_MARKERS_PRESENT",
                            "mode": null,
                            "floorModeDetails": {
                                "mode": "RSSI",
                                "requestedModeSet": false
                            }
                        }
            ],
            "aesUid": 727035700041482200,
            "aesUidString": "727035700041482262",
            "members": null
        }
    ]
}

GET: Campus by Name

Description

This API returns a campus by name.

HTTP Method

GET

Resource URI

/api/config/v1/maps/info/:campusName

Requires OAuth

Parameters

Table 11. Parameter Details
Name	Required	Default	Type	Location	Description
campusName	Y	—	String	pathReplace	Campus Name

Content Type

application/json

GET: Building by Name Inside Specific Campus

Description

This API returns a building by name.

HTTP Method

GET

Resource URI

/api/config/v1/maps/info/:campusName/:buildingName

Requires OAuth

Parameters

Table 12. Parameter Details
Name	Required	Default	Type	Location	Description
campusName	Y	—	String	pathReplace	Campus Name.
buildingName	Y	—	String	pathReplace	Building Name.

Content Type

application/json

GET: Floor Inside Specific Building and Specific Campus

Description

This API returns a floor by name based on a specific building and campus.

HTTP Method

GET

Resource URI

/api/config/v1/maps/info/:campusName/:buildingName/:floorName

Requires OAuth

Parameters

Table 13. Parameter Details
Name	Required	Default	Type	Location	Description
campusName	Y	—	String	pathReplace	Campus Name.
buildingName	Y	—	String	pathReplace	Building Name.
floorName	Y	—	String	pathReplace	Floor Name.

Content Type

application/json

GET: Floor Image

Description

This API returns an image for a given combination of campus, building, and floor name.

HTTP Method

GET

Resource URI

/api/config/v1/maps/image/:campusName/:buildingName/:floorName

Requires Basic Auth

Parameters

Table 14. Parameter Details
Name	Required	Default	Type	Location	Description
campusName	Y	—	String	pathReplace	Campus Name.
buildingName	Y	—	String	pathReplace	Building Name.
floorName	Y	—	String	pathReplace	Floor Name.

Content Type

application/json

GET: Image by Name

Description

This API returns an image by image name.

HTTP Method

GET

Resource URI

/api/config/v1/maps/imagesource/:imageName

Requires OAuth

Parameters

Table 15. Parameter Details
Name	Required	Default	Type	Location	Description
imageName	Y	—	String	pathReplace	Image Name.

Content Type

application/json

History alerts API

GET: Unique Alerts by Time Interval

Description

This API returns a list of unique alerts by time interval.

HTTP Method

GET

Resource URI

/api/config/v1/history/alerts/unique

Requires Basic Auth

Parameters

Table 16. Parameter Details
Name	Required	Default	Type	Location	Description
startTime	Y	—	Number	query	Specifies the start time in milliseconds.
endTime	Y	—	Number	query	Specifies the end time in milliseconds.

Content Type

application/json

Table 17. API History
Release	Modification
Cisco CMX Release 10.4	This command is deprecated.

Version API

GET: Current CMX Image Version

Description

This API returns the current version of the CMX Image.

HTTP Method

GET

Resource URI

/api/config/v1/version/image

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

{
    "cmx_image_version": "CISCO_CMX-10.4.0-93.cmx",
    "cmx_rpm_versions": [
        "cisco_cmx_connect-10.4.0-18",
        "cisco_cmx_wips-10.2.0-96",
        "cisco_cmx-10.4.0-1234"
    ]
}

Northbound notification types and attributes API

GET: Get Supported Northbound Notifications

Description

This API returns all supported northbound notification types and applicable attributes for the notification rules.

HTTP Method

GET

Resource URI

/api/configuration/v1/attributes

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output

{
    "networkdesignchanged": {
        "triggerHeterarchyChanged": {
            "name": "triggerHeterarchyChanged",
            "dataType": "BOOLEAN",
            "needValueCheck": false,
            "evaluateByProvider": false,
            "validValueSet": [],
            "nameSpace": "networkdesignchanged"
        },
        "triggerNetworkDesignChanged": {
            "name": "triggerNetworkDesignChanged",
            "dataType": "BOOLEAN",
            "needValueCheck": false,
            "evaluateByProvider": false,
            "validValueSet": [],
            "nameSpace": "networkdesignchanged"
        }
    },
    "servicestatus": {
        "oldStatus": {
            "name": "oldStatus",
            "dataType": "ENUM",
            "needValueCheck": false,
            "evaluateByProvider": false,
            "validValueSet": [
                "STOPPED",
                "RUNNING",
                "CRASHED",
                "DISABLED"
            ],
            "nameSpace": "servicestatus"
        },
        "status": {
            "name": "status",
            "dataType": "ENUM",
            "needValueCheck": true,
            "evaluateByProvider": true,
            "validValueSet": [
                "STOPPED",
                "RUNNING",
                "CRASHED",
                "DISABLED"
            ],
            "nameSpace": "servicestatus"
        },
        "statusChanged": {
            "name": "statusChanged",
            "dataType": "BOOLEAN",
            "needValueCheck": true,
            "evaluateByProvider": false,
            "validValueSet": [],
            "nameSpace": "servicestatus"
        }
    }
}

Zone Count Register API

DELETE: Removes all registered zones

Description

This API removes all registered zones.

HTTP Method

DELETE

Resource URI

/api/config/v1/zoneCountParams/:clusterId

Requires Basic Auth

Parameters

Table 18. Parameter Details
Name	Required	Default	Type	Location	Description
clusterId	Y	1	String	pathReplace	clusterId (default 1)

Content Type

application/json

GET: Returns All Registered Zones

Description

This API returns details of all registered zones.

HTTP Method

GET

Resource URI

/api/config/v1/zoneCountParams/:clusterId

Requires OAuth

Parameters

Table 19. Parameter Details
Name	Required	Default	Type	Location	Description
clusterId	Y	1	Number	pathReplace	clusterId (default 1)

Content Type

application/json

Usage Guidelines

http://<cmx-ip-address>/api/config/v1/zoneCountParams/<cluster-id>
For Example:
http://10.0.0.1/api/config/v1/zoneCountParams/1

Sample Output

{
name: "ZoneCountParams",
zoneHierarchy: [
"Simulator-2201-Campus0/Building2/Floor2/Zone2",
"Simulator-2201-Campus0/Building4/Floor4/Zone4",
"Simulator-2201-Campus0/Building7/Floor2/Zone3"
],
zoneIds: [ ],
zoneDetails: [
{
id: 65811,
hierarchy: "Simulator-2201-Campus0/Building2/Floor2/Zone2",
name: "Zone2",
active: true
},
{
id: 66475,
hierarchy: "Simulator-2201-Campus0/Building4/Floor4/Zone4",
name: "Zone4",
active: true
},
{
id: 67192,
hierarchy: "Simulator-2201-Campus0/Building7/Floor2/Zone3",
name: "Zone3",
active: true
}
],
totalZones: 3,
debug: false
}

POST: Add New Zone

Description

This API adds a zone to the existing list of zones. For all hierarchies, system tries to find them in the heterarchy and if the match is successful we have an ID for every zone specified. When the zone is not found, we drop that zone from the configuration.

HTTP Method

POST

Resource URI

/api/config/v1/zoneCountParams/:clusterId

Requires OAuth

Parameters

Table 20. Parameter Details
Name	Required	Default	Type	Location	Description
clusterId	Y	1	String	pathReplace	clusterId (default 1)
zoneHierarchy	Y		array	body	List of exact zone hierarchy separated by /, i.e. Campus/Building/Floor/Zone. (including spaces, if any of the campus / building /floor /zone has spaces in the name) Ensure zones hierarchy are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail For specifying single zone, ["Campus/Building/Floor/Zone1"] For specifying multiple zones, ["Campus/Building/Floor/Zone1", "Campus/Building/Floor/Zone2"]
zoneIds	N		array	body	List of zoneids, Ensure zoneIds are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail for e.g. single zone as [391] multiple zones as [391,392]
zoneDetails	N		text	body	Populated by API after parsing zoneHierarchy or zoneIds input
totalZones	N		number	body	Total registered zones, Populated by API after parsing zoneHierarchy or zoneIds input
debug	N	false	enumerated	body	debug flag to enable recording macaddresses for registered zones true false

Content Type

application/json

Sample Input (JSON)

{
"name": "ZoneCountParams",
"zoneHierarchy": ["Nortech Campus/Nortech Building/Security Floor/zone1",
"Nortech Campus/Nortech Building/Security Floor/zone2",
"System Campus/SJC-24/3rd Floor/Zone_2",
"System Campus/SJC-24/3rd Floor/Zone_1"
]
}

PUT: Add (Overwrite) New Zone

Description

This API is similar to the POST: Add New Zone API, but replaces rather than appends the new zone(s) to the resigtered zone(s) list.

HTTP Method

PUT

Resource URI

/api/config/v1/zoneCountParams/:clusterId

Requires Basic Auth

Parameters

Table 21. Parameter Details
Name	Required	Default	Type	Location	Description
clusterId	Y	1	String	pathReplace	clusterId (default 1)
zoneHierarchy	Y		array	body	List of exact zone hierarchy separated by /, i.e. Campus/Building/Floor/Zone. (including spaces, if any of the campus / building /floor /zone has spaces in the name)</p> Ensure zones hierarchy are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail</p> For specifying single zone, ["Campus/Building/Floor/Zone1"]</p> For specifying multiple zones, ["Campus/Building/Floor/Zone1", "Campus/Building/Floor/Zone2"]</p>
zoneIds	N		array	body	List of zoneids Ensure zoneIds are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail for e.g. single zone as [391] multiple zones as [391,392]
zoneDetails	N		text	body	Populated by API after parsing zoneHierarchy or zoneIds input
totalZones	N		number	body	Total registered zones, Populated by API after parsing zoneHierarchy or zoneIds input
debug	N	false	enumerated	body	debug flag to enable recording macaddresses for registered zones true false

Content Type

application/json

API History

Table 22. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

System preferences API

GET: Type of Device

Description

This API gets the type of box.

HTTP Method

GET

Resource URI

/api/config/v1/system/type

Requires Basic Auth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

{
    "num_cpus": 20,
    "box_type": "High-End"
}

API History

Table 23. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

GET: System Settings Preferences

Description

This API retreives system settings.

HTTP Method

GET

Resource URI

/api/config/v1/system/preferences/:component/:key

Requires OAuth

Parameters

Table 24. Parameter Details
Name	Required	Default	Type	Location	Description
component	Y	—	String	pathReplace	The component.
key	N	—	String	pathReplace	The key to retrieve. If not set, retrieves all keys for the given component.

Content Type

application/json

PUT: System Settings

Description

This API enable you to store system settings. This operation can only be performed by users in the 'Admin' group.

HTTP Method

PUT

Resource URI

/api/config/v1/system/preferences/:component/:key

Requires OAuth

Parameters

Table 25. Parameter Details
Name	Required	Default	Type	Location	Description
component	Y	—	String	pathReplace	The component.
key	Y	—	String	pathReplace	The key.
String	Y	—	string	body	Value.

Content Type

application/json

GET: Gets the System Time

Description

HTTP Method

GET

Resource URI

/api/config/v1/system/time

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

{
    "ISO8601Utils": "2017-12-18T08:56:16Z",
    "timeZoneOffset": -28800000,
    "serverTimeUTC": 1513587376429,
    "serverTime": "Mon Dec 18 00:56:16 PST 2017",
    "timeZone": "Pacific Standard Time"
}

Users API

GET: User by Username

Description

This API retrives user by username.

HTTP Method

GET

Resource URI

/api/config/v1/aaa/users/:username

Requires Basic Auth

Parameters

Table 26. Parameter Details
Name	Required	Default	Type	Location	Description
username	Y	—	String	pathReplace	Username

Content Type

application/json

Sample Output (JSON)

10.30.114.188/api/config/v1/aaa/users/admin

{
    "id": 102,
    "username": "mika",
    "password": "*****",
    "firstname": "mika",
    "lastname": "mika",
    "userGroups": [],
    "roles": [
        {
            "id": 5,
            "name": "Read Only",
            "privileges": []
        }
    ],
    "developerkey": null,
    "lastlogin": 1507596970322
}

DELETE: User by Username

Description

This API deletes a user.

HTTP Method

DELETE

Resource URI

/api/config/v1/aaa/users/:username

Requires Basic Auth

Parameters

Table 27. Parameter Details
Name	Required	Default	Type	Location	Description
username	Y	—	String	pathReplace	Username.

Content Type

application/json

GET: All Roles

Description

This API gets all roles.

HTTP Method

GET

Resource URI

/api/config/v1/aaa/roles

Requires Basic Auth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
    {
        "id": 1,
        "name": "System",
        "privileges": []
    },
    {
        "id": 2,
        "name": "Manage",
        "privileges": []
    },
    {
        "id": 3,
        "name": "Analytics",
        "privileges": []
    },
    {
        "id": 4,
        "name": "Connect",
        "privileges": []
    },
    {
        "id": 7,
        "name": "Location",
        "privileges": []
    },
    {
        "id": 8,
        "name": "ConnectExperience",
        "privileges": []
    },
    {
        "id": 9,
        "name": "Admin",
        "privileges": []
    },
    {
        "id": 5,
        "name": "Read Only",
        "privileges": []
    }
]

Alerts API

GET: Count of Active Alerts

Description

This API returns a count of active alerts.

HTTP Method

GET

Resource URI

/api/config/v1/alerts/count

Requires OAuth

Parameters

None.

Content Type

application/json

GET: All Alerts

Description

This API returns all active alerts.

HTTP Method

GET

Resource URI

/api/config/v1/alerts

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
  {
    "changedOn": 1490159411911,
    "tenantId": 0,
    "lastNotificationTime": 1490159411918,
    "hashkey": -1446685026,
    "alertType": "NMSP_CONNECTION_STATUS",
    "alertStatus": "Unhandled",
    "severity": "Critical",
    "origin": "cmx-vmdev83 WLC: 10.32.168.50",
    "source": "NMSPLB",
    "alarmDescription": "NMSP connection status is inactive for WLC 10.32.168.50",
    "lastEmail": 0,
    "refId": "NMSPLB"
  }
]

Notification subscription API

GET: All Notification Subscriptions

Description

This API returns all notification subscriptions.

HTTP Method

GET

Resource URI

/api/config/v1/notifications

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
    {
        "name": "operational-insights-tag",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "locationupdate.deviceType == tag"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://opinsights.cisco.com:443/api/am/v1/events",
                        "messageFormat": "JSON",
                        "headers": {
                            "Authorization": "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6NCwibG9jYXRpb25FbmdpbmUiOjEsImlhdCI6MTUxMTkwOTkzMSwiYXVkIjoiTm90aWZpY2F0aW9uIiwianRpIjoiNjkzMzI0MzZjM2NlMTM4Zjc4ZWRiMzQ5OWI3NmRhZjVhYTVhOGM0NS00LTEifQ.VNWG1XCcMcbLFIDRqPnwtfcA8v2qTdiWbWaRPcNXno4"
                        },
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    },
    {
        "name": "gateway-blemgmtadmin-feedback-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://ce2rfd8puk.execute-api.us-west-2.amazonaws.com:443/stage/listener/5f5967a8-a0df-4674-92d5-86510ce72cc3?cmxidentifier=a1991c30-8cfd-11e7-b51c-bb23d688f84b",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LodestarConfigUpdate"
    },
    {
        "name": "gateway-blemanager.cmxcis.co-feedback-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://io89bg.cmxcis.co:443/api/vble/v1/beacon/xy?jwttoken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0ZW5hbnRJZCI6ImlvODliZyJ9.09iVoaTFI7NdIUwHq2ULbZ6lGUD9zU0J9gBBAmYdNJg",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LodestarConfigUpdate"
    },
    {
        "name": "Harvey Updates",
        "userId": "admin",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://54.203.15.211:9094/api/v1/notify",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    },
    {
        "name": "gateway-blemanager.cmxcis.co-mapChange-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://io89bg.cmxcis.co:443/api/vble/v1/beacon/xy?jwttoken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0ZW5hbnRJZCI6ImlvODliZyJ9.09iVoaTFI7NdIUwHq2ULbZ6lGUD9zU0J9gBBAmYdNJg",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "NetworkDesignChanged"
    },
    {
        "name": "CMX_Api_Server_Notification_1",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "locationupdate.deviceType == client"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://127.0.0.1:9094/api/notify/v1/location",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    },
    {
        "name": "Nbound Notification",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "locationupdate.deviceType == client"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://data.cmxappsandbox.com:443/api/sdk/v1/notifications",
                        "messageFormat": "JSON",
                        "headers": {
                            "x-jwt-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRpZCI6MTUsInRlbmFudElkIjoxNX0.2S28kXWDSg-GPNfpTxYCKuI_ZnvHLR0oN9XLl9DaRm4",
                            "Content-Type": "application/json"
                        },
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "secret",
        "notificationType": "LocationUpdate"
    },
    {
        "name": "gateway-blemgmtadmin-bleinfo-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "bletagupdate.isBle == true"
                    },
                    {
                        "condition": "bletagupdate.deviceType == tag"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://ce2rfd8puk.execute-api.us-west-2.amazonaws.com:443/stage/listener/5f5967a8-a0df-4674-92d5-86510ce72cc3?cmxidentifier=a1991c30-8cfd-11e7-b51c-bb23d688f84b",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "BleTagUpdate"
    },
    {
        "name": "gateway-blemgmtadmin-mapChange-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://ce2rfd8puk.execute-api.us-west-2.amazonaws.com:443/stage/listener/5f5967a8-a0df-4674-92d5-86510ce72cc3?cmxidentifier=a1991c30-8cfd-11e7-b51c-bb23d688f84b",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "NetworkDesignChanged"
    },
    {
        "name": "gateway-blemanager.cmxcis.co-bleinfo-io89bg",
        "userId": "local-user",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "bletagupdate.isBle == true"
                    },
                    {
                        "condition": "bletagupdate.deviceType == tag"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "https://io89bg.cmxcis.co:443/api/vble/v1/beacon/xy?jwttoken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0ZW5hbnRJZCI6ImlvODliZyJ9.09iVoaTFI7NdIUwHq2ULbZ6lGUD9zU0J9gBBAmYdNJg",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": true,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "BleTagUpdate"
    },
    {
        "name": "CMX_Api_Server_Notification_2",
        "userId": "admin",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://127.0.0.1:9094/api/notify/v1/absence",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": true,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "Absence"
    },
    {
        "name": "PythonAW",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "locationupdate.macAddressList == 98:07:2d:8d:75:e8;"
                    },
                    {
                        "condition": "locationupdate.deviceType == tag"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://dsladden.pythonanywhere.com:80",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    },
    {
        "name": "PythonAWN",
        "userId": "admin",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://taibrahi.pythonanywhere.com:80",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": false,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": true,
        "macScramblingSalt": "",
        "notificationType": "NetworkDesignChanged"
    },
    {
        "name": "HeaderDone",
        "userId": "admin",
        "rules": [
            {
                "conditions": []
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://10.41.32.235:8000",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": false,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    }
]

GET: Notifications by Name

Description

This API returns a notification subscription by name.

HTTP Method

GET

Resource URI

/api/config/v1/notifications/:name

Requires OAuth

Parameters

Table 28. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.

Content Type

application/json

GET: Notification Subscription Availability

Description

This API checks if a notification subscription exiets. It returns FOUND(302) if exists, 404 is not found.

HTTP Method

GET

Resource URI

/api/config/v1/notifications/exists/:name

Requires OAuth

Parameters

Table 29. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.

Content Type

application/json

PUT: Add Notification Subscription

Description

This API allows you to add a notification subscription.

HTTP Method

PUT

Resource URI

/api/config/v1/notification

Requires OAuth

Parameters

Table 30. Parameter Details
Name	Required	Default	Type	Location	Description
userId	Y	—	string	body	User ID.
rules	Y	—	text	body	List of rules.
subscribers	Y	—	text	body	Subscribers
notificationType	Y	—	enumerated	body	Choose one of the following notification types: Any Absence AreaChange Association BatteryLife Chokepoint Containment Emergency Movement Presence LocationUpdate Zone Location ServiceStatus NetworkDesignChanged CpuUsage MemoryUsage DiskUsage BeaconMovement BeaconAbsence Update InOut PasserbyDetected PasserbyBecameVisitor VisitorWentAway SiteEntryChanged
enabled	N	—	enumerated	body	enabled true false
enableMacScrambling	N	—	enumerated	body	enableMacScrambling true false

Content Type

application/json

Sample Input (JSON)

application/json

 {
        "name": "locupdate",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "locationupdate.macAddressList == 00:0c:cc:4f:5f:ba;00:24:d7:37:68:d8;00:24:d7:59:8f:2c;00:0b:6b:a8:56:9f;"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "http://172.19.35.203:7123",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "notificationType": "LocationUpdate"
    }

PUT: List of Notification Subscriptions

Description

This API allows you to add a list of notification subscriptions.

HTTP Method

PUT

Resource URI

/api/config/v1/notifications

Requires OAuth

Parameters

None.

Content Type

application/json

DELETE: Notification Subscription by Notification Name

Description

This API allows you to delete a notification subscription.

HTTP Method

DELETE

Resource URI

/api/config/v1/notifications/:name

Requires OAuth

Parameters

Table 31. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.

Content Type

application/json

GET: System Alert Subscription

Description

This API returns a system alert notification subscription by name.

HTTP Method

GET

Resource URI

/api/config/v1/notifications/alerts

Requires OAuth

Parameters

None.

Content Type

application/json

Sample Output (JSON)

[
    {
        "name": "serviceIsCrashed",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "servicestatus.status == CRASHED"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "local://local",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "severity": "Critical",
        "notificationType": "ServiceStatus"
    },
    {
        "name": "serviceIsDown",
        "userId": "admin",
        "rules": [
            {
                "conditions": [
                    {
                        "condition": "servicestatus.status == STOPPED"
                    }
                ]
            }
        ],
        "subscribers": [
            {
                "receivers": [
                    {
                        "uri": "local://local",
                        "messageFormat": "JSON",
                        "headers": null,
                        "qos": "AT_MOST_ONCE"
                    }
                ]
            }
        ],
        "enabled": true,
        "internal": false,
        "cloud": false,
        "enableMacScrambling": false,
        "macScramblingSalt": "",
        "severity": "Info",
        "notificationType": "ServiceStatus"
    }
]

GET: Notifications by Name

Description

This API returns a system alert notification subscription by name.

HTTP Method

GET

Resource URI

/api/config/v1/notifications/alerts/:name

Requires OAuth

Parameters

Table 32. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.

Content Type

application/json

PUT: System Alert Subscription

Description

This API allows you to add a system alert subscription.

HTTP Method

PUT

Resource URI

/api/config/v1/notifications/alert

Requires OAuth

Parameters

Table 33. Parameter Details
Name	Required	Default	Type	Location	Description
severity	Y	—	enumerated	body	Choose one of the following severity levels: Critical Major Minor Warning Info Cleared
userId	Y	—	string	body	User ID.
rules	Y	—	text	body	List of rules.
subscribers	Y	—	text	body	Subscribers
notificationType	Y	—	enumerated	body	Choose one of the following notification types: Any Absence AreaChange Association BatteryLife Chokepoint Containment Emergency Movement Presence LocationUpdate Zone Location ServiceStatus NetworkDesignChanged CpuUsage MemoryUsage DiskUsage BeaconMovement BeaconAbsence Update InOut PasserbyDetected PasserbyBecameVisitor VisitorWentAway SiteEntryChanged
enabled	N	—	enumerated	body	enabled true false
enableMacScrambling	N	—	enumerated	body	enableMacScrambling true false

Content Type

application/json

DELETE: Notification Alert Subscription

Description

This API allows you to delete a system alert notification subscription.

HTTP Method

DELETE

Resource URI

/api/config/v1/notifications/alerts/:name

Requires OAuth

Parameters

Table 34. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.

Content Type

application/json

POST: Change status of notification by name

Description

This API enables or disables a notification subscription by name.

HTTP Method

POST

Resource URI

/api/config/v1/notifications/:name/:user

Requires Basic Auth

Parameters

Table 35. Parameter Details
Name	Required	Type	Location	Description
name	Y	String	pathReplace	Notification Name
user	Y	String	pathReplace	Name of Notification Owner
action	Y	String	pathReplace	Enable/Disable

Content Type

application/json

API History

Table 36. API History
Release	Modification
Cisco CMX Release 10.4	This API is introduced.

POST: Change Status of Notification by Name

Description

This API enable/disable a notification subscription by name.

HTTP Method

POST

Resource URI

/api/config/v1/notifications/:name/:action

Requires OAuth

Parameters

Table 37. Parameter Details
Name	Required	Default	Type	Location	Description
name	Y	—	String	pathReplace	Notification Name.
action	Y	—	String	pathReplace	Enable/Disable

Content Type

application/json

Cisco Connected Mobile Experiences REST API Guide, Release 10.4

Bias-Free Language

Results

Chapter: Configuration

Configuration

Heterarchy API

GET: List of Children Superzone IDs of a Heterarchy Element

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

API History

GET: Children Superzone IDs of Hiterarchy Element

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

API History

Sites API

GET: All Sites

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Example

GET: Site Details by ID or Name

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Map resources API

GET: Count of All Map Elements

Description

HTTP Method

Resource URI

Requires OAuth

Parameters

Content Type

Sample Output (JSON)

GET: List of all Building Names.

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

API History

GET: List of all Building Names

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

Sample Output (JSON)

API History

GET: List of all Floor Names

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

API History

GET: List of all Floor Names

Description

HTTP Method

Resource URI

Requires Basic Auth

Parameters

Content Type

Sample Output (JSON)