Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Batch Task/ Batch Task File Management/ Upload a Batch Task File
Updated on 2024-06-27 GMT+08:00
View PDF
Share

Upload a Batch Task File

Function

This API is used by an application to upload a batch task file for task creation. You can upload files of batch device creation, deletion, freezing, and unfreezing tasks.

Debugging

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

URI

POST /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
Table 3 FormData parameters

Parameter

Mandatory

Type

Description

file

Yes

File

Parameter description: file to be uploaded. Value: Currently, only XLSX and XLS files are supported, and a file can contain up to 100,000 lines.

Response Parameters

Status code: 201

Table 4 Response body parameters

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

Uploads a batch task file.

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

Example Responses

Status code: 201

Created

{
  "file_id" : "0c3c77dd-42a2-4309-9e10-da2e8bf64ac3",
  "file_name" : "BatchCreateDevices_test01.xlsx",
  "upload_time" : "20200617T081608Z"
}

Status Codes

Status Code

Description

201

Created

400

BAD REQUEST

401

Unauthorized

403

FORBIDDEN

500

Internal Server Error

Error Codes

See Error Codes.