Query the List of Batch Task Files

Function

This API is used by an application to query the batch task file list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/batchtask-files

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details. Minimum: 1 Maximum: 36

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
files	Array of BatchTaskFile objects	Batch task file list. Array Length: 0 - 10

**Table 4** BatchTaskFile
Parameter	Type	Description
file_id	String	ID of a batch task file uploaded to the platform. The file ID is automatically generated by the platform.
file_name	String	Name of the uploaded batch task file. Minimum: 1 Maximum: 60
upload_time	String	Time when the file was uploaded to the platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

Example Requests

Queries batch task files in a list.

GET https://{endpoint}/v5/iot/{project_id}/batchtask-files

Example Responses

Status code: 200

{
  "files" : [ {
    "file_id" : "0c3c77dd-42a2-4309-9e10-da2e8bf64ac3",
    "file_name" : "BatchCreateDevices_test01.xlsx",
    "upload_time" : "20200617T081608Z"
  }, {
    "file_id" : "9c338eba-b162-4005-98ea-ff34a13c70da",
    "file_name" : "BatchCreateDevices_test02.xlsx",
    "upload_time" : "20200617T081620Z"
  } ]
}