Function: devicetype.Set

Sets specific properties of a DeviceType Object.

Syntax

{
	"method": "devicetype.Set",
	"params": {
		"id": "...",
		"props": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Set( AdvGuid id, AdvObject props );
public Task<bool> SetAsync(Guid id, IDictionary<string, object?> props, CancellationToken ct = default);
set(id: string, props: Map<string, Object>): Promise<boolean>;

Parameters

id : guid

Id of the DeviceType to modify.

props : value{}

List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.

Result : bool

True if successful.

Remarks

This method requires API write access.

Validation

  • Id must be set and a device type with that id must exist before calling this function
  • Regardless of what properties are passed to the function for editing, the resulting device type Object must match these criteria:
    • Code must be a non-empty, unique string consisting of alphanumerical characters. Additional allowed characters: _, -, /, :, #
    • Name must not exceed 50 characters
    • Order must be a non-empty, unique, valid sorting string, i.e. consist of all upper-case letters and not end with ‘A’