Firmware Bundles data models

getFirmwareBundles — 200 response

Successful retrieval of all firmware bundles.

Represents a firmware bundle which contains one ore more components to be downloaded to a device.

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
componentsarray<object>Noread-only (server-generated)List of components in this bundle.
Properties of components
PropertyTypeRequiredConstraintsDescription
checksumstringNoread-only (server-generated)SHA-1 digest of the file to be downloaded.
componentIdstringYesread-only (server-generated)Unique ID assigned to component.
componentNamestringYesread-only (server-generated)Display name of the component.
filenamestringYesread-only (server-generated)Expected filename of the file to be downloaded.
urlstringNoread-only (server-generated)Download URL of this component version.
versionIdstringYesread-only (server-generated)Unique ID assigned to component version.
versionNamestringYesread-only (server-generated)Display name of component version e.g. 1.0.1
creationTimestringNoread-only (server-generated); format: date-timeTimestamp of bundle creation.
descriptionstringNoDescription of the bundle
deviceClassstringYesread-only (server-generated)device class that this bundle belongs to.
idstringYesread-only (server-generated)Unique ID assigned at time of creation.
namestringYesread-only (server-generated)Display name of bundle.
projectIdintegerYesread-only (server-generated)Project that this bundle belongs to.

getFirmwareBundles — 401 response

Authorization is required to access this resource.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getFirmwareBundles — 403 response

Request failed because of denied permission.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getFirmwareBundles — 429 response

Request failed because of rate limit.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getFirmwareBundles — 500 response

An unexpected error has occurred.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

getFirmwareBundles — 503 response

The service is temporarily unavailable.

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.