Setting asset parameters

Set configuration parameters in your assets. The Teleport devices involved in the request will pass the parameters on to the assets.

REQUEST

DescriptionExample

method + URL

PUT https://api.teleport.withthegrid.com/v1/parameters/

body (in TS)

{

parameters: SagerFurnace | {

[key]: SagerFurnace

};

deviceHashIds: string[];

}

body details

parameters(type 1)

A single asset parameter object that should be applied to all connected assets.

parameters(type 2)

An object with asset identifiers as keys.

deviceHashIds

1 to 100 elements.

RESPONSE

successful responses

204

Parameters are received by the cloud and will be sent to the specified Teleport device(s). Devices that are offline will receive the parameters when they come back online.

error responses (next to generic errors)

400 { key: "unknown_device_hash_id" }

Device hashId is unknown.