Presentations

Create a Device Configuration

Make an idempotent call to either create or get a device configuration based on the structure of the provided payload.

Note: This API functionality is in BETA

post/presentation/deviceconfig

Request

Request body

iconUrlstring

Icon Id used to retrieve icons to be drawn on the UI Client. If iconUrl is omitted, then UI client shows default icon of device's category.

type'dth' | 'profile'
deviceProfileIdstring uuid

An optional device profile Id. If present the profile Id will be used to generate a unique device configuration.

Response

Create a device configuration or get a match if it already exists.

mnmnstring required

The name of the manufacturer

vidstring required

A unique identifier for the presentation of a device. This can be a model number on legacy device integrations, but also may be a system generated UUID based on a device's structure and display configuration.

versionstring

The version of the device configuration.

descriptionstring

To provide the explanation of the device configuration/presentation’s purpose or content.

type'dth' | 'profile'
iconUrlstring

DEPRECATED: Please use iconUrl under icons property.

presentationIdstring

System generated identifier that corresponds to a device presentation (formerly vid)

manufacturerNamestring

Secondary namespacing key for grouping presentations (formerly mnmn)

Changes

No recorded changes to this operation across all 8 revisions of this API.