ALalianza
Account Device

Device (by mac) Metadata

Use to update device (mac) metadata. <span hidden>Refer <a href="deviceMetaData.html#patch-device-metadata">here</a> for more information.</span>

patch/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/metadata

Request

Path parameters

accountIdstring required

ID of account. Reference to <a href="#/~schema/Account">account.id</a>

macAddressstring required
partitionIdstring required

ID of partition. Reference to <a href="#/~schema/PartitionX">partition.id</a>

Request body

object required

Json containing the fragment of the DeviceMetadata object to be updated.

Example request

{
  "numSideCars": "1",
  "sideCarTypeId": "VVXEXP"
}

Response

Successful operation

macAddressstring

The 48-bit hexadecimal address assigned to the device by the manufacturer.

partitionIdstring

ID of partition, reference to <a href="#/~schema/Account">account.partitionId</a>

accountIdstring

ID of account, refers to <a href="#/~schema/Account">account.id</a>

deviceTypeIdstring

The deviceTypeId identifies the equipment and the features that the device supports. Refers to <a href="#/~schema/DeviceTypeX">deviceType.id</a>. See also: <a href="#/~operation/Reference%20Resources/getDeviceTypes">Get All DeviceType</a> and <a href="#/~operation/Reference%20Resources/getDeviceTypeById">GetDeviceType</a>

sideCarTypeIdstring

The sideCarTypeId identifies the equipment and the features of the side car device. Refers to <a href="#/~schema/SideCarTypeX">sideCarType.id</a>. See also: <a href="#/~operation/Reference%20Resources/getSideCarTypes">Get All SideCar types</a> and <a href="#/~operation/Reference%20Resources/getSideCarTypeById">Get SideCarType</a>

numSideCarsinteger

The number of side cars assigned to this device.

adminPasswordstring

If an admin password is supplied here, it will be applied to the device if a partition level setting is not present. The partition level setting can only be modified by an Alianza Admin. The partition level setting (Devcon - short for device configuration) is almost always supplied, making most uses of this field irrelevant. The adminPassword set by Devcon is NOT reported in this field.

provisionerType'ALIANZA' | 'PHONISM'

Indicates what entity is responsible for provisioning the device. ALIANZA - Alianza is responsible for provisioning the device. PHONISM - Phonism, a third party service, is responsible for provisioning the device.

idstring

This field always refers to the macAddress.

Changes

No recorded changes to this operation across all 1 revision of this API.