Help Center> ROMA Connect> API Reference> Out-of-Date APIs> Device Integration APIs (V1)> Product Management> Creating a Product
View PDF

Creating a Product

Function

This API is used to create a product on ROMA Connect.

URI

POST /v1/{project_id}/link/instances/{instance_id}/products

Table 1 Parameter description

Name

Type

Mandatory

Description

project_id

string

Yes

Project ID of each region of a tenant.

instance_id

string

Yes

ID of the ROMA Connect instance used by the tenant.

Request

Request parameters

Table 2 Body parameter description

Name

Type

Mandatory

Description

app_id

string

Yes

Application ID.

product_name

string

Yes

Name of the product to be created. The value cannot be left blank and contains a maximum of 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

remark

string

No

Description, which contains a maximum of 200 characters.

Example request

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/products
{
"app_id" : "app01",
"product_name" : "product01",
"remark" : "this is a demo."
}

Response

Response parameters

Table 3 Response parameter description

Parameter

Type

Description

password

string

Password.

product_id

integer

Product ID.

product_name

string

Product name.

product_serial

string

Equipment serial number.

remark

string

Description, which contains a maximum of 200 characters.

user_name

string

Username.

Example response

{
    "product_id": 250,
    "product_name": "product01",
    "product_serial": "wbgfcYR6p250",
    "remark": "this is a demo.",
    "password": "*****************",
    "user_name": "8f9be623df1249429dcfead6c0d541d3"
}
Parent topic: Product Management