Updated on 2026-01-13 GMT+08:00

Batch Updating Metadata Fields

Function

This API is used to update metadata field information in batches. You can add, delete, and modify fields using the JSON patch format to efficiently manage metadata fields.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/metadata/field-tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

category

No

String

Request classification, which is used to specify the type or category of a request.

columns

No

Array of integers

List of column indexes to be operated.

ids

No

Array of strings

List of unique IDs of resources to be operated.

patches

No

Object

JSON node object, which is used to indicate the JSON patch operation.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Task ID.

msg

String

Operation status message.

status

String

Operation status.

Status code: 201

Resource being created.

Example Requests

PUT /v1/{project_id}/metadata/field-tags

{
  "category" : "string",
  "columns" : [ 0 ],
  "ids" : [ "string" ],
  "patches" : { }
}

Example Responses

None

Status Codes

Status Code

Description

200

Updated.

201

Resource being created.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified project does not exist.

Error Codes

See Error Codes.