Namespace: device

Namespaces

Methods

create(params)
createHeidolphCoreGateway(params)
deletePendingInvitation(params)
get(params)

getUserInvitations(params)
list(params)
remove(params)
transforOwnership(params)

update(params)
validate(deviceId)

Namespaces

access

certificate

functionality

functionalityGraph

manufacturer

Methods

async static

create(params) → Promise containing ApiResponse

creates a device

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional
name	string
manufacturerDeviceTypeId	string
isVirtual	boolean	Yes
ownerId	string	Yes
featureVersion	number	Yes

Returns: Promise containing ApiResponse

async static

createHeidolphCoreGateway(params) → Promise containing ApiResponse

creates a heidolph core gateway consisting of 6 individual devices

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional
baseName	string
manufacturerDeviceTypeId	string
isVirtual	boolean	Yes
ownerId	string	Yes
featureVersion	number	Yes

Returns: Promise containing ApiResponse

async static

deletePendingInvitation(params) → Promise containing ApiResponse

retract pending user invitation

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string
invitationId	string

Returns: Promise containing ApiResponse

async static

get(params) → Promise containing ApiResponse

returns a device

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string

Returns: Promise containing ApiResponse

async static

getUserInvitations(params) → Promise containing ApiResponse

returns all pending user invitations

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string

Returns: Promise containing ApiResponse

async static

list(params) → Promise containing ApiResponse

queries the devices collection

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
textQuery	string
textQueryField	string
sortBy	string
sortOrder	string
embedOwners	boolean
embedManufacturers	boolean
skip	number
limit	number

Returns: Promise containing ApiResponse

async static

remove(params) → Promise containing ApiResponse

deletes a device (only in development environment)

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string

Returns: Promise containing ApiResponse

async static

transforOwnership(params) → Promise containing ApiResponse

transfers the ownership of a device to another device user

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string
params	Object
params.newOwnerId	string

Returns: Promise containing ApiResponse

async static

update(params) → Promise containing ApiResponse

updates a device

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string
params	Object
params.name	string

Returns: Promise containing ApiResponse

async static

validate(deviceId) → Promise containing ApiResponse

returns limited device data

Parameter

Name	Type	Optional	Description
deviceId	string

Returns: Promise containing ApiResponse