Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

ota-package-controller

Get OTA Package (getOtaPackageById)

Fetch the OTA Package object based on the provided OTA Package Id. The server checks that the OTA Package is owned by the same tenant. OTA Package is a heavyweight object that includes main information about the OTA Package and also data.

Available for users with 'TENANT_ADMIN' authority.

get/api/otaPackage/{otaPackageId}

Path parameters

otaPackageIdstring required

A string value representing the ota package id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the ota package creation, in milliseconds

type'FIRMWARE' | 'SOFTWARE'

OTA Package type.

titlestring

OTA Package title.

versionstring

OTA Package version.

tagstring

OTA Package tag.

urlstring

OTA Package url.

hasDataboolean

Indicates OTA Package 'has data'. Field is returned from DB ('true' if data exists or url is set). If OTA Package 'has data' is 'false' we can not assign the OTA Package to the Device or Device Profile.

fileNamestring

OTA Package file name.

contentTypestring

OTA Package content type.

checksumAlgorithm'MD5' | 'SHA256' | 'SHA384' | 'SHA512' | 'CRC32' | 'MURMUR3_32' | 'MURMUR3_128'

OTA Package checksum algorithm.

checksumstring

OTA Package checksum.

dataSizeinteger

OTA Package data size.

namestring
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "OTA_PACKAGE"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "deviceProfileId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE_PROFILE"
  },
  "type": "FIRMWARE",
  "title": "fw",
  "tag": "fw_1.0",
  "url": "http://thingsboard.org/fw/1",
  "hasData": true,
  "fileName": "fw_1.0",
  "contentType": "APPLICATION_OCTET_STREAM",
  "checksumAlgorithm": "CRC32",
  "checksum": "0xd87f7e0c",
  "dataSize": 8,
  "additionalInfo": {}
}