Updated on 2025-12-05 GMT+08:00

Modifying Component Information

Function

After a component is created, change the component name as required.

URI

PUT /v1/components/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Component ID.

Constraints

N/A

Range

The value can be customized. The value contains 24 characters.

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Component name.

Constraints

The value can contain only letters, digits, hyphens (-), and underscores (_).

Range

It contains 3 to 50 characters.

Default value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

String

Definition

ID of the component to be modified.

Range

N/A

Example Requests

Change the component name.

PUT https://{Endpoint}/v1/components/{id}

{
  "name" : "Modify the test component information."
}

Example Responses

Status code: 200

The component is modified.

{
  "data" : "685d1e8e02a50263fb2c259c"
}

Status Codes

Status Code

Description

200

The component is modified.

Error Codes

See Error Codes.