Querying Customized Items
Function
Query customized items (including table customized items, attribute customized items, theme customized items, and service indicator customized items).
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/customized-fields
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100]. |
|
offset |
No |
Integer |
Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0. |
|
type |
Yes |
String |
Type of a customized item. Options:
|
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
|
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
data object |
data: unified outermost data structure of the returned result. |
|
Parameter |
Type |
Description |
|---|---|---|
|
value |
value object |
value: unified outer data structure of the returned result. |
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number. |
|
records |
Array of CustomizedFieldsVO objects |
CustomizedFieldsVO information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
ID, which is a string |
|
name_ch |
String |
Chinese name of a user-defined item. |
|
name_en |
String |
English name of a customized item. |
|
not_null |
Boolean |
Whether a parameter is mandatory. |
|
optional_values |
String |
Sorting order. Options: If there are multiple optional values, separate them with semicolons (;). |
|
type |
String |
Type of a customized item. Options:
|
|
ordinal |
Integer |
System sorting field. You do not need to set this parameter when creating or modifying a record. |
|
description |
String |
Description of a user-defined item. |
|
create_by |
String |
Creator, which is read-only. |
|
update_by |
String |
Updater, which is read-only. |
|
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Example Requests
This API is used to query customized items of a table.
GET https://{endpoint}/v2/{project_id}/design/customized-fields?type=TABLE
Example Responses
Status code: 200
This API is used to query customized items. The returned result is the CustomizedFieldsVO set.
{
"data" : {
"value" : {
"total" : 2,
"records" : [ {
"id" : "1209138753558437888",
"name_ch" : "aaa",
"name_en" : "aaa",
"not_null" : false,
"optional_values" : "",
"type" : "TABLE",
"ordinal" : 0,
"description" : "",
"create_by" : "test_uesr",
"update_by" : "test_uesr",
"create_time" : "2024-02-19T14:05:44+08:00",
"update_time" : "2024-03-14T15:23:50+08:00"
}, {
"id" : "1209138753558437889",
"name_ch" : "bbb",
"name_en" : "bbb",
"not_null" : false,
"optional_values" : "",
"type" : "TABLE",
"ordinal" : 1,
"description" : "",
"create_by" : "test_uesr",
"update_by" : "test_uesr",
"create_time" : "2024-02-19T14:05:44+08:00",
"update_time" : "2024-03-14T15:23:50+08:00"
} ]
}
}
}
Status code: 400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}
Status code: 401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}
Status code: 403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
This API is used to query customized items. The returned result is the CustomizedFieldsVO set. |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
