filters.md

Fleet Management

Overview

The resources responsible for creating and managing fleet device filter

Available Resources

1. netField.deployments.filters.create(params, [callback])

2. netField.deployments.filters.getAll(organisationId, page, limit, sortBy, sortOrder, [callback])

3. netField.deployments.filters.update(filterId, params, [callback])

4. netField.deployments.filters.delete(filterId, [callback])

5. netField.deployments.filters.get(filterId, [callback])

6. netField.deployments.filters.execute(params, page, limit, sortBy, sortOrder, [callback])

Resource Usage

createfilter

Create deployment filter

/** 
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.filters.create(params, [callback])

getfilters

Get a list of all filters

/**
 * @param {number} organisationId
 * @param {number} page
 * @param {number} limit
 * @param {string} sortBy
 * @param {string} sortOrder
 * @param {function} callback optional
 */
netField.deployments.filters.getAll(organisationId, page, limit, sortBy, sortOrder, [callback])

updatefilter

Update filter by id

/**
 * @param {string} filterId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.filters.update(filterId, params, [callback])

deletefilter

Delete filter by id

/**
 * @param {string} filterId
 * @param {function} callback optional
 */
netField.deployments.filters.delete(filterId, [callback])

getfilterbyId

Get single filter by id

/**
 * @param {string} filterId
 * @param {function} callback optional
 */
netField.deployments.filters.get(filterId, [callback])

execute

Execute deployment filter by filterId or filter condition 

/** 
 * @param {object} params
 * @param {number} page
 * @param {number} limit
 * @param {string} sortBy
 * @param {string} sortOrder asc, desc
 * @param {function} callback optional
 */
netField.deployments.filters.execute(params, page, limit, sortBy, sortOrder, callback)