Querying Product Templates
Function
This API is used to query product templates.
URI
GET /v2/{project_id}/link/instances/{instance_id}/product-templates
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. Minimum: 0 Maximum: 32 |
| instance_id | Yes | String | Instance ID. Minimum: 0 Maximum: 36 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Number of items displayed on each page. The maximum value is 999. If the value exceeds 999, only 999 items are returned. Minimum: 0 Maximum: 999999 Default: 10 |
| id | No | Integer | Product template ID. Minimum: 1 Maximum: 99999999999999999 |
| name | No | String | Product template name. Minimum: 0 Maximum: 10 |
| status | No | Integer | Status of a product template. The options are as follows: 0: enabled; 1: disabled. Minimum: 0 Maximum: 10 |
| created_user_name | No | String | Name of the user who created the product template. Minimum: 0 Maximum: 64 |
| created_date_start | No | Long | Creation start time. The format is timestamp(ms) and the UTC time zone is used. Minimum: 1 Maximum: 99999999999999999 |
| created_date_end | No | Long | Creation end time. The format is timestamp(ms) and the UTC time zone is used. Minimum: 1 Maximum: 99999999999999999 |
| offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. Minimum: 0 Maximum: 999999 Default: 0 |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Total. Minimum: 1 Maximum: 99999999 |
| size | Integer | Number of records displayed on each page. Minimum: 1 Maximum: 9999 |
| items | Array of ProductTemplate objects | Product template information. |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Product template ID. Minimum: 1 Maximum: 99999999999999999 |
| name | String | Product template name. Minimum: 0 Maximum: 64 |
| description | String | Product template description. Minimum: 0 Maximum: 200 |
| status | Integer | Status of a product template. The options are as follows: 0: enabled; 1: disabled. Minimum: 0 Maximum: 10 |
| 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. Minimum: 1 Maximum: 99999999999999999 |
| last_updated_datetime | Long | Last modification time (timestamp, in milliseconds). The UTC time zone is used. Minimum: 1 Maximum: 99999999999999999 |
| Parameter | Type | Description |
|---|---|---|
| user_id | String | User ID (reserved). Minimum: 0 Maximum: 64 |
| user_name | String | Username. Minimum: 0 Maximum: 64 |
| Parameter | Type | Description |
|---|---|---|
| user_id | String | User ID (reserved). Minimum: 0 Maximum: 64 |
| user_name | String | Username. Minimum: 0 Maximum: 64 |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64 |
| error_msg | String | Error description. Minimum: 0 Maximum: 200 |
| request_id | String | Message ID. Minimum: 0 Maximum: 64 |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64 |
| error_msg | String | Error description. Minimum: 0 Maximum: 200 |
| request_id | String | Message ID. Minimum: 0 Maximum: 64 |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64 |
| error_msg | String | Error description. Minimum: 0 Maximum: 200 |
| request_id | String | Message ID. Minimum: 0 Maximum: 64 |
Example Requests
GET /{project_id}/link/instances/{instance_id}/product-templates Example Responses
Status code: 200
OK
{
"total" : 1,
"size" : 1,
"items" : [ {
"id" : 2235,
"name" : "template",
"description" : "description",
"status" : 0,
"createdUser" : {
"user_id" : null,
"user_name" : "user"
},
"lastUpdatedUser" : {
"user_id" : null,
"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.pageQuery]. Parameter is [status]. Processor is [query].",
"requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
} Status code: 404
Not Found
{
"error_code" : "SCB.00000000",
"error_msg" : "Not Found"
} 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.
Last Article: Creating a Product Template
Next Article: Deleting a Product Template
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.