Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 1.81 KB

routes.md

File metadata and controls

81 lines (59 loc) · 1.81 KB

Device Containers Routes

Overview

The resources responsible for creating and managing device containers routes

Available Resources

  1. netField.devices.containers.routes.getAll(deviceId, [callback])

  2. netField.devices.containers.routes.create(deviceId, params, [callback])

  3. netField.devices.containers.routes.update(routeId, deviceId, params, [callback])

  4. netField.devices.containers.routes.delete(routeId, deviceId, [callback])

Resource Usage

get

Get information about specific device container route
/**
 * @param {string} deviceId
 * @param {string} routeId
 * @param {function} callback optional
*/
netField.devices.containers.routes.get(deviceId, routeId, [callback])

getAll

Gets all device container routes
/**
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.devices.containers.routes.getAll(deviceId, [callback])

create

Adds a device container route to device
/**
 * @param {string} deviceId
 * @param {any} params
 * @param {function} callback optional
*/
netField.devices.containers.routes.create(deviceId, params, [callback])

update

Updates values of a device container route form device
/**
 * @param {string} routeId
 * @param {string} deviceId
 * @param {any} params
 * @param {function} callback optional
*/
netField.devices.containers.routes.update(routeId, deviceId, params, [callback])

delete

Delete device container route from a device
/**
 * @param {string} routeId
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.devices.containers.routes.delete(routeId, deviceId, [callback])