Querying Information About a Subtask of a Batch Task

Typical Scenario

After creating a batch task for devices, an NA can call this API to query information about a subtask of the batch task, including the subtask execution status and subtask content.

API Function

This API is used by an NA to query information about a subtask of a batch task based on specified conditions. This API applies to the current application.

API Description

1	QueryTaskDetailsOutDTO queryTaskDetails(QueryTaskDetailsInDTO qtdInDTO, String accessToken) throws NorthApiException

Class

BatchProcess

Parameter Description

Parameter	Mandatory or Optional	Type	Location	Description
accessToken	Mandatory	String	header	If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.
qtdInDTO	Mandatory	QueryTaskDetailsInDTO	query	For details, see QueryTaskDetailsInDTO structure.

QueryTaskDetailsInDTO structure

Parameter	Mandatory or Optional	Type	Location	Description
appId	Optional	String	query	Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform. The value of this parameter is obtained when the NA is created on the SP portal of the IoT platform. Set this parameter to the value of appId of the authorized application.
taskId	Mandatory	String	query	Identifies a batch task.
status	Optional	String	query	Indicates the task status. The value options are Pending, WaitResult, Success, Fail, and Timeout.
deviceId	Optional	String	query	Identifies a device. This parameter is used for querying details about a batch command delivery task.
commandId	Optional	String	query	Identifies a command. This parameter is used for querying details about a batch command delivery task.
pageNo	Optional	Integer	query	Indicates the page number. If the value is null, pagination query is not performed. If the value is an integer greater than or equal to 0, pagination query is performed. If the value is 0, the first page is queried.
pageSize	Optional	Integer	query	Indicates the page size. The value is an integer greater than or equal to 1. The default value is 1.

Return Value

QueryTaskDetailsOutDTO

Parameter	Type	Description
pageNo	Integer	Indicates the page number. If the value is null, pagination query is not performed. If the value is an integer greater than or equal to 0, pagination query is performed. If the value is 0, the first page is queried.
pageSize	Integer	Indicates the page size. The value is an integer greater than or equal to 1. The default value is 1.
totalCount	Integer	Indicates the total number of records.
taskDetails	List<QueryTaskDetailDTOCloud2NA>	Indicates the task details list. For details, see QueryTaskDetailDTOCloud2NA structure.

QueryTaskDetailDTOCloud2NA structure

Parameter	Type	Description
status	String	Indicates the task status. The value options are Pending, WaitResult, Success, Fail, and Timeout.
output	String	Indicates the output of a batch command delivery task.
error	String	Indicates the cause of error, in the format of {\"error_code\": \"**\", \"error_desc\":\"***\"}.
param	ObjectNode	Indicates the task parameter, which varies depending on the value of taskType.

ObjectNode structure:

Parameter	Type	Description
deviceId	String	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration..
commandId	String	Uniquely identifies a device command. The value of this parameter is allocated by the IoT platform during command delivery.

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
400	100022	The input is invalid	An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid.
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
403	100217	The application hasn't been authorized	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
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	105005	The batchTask is not existed.	The batch task does not exist. Recommended handling: Check whether taskId carried in the API request is correct.
500	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
500	50252	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.