post https://octave-api.sierrawireless.io/v5.0//device/transfer
Devices can be moved to other Companies of which the requesting user is a member.
NOTE: any Events and Streams under
/<source_company_name>/devices/<device_name>
will be deleted and
not copied to the destination company as part of the transfer.
Transforming Device Attributes
When moving a Device between Companies the following transformations can be specified in the transform
map.
- Device
name
: a new name may be specified. - Device
blueprintId
: a Blueprint from the destination Company can be designated to be applied as part of
the transfer. deployFirmware
: the firmware attached to the supplied Blueprint can be installed in the Device.sendFiles
: the files attached to the supplied Blueprint can be sent to the Device.
Rules for Moving Devices
- The user must have appropriate permissions to delete the Device within the originating Company, and also to create the Device in the destination Company.
- If the user has not requested a Blueprint to be applied to the Device, the Device will retain any Resource value settings (as part of the
state
attribute) and Observations (as part of theobservations
attribute). Edge Actions will not be copied to the Device as part of the transfer, since they are tied to the originating Company. - The Device will retain its original ID, but will be moved to the new Company.
- The full Device Configuration data will be sent to physical device.
Permissions required:
Path / Role | Permission | Description |
---|---|---|
Joined to Destination Company | - | Must be a member of the destination company |
(Source) Device.path or Device.tag | Read | Read access to the Device(s) included in the request |
(Destination) Device.path or Device.tag | Write | Write access to create Devices in the Destination company |