Magidoc

Query
Object

Fields

#

availablePDPBlocks

Non-null

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

canRegisterDevice

Non-null

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

cloudshelf

Returns a Cloudshelf entity

cloudshelfEnginePayload

Non-null

cloudshelves

Non-null

Returns a paginated array of Cloudshelves

customToken

An internal function for getting a Cloudshelf Authentication Token.

device

Returns a Device entity

devices

Non-null

Returns a paginated array of Devices.

engineProducts

Non-null

filter

Returns a Filter entity

getVersionByType

Non-null

includeableFilters

Non-null

Returns all filters that can possibly be included in the Cloudshelf

ingestionStats

Non-null

isInMaintenanceMode

Non-null

isNobleEnabled

Non-null

isTrackedURLScanned

Non-null

location

Returns a location entity

locations

Non-null

Returns a paginated array of locations

me

Non-null

Returns the currently authenticated user.

nobleQueueByTaskType

Non-null

nobleQueues

Non-null

nobleTask

nobleTasksByTypes

Non-null

order

Returns an Order entity.

orders

Non-null

Returns a paginated array of Order entities

organisation

Returns an Organisation entity

organisationInstallComplete

Returns if the install has been completed for an organisation

organisationUsers

Non-null

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

organisations

Non-null

Returns a paginated array of organisations

pausedNobleQueues

Non-null

product

Returns a Product entity.

productGroup

Returns a Product Group

productGroups

Non-null

Returns a paginated array of product groups

products

Non-null

Returns a paginated array of Product entities.

publicDevice

Returns public information about a device

salesAssistant

Returns a sales assistant entity

salesAssistants

Non-null

Returns a paginated array of Sales Assistants

sessions

[ Session !]!
Non-null

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

syncStats

Non-null

testFilters

Non-null

theme

Returns a theme entity

themes

Non-null

Returns a paginated array of Themes

usageStatsSessions

Non-null

user

Non-null

Returns a User entity

webhook

Query a webhook by ID

webhooks

Non-null

Query the list of registered webhooks