jobs.md

Fleet Management

Overview

The resources responsible for creating and managing fleet device deployment

Available Resources

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

2. netField.deployments.jobs.containers.add(jobId, containerId, params, [callback])

3. netField.deployments.jobs.containers.update(jobId, containerId, params, [callback])

4. netField.deployments.jobs.containers.delete(jobId, containerId, [callback])

5. netField.deployments.jobs.containers.getAll(jobId, page, limit, sortBy, sortOrder, [callback])

6. netField.deployments.jobs.containers.get(jobId, containerId, [callback])

7. netField.deployments.jobs.update(jobId, params, [callback])

8. netField.deployments.jobs.delete(jobId, [callback])

9. netField.deployments.jobs.get(jobId, [callback])

10. netField.deployments.jobs.getAll(organisationId, page, limit, sortBy, sortOrder, [callback])

11. netField.deployments.jobs.routes.add(jobId, params, [callback])

12. netField.deployments.jobs.routes.update(jobId, routeId, params, [callback])

13. netField.deployments.jobs.routes.delete(jobId, routeId, [callback])

14. netField.deployments.jobs.routes.getAll(jobId, page, limit, sortBy, sortOrder, [callback])

15. netField.deployments.jobs.routes.get(jobId, routeId, [callback])

16. netField.deployments.jobs.execute(jobId, filterId, params, [callback])

17. netField.deployments.jobs.containers.methods.add(jobId, containerId, params, [callback])

18. netField.deployments.jobs.containers.methods.update(jobId, containerId, methodId, params, [callback])

19. netField.deployments.jobs.containers.methods.delete(jobId, containerId, methodId, [callback])

20. netField.deployments.jobs.containers.methods.getAll(jobId, containerId, page, limit, sortBy, sortOrder, [callback])

21. netField.deployments.jobs.containers.methods.get(jobId, containerId, methodId, [callback])

Resource Usage

createJob

Create deployment job

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

updateJob

Update deployment job

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

deleteJob

Delete deployment job

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

getSingleJob

Get single deployment job by id

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

getAllJobs

Get a list of all deployment jobs

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

addContainerToJob

Add single container to a deployment job

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.add(jobId, containerId, params, [callback])

updateContainerInJob

Update single container in a deployment job

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.update(jobId, containerId, params, [callback])

deleteContainerInJob

Delete single container in a deployment job

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.delete(jobId, containerId, [callback])

getAllContainersInJob

Get a list of all containers in a deployment job

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

getSingleContainerInJob

Get single container in a deployment job by id

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.get(jobId, containerId, [callback])

addRouteToJob

Add single route to a deployment job

/**
 * @param {string} jobId
 * @param {string} routeId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.routes.add(jobId, params, [callback])

updateRouteInJob

Update single route in a deployment job

/**
 * @param {string} jobId
 * @param {string} routeId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.routes.update(jobId, routeId, params, [callback])

deleteRouteInJob

Delete single route in a deployment job

/**
 * @param {string} jobId
 * @param {string} routeId
 * @param {function} callback optional
 */
netField.deployments.jobs.routes.delete(jobId, routeId, [callback])

getAllRoutesInJob

Get a list of all routes in a deployment job

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

getSingleRouteInJob

Get single route in a deployment job by id

/**
 * @param {string} jobId
 * @param {string} routeId
 * @param {function} callback optional
 */
netField.deployments.jobs.routes.get(jobId, routeId, [callback])

executeJob

Execute deployment job by filter condition

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

addMethodToJobContainer

Add direct method to container into deployment job

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.methods.add(jobId, containerId, params, [callback])

updateMethodInJobContainer

Update container direct method into deployment job

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {string} methodId
 * @param {object} params
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.methods.update(jobId, containerId, methodId, params, [callback])

deleteMethodInJobContainer

Delete direct method from container into deployment job document

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {string} methodId
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.methods.delete(jobId, containerId, methodId, [callback])

getAllMethodsInJobContainer

Get lis of all direct methods from deployment job container by container id

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {number} page
 * @param {number} limit
 * @param {string} sortBy
 * @param {string} sortOrder
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.methods.getAll(jobId, containerId, page, limit, sortBy, sortOrder, [callback])

getSingleMethodInJobContainer

Get single direct method from deployment job container by method id

/**
 * @param {string} jobId
 * @param {string} containerId
 * @param {string} methodId
 * @param {function} callback optional
 */
netField.deployments.jobs.containers.methods.get(jobId, containerId, methodId, [callback])