Updated on 2025-03-26 GMT+08:00

Modifying a Product Template

Function

Modifying a Product Template

URI

PUT /v2/{project_id}/link/instances/{instance_id}/product-templates/{product_template_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document.

instance_id

Yes

String

Instance ID. The default value is default for compatibility with 20.0.

product_template_id

Yes

Integer

Product template ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Product template name. The value is a string of 2 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).

description

No

String

Product template description, which contains a maximum of 200 characters.

status

Yes

Integer

Status of a product template. The options are as follows: 0: enabled; 1: disabled.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

Integer

Product template ID.

name

String

Product template name.

description

String

Product template description.

status

Integer

Status of a product template. The options are as follows: 0: enabled; 1: disabled.

created_user

CreatedUser object

Name of the user who created the attribute.

last_updated_user

LastUpdatedUser object

User who performed the last update.

created_datetime

Long

Creation start time. The format is timestamp(ms) and the UTC time zone is used.

last_updated_datetime

Long

Last modification time (timestamp, in milliseconds). The UTC time zone is used.

Table 5 CreatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

user_name

String

Username.

Table 6 LastUpdatedUser

Parameter

Type

Description

user_id

String

User ID (reserved).

user_name

String

Username.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

error_msg

String

Error description.

request_id

String

Message ID.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

error_msg

String

Error description.

request_id

String

Message ID.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.

error_msg

String

Error description.

request_id

String

Message ID.

Example Requests

Disable a specified product template.

{
  "name" : "product_template",
  "description" : "product template",
  "status" : 1
}

Example Responses

Status code: 200

OK

{
  "id" : 2235,
  "name" : "template",
  "description" : "description",
  "status" : 0,
  "created_user" : {
    "user_id" : "",
    "user_name" : "user"
  },
  "last_updated_user" : {
    "user_id" : "",
    "user_name" : "user"
  },
  "created_datetime" : 1607303564596,
  "last_updated_datetime" : 1607571061057
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-producttemplate.update]. Parameter is [id]. Processor is [path].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

Status code: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.