Query

Object

availablePDPBlocks

Returns an array of PDP Blocks that are available to add to the PDP

canRegisterDevice

Returns a boolean value which indicates if the organisation can register a new device

cloudshelf

Returns a Cloudshelf entity

cloudshelfEnginePayload

cloudshelves

Returns a paginated array of Cloudshelves

customToken

An internal function for getting a Cloudshelf Authentication Token.

device

Returns a Device entity

devices

Returns a paginated array of Devices.

engineProducts

filter

Returns a Filter entity

getVersionByType

includeableFilters

Returns all filters that can possibly be included in the Cloudshelf

isInMaintenanceMode

isNobleEnabled

isTrackedURLScanned

location

Returns a location entity

locations

Returns a paginated array of locations

me

Returns the currently authenticated user.

nobleQueues

order

Returns an Order entity.

orders

Returns a paginated array of Order entities

organisation

Returns an Organisation entity

organisationIngestStats

This is an internal function

organisationInstallComplete

Returns if the install has been completed for an organisation

organisationUsers

Returns a paginated array of user access rights for the current organisation

organisations

Returns a paginated array of organisations

pausedNobleQueues

product

Returns a Product entity.

productGroup

Returns a Product Group

productGroups

Returns a paginated array of product groups

products

Returns a paginated array of Product entities.

publicDevice

Returns public information about a device

subscription

Returns a subscription entity

subscriptionCurrentOrg

This is an internal function. This function is not intended to be included in the final release. Only exists due to CS-1273

subscriptionPlans

Returns a list of currently available subscription plans

testFilters

theme

Returns a theme entity

themes

Returns a paginated array of Themes

user

Returns a User entity

webhook

Query a webhook by ID

webhooks

Query the list of registered webhooks