Help Center/ ROMA Connect/ API Reference/ Device Integration APIs/ Product Template/ Synchronizing Product Templates to Associated Products
Updated on 2025-10-22 GMT+08:00

Synchronizing Product Templates to Associated Products

Function

This API is used to synchronize product templates to associated products.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/link/instances/{instance_id}/product-templates/sync-to-products

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

template_ids

Yes

Array of integers

Product template ID list.

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: 404

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.

Example Requests

PUT /{project_id}/link/instances/{instance_id}/product-templates/sync-to-products

Example Responses

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID ff38023c-0854-4779-847d-72528e1f5da5 is correct.",
  "request_id" : "72b07918-f6a2-4721-81bf-f3fd5486025e-1619663576836-cnnorth7a-P-romalink-service01"
}

Status Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.