Querying a Specified Version Package

Typical Scenario

Before upgrading the device version, an NA can call this API to query the target version upgrade package to ensure that it has been uploaded to the IoT platform.

API Function

This API is used by an NA to query a specified version package based on the version package ID on the IoT platform. The version package ID can be obtained by calling the Querying a Version Package List API.

API Prototype

Method	GET
URL	https://server:port/iodm/northbound/v1.5.0/category/{fileId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
fileId	Mandatory	String	path	Identifies a version package. The version package ID can be obtained by calling the API for querying a version package list.

Response Parameters

Status Code: 200 OK

Parameter	Type	Description
fileId	String	Identifies a version package.
name	String	Indicates the version package name.
version	String	Indicates the version of the version package.
fileType	String	Indicates the type of a version package. firmwarePackage: Indicates a firmware package. softwarePackage: Indicates a software package.
deviceType	String	Indicates the type of the device to which the version package is applicable.
model	String	Indicates the model of the device to which the version package is applicable.
manufacturerName	String	Indicates the manufacturer of the device to which the version package is applicable.
protocolType	String	Indicates the protocol used by the device to which the version package is applicable.
description	String	Indicates the version package description.
date	String	Indicates the date on which the version package was generated.
uploadTime	String	Indicates the date on which the version package was uploaded.

Request Example

Method: GET
Request:
https://server:port/iodm/northbound/v1.5.0/category/{fileId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "fileId": "**********",
  "name": "******",
  "version": "V1.1.10",
  "fileType": "softwarePackage",
  "deviceType": "******",
  "model": "******",
  "manufacturerName": "***",
  "protocolType": "CoAP",
  "description": "Test software package made by WYH",
  "date": "2015-2-2 ",
  "uploadTime": "20151212T121212Z"
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
400	120015	Bad request error.	A request error occurs. Recommended handling: Check whether the format of fileId carried in the API request is correct.
403	1010009	app throttle exceed.	The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.
403	1010005	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
404	123002	Device or package file not found.	The device or package does not exist. Recommended handling: Check whether fileId carried in the API request is correct.