IAP/REST API Index

IAP/REST API Index

This page lists the API endpoints in alphabetical order based on the resource name.  The available methods and reference documentation are listed for each endpoint.

Resource  

Methods                  

API Endpoint

Resource  

Methods                  

API Endpoint

Access

GET, PUT

/iap/access/zones/{id}

Alarms

GET

/iap/alarms  

Alarms

PUT

/iap/alarms/clear 

Alarms

GET

/iap/alarms/count 

Alarms

GET, POST

/iap/alarms/definitions 

Alarms

GET, DELETE

/iap/alarms/definitions/{id} 

Alarms

GET

/iap/alarms/definitions/{id}/subscribers 

Alarms

GET

/iap/alarms/dev/count 

Alarms

GET

/iap/alarms/dev/count/{deviceId}

Alarms

GET

/iap/alarms/device/{deviceId} 

Alarms

PUT

/iap/alarms/devs 

Alarms

GET

/iap/alarms/export 

Alarms

GET

/iap/alarms/ids 

Alarms

GET

/iap/alarms/types 

Authentication

POST

/iap/auth/login

Authentication

PUT

/iap/auth/logout

Authentication

PUT

/iap/auth/resetPwd

Authentication

GET

/iap/auth/sessionTimeout

Capabilities

PUT

iap/capabilities/customer/{id}/deprovision  

Capabilities

PUT

iap/capabilities/customer/{id}/provision

Capabilities

PUT

iap/capabilities/floor/{id}/deprovision  

Capabilities

PUT

iap/capabilities/floor/{id}/provision 

Capabilities

PUT

iap/capabilities/floorplan/{id}/deprovision  

Capabilities

PUT

iap/capabilities/floorplan/{id}/provision 

Capabilities

PUT

iap/capabilities/grp/{id}/deprovision  

Capabilities

PUT

iap/capabilities/grp/{id}/provision 

Capabilities

PUT

iap/capabilities/gz/{id}/deprovision  

Capabilities

PUT

iap/capabilities/gz/{id}/provision 

Capabilities

PUT

iap/capabilities/zone/{id}/deprovision  

Capabilities

PUT

iap/capabilities/zone/{id}/provision 

Connection 
(Export CON file)

POST

/iap/con/export

Context

GET, POST, PUT

/iap/context

Context

GET, DELETE

/iap/context/{id}

Context

PUT

/iap/context/assignDevicesTo/{id}

Context

GET

/iap/context/export

Context

POST

/iap/context/import

Context

PUT

/iap/context/unassignDevices

Customers

PUT, POST

/iap/customers

Customers

GET,

/iap/customers/current

Customers

GET, DELETE

/iap/customers/{customerId}

Customers

GET

/iap/customers/generateKey

Datapoint Categories

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat

Datapoint Default Values

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/default

Datapoint Logs

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/{level}

Datapoint Logs

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaTime

Datapoint Logs

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaValue

Datapoint Logs

GET, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/value/{value_param}

Datapoint Monitor

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/monitor

Datapoint Override State

GET, PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/state

Datapoint Override Value

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value

Datapoint Overrides

GET

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides

Datapoint Properties

GET

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/[{prop_name} | *]

Datapoint Properties

PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/{prop_name}

Datapoint Tags

GET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}

Datapoint Tags

POST

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags

Datapoint Type

GET, PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/type

Datapoint Value

GET, PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/value/{prop_name}

Datapoint Value
(localized value)

PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/localization/value
/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/localization/value

Datapoint Value
(preset value)


PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/presets/value
/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/presets/value

Datapoint Value
(original value)


PUT

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value
/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/value

Datapoint Relinquish

DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value

Devices

GET, POST 

/iap/devs

Devices

GET, DELETE 

/iap/devs/{id} 

Devices

PUT 

/iap/devs/{id}/assign/floor/{Fid} 

Devices

PUT 

/iap/devs/{id}/changeScTo/{sid} 

Device Capabilities

PUT

/iap/devs/{id}/demand 

Device Capabilities

PUT

/iap/devs/{id}/replace  

Devices