Skip to content

Latest commit

 

History

History
187 lines (137 loc) · 5.13 KB

manifests.md

File metadata and controls

187 lines (137 loc) · 5.13 KB
Raw

Deployment manifest

Overview

The resources responsible for managing deployment manifests

Available Resources

  1. netField.organisations.manifests.getContainers(organisationId, [page, limit, sortBy, sortOrder, callback])

  2. netField.organisations.manifests.getRoutes(organisationId, [page, limit, sortBy, sortOrder, callback])

  3. netField.organisations.manifests.createContainer(organisationId, params, [options, callback])

  4. netField.organisations.manifests.createRoutes(organisationId, params, [options, callback])

  5. netField.organisations.manifests.deleteContainer(organisationId, containerId, [options, callback])

  6. netField.organisations.manifests.deleteRoute(organisationId, routeId, [options, callback])

  7. netField.organisations.manifests.updateContainer(organisationId, containerId, params, [options, callback])

  8. netField.organisations.manifests.updateRoute(organisationId, routeId, params, [options, callback])

  9. netField.organisations.manifests.getContainer(organisationId, containerId, [options, callback])

  10. netField.organisations.manifests.getRoute(organisationId, routeId, [options, callback])

  11. netField.organisations.manifests.copyManifest(organisationId, [callback])

  12. netField.organisations.manifests.applyManifest(organisationId, deviceId, [callback])

Resource Usage

getContainers

Get list of deployment manifest containers

/**
 * @param {number} organisationId
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.organisations.manifests.getContainers(organisationId, [options], [callback])

getRoutes

Get list of deployment manifest routes

/**
 * @param {number} organisationId
 * @param {function} callback optional
*/
netField.organisations.manifests.getRoutes(organisationId, page?, limit?, sortBy?, sortOrder?, [callback])

createContainer

Adds a new container to deployment manifest

/**
 * @param {number} organisationId
 * @param {string} containerId
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.organisations.manifests.createContainer(organisationId, containerId, [options], [callback])

createRoute

Adds a new route to deployment manifest

/**
 * @param {number} organisationId
 * @param {any} params
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.organisations.manifests.createRoute(organisationId, params, [options], [callback])

deleteContainer

Deletes the specified container from the deployment manifest

/**
 * @param {number} organisationId
 * @param {string} containerId
 * @param {function} callback optional
*/
netField.organisations.manifests.deleteContainer(organisationId, containerId, [callback])

deleteRoute

Deletes the specified route from the deployment manifest

/**
 * @param {number} organisationId
 * @param {string} routeId
 * @param {function} callback optional
*/
netField.organisations.manifests.deleteRoute(organisationId, routeId, [callback])

updateContainer

Updates the specified container from the deployment manifest

/**
 * @param {formData} params
 * @param {object} options optional
 * @param {function} callback optional
*/
netField.organisations.manifests.updateContainer(organisationId, containerId, params, [options, callback])

updateRoute

Updates the specified route from the deployment manifest

/**
 * @param {number} organisationId
 * @param {string} routeId
 * @param {function} callback optional
*/
netField.organisations.manifests.updateRoute(organisationId, routeId, params, [options, callback])

getContainer

Get the specified container from the deployment manifest

/**
 * @param {number} organisationId
 * @param {string} containerId
 * @param {function} callback optional
*/
netField.organisations.manifests.getContainer(organisationId, containerId, [callback])

getRoute

Get the specified route from the deployment manifest

/**
 * @param {number} organisationId
 * @param {string} routeId
 * @param {function} callback optional
*/
netField.organisations.manifests.getRoute(organisationId, routeId, [callback])

copyManifest

Copy parent organisation deployment manifest to the current selected organisation

/**
 * @param {number} organisationId
 * @param {function} callback optional
*/
netField.organisations.manifests.copyManifest(organisationId, [callback])

applyManifest

Apply manifest to onboarded device

/**
 * @param {number} organisationId
 * @param {string} deviceId
 * @param {function} callback optional
*/
netField.organisations.manifests.applyManifest(organisationId, deviceId, [callback])