containers.md

Containers

Overview

The resources responsible for creating and managing 'appstore' containers

Available Resources

1. netField.containers.getAll([page, limit, sortBy, sortOrder, includeDisabled, callback])

2. netField.containers.get(containerId, [callback])

3. netField.containers.create(params, [options], [callback])

4. netField.containers.update(params, [options], [callback])

5. netField.containers.delete(containerId, [deleteContainerReferences], [callback])

6. netField.containers.share(containerId, organisationIds, [callback])

7. netField.containers.unshare(containerId, organisationId, [callback])

8. netField.containers.disable(containerId, params, [callback])

Resource Usage

getAll

Get list of 'Appstore' containers

/**
 * Get containers from the appstore
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.containers.getAll([options], [callback])

get

Get a container from the 'appstore'

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

create

Adds a new container to the 'appstore'

/**
 * @param {any} params
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.containers.create(params, [options], [callback])

update

Updates a container in the 'appstore'

/**
 * @param {any} params
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.containers.update(params, [options], [callback])

delete

Delete a container from the 'appstore'

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

share

Share container with different organisations

/**
 * @param {string} containerId
 * @param {Array<number>} organisationIds
 * @param {function} callback optional
*/
netField.containers.share(containerId, organisationIds, [callback])

unshare

Unshare container with organisation

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

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