Query Meta Record¶
根据记录类型标识符等信息获取记录元数据。
请求参数¶
名称 | 位置 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 记录所属的组织 ID。如何获取 orgId 信息>> |
recordTypes | Query | 可选 | String | 记录所属的记录类型的标识符,多个记录类型之间用英文逗号隔开。单次查询指定的记录类型数量不超过 100。如何获取 recordTypes 信息>> |
withSchema | Query | 可选 | Boolean | 是否返回记录模式。 |
locale | Query | 可选 | String | 中文:zh-CN, 英文:en-US, 日语:ja-JP,西班牙语:es-ES。默认为 en-US。 |
withI18n | Query | 可选 | Boolean | 是否返回完整的国际化内容,true 为返回,false 为不返回。默认不返回。 |
响应参数¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
recordType | 必然返回 | String | 记录类型的标识符。 |
name | 必然返回 | String | 请求语言中记录类型的名称。 |
nameI18n | 可能返回 | I18n 结构体 | 描述记录类型的国际化名称。参见 I18n 结构体。 |
references | 可能返回 | RecordReference 结构体 | 描述关联的父记录类型。参见 RecordReference 结构体。 |
schema | 必然返回 | RecordField 结构体 | 描述记录类型的字段信息。参见 RecordField 结构体。 |
I18n 结构体 ¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
defaultValue | 必然返回 | String | 默认内容。 |
en_US | 可能返回 | String | 英文内容。 |
zh_CN | 可能返回 | String | 中文内容。 |
es_ES | 可能返回 | String | 西班牙语内容。 |
ja_JP | 可能返回 | String | 日语内容。 |
RecordReference 结构体 ¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
recordType | 必然返回 | String | 关联的父记录类型。 |
foreignKeys | 必然返回 | Map(Key 为 String,Value 为 String) | 父记录类型的字段映射。 |
RecordField 结构体 ¶
名称 | 必然/可能返回 | 数据类型 | 描述 |
---|---|---|---|
field | 必然返回 | String | 记录字段的标识符。 |
name | 必然返回 | String | 请求语言中记录字段的名称。 |
nameI18n | 可能返回 | I18n 结构体 | 描述记录字段的国际化名称。参见 I18n 结构体。 |
description | 可能返回 | String | 请求语言中记录字段的描述。 |
descriptionI18n | 可能返回 | I18n 结构体 | 描述记录字段的国际化描述。参见 I18n 结构体。 |
isI18n | 必然返回 | Boolean | 字段内容是否为 I18n 结构体。 |
dataType | 必然返回 | String | 字段的数据类型。 |
units | 可能返回 | String | 字段的单位。 |
sortable | 必然返回 | Boolean | 字段值是否可排序。 |
filters | 可能返回 | List(Value 为 String) | 字段支持的筛选方式。 |
expression | 可能返回 | String | 记录字段的表达式。 |
enumerate | 可能返回 | Map(Key 为 String,Value 为 Enumerate 结构体) | 枚举类字段的枚举值。参见 Enumerate 结构体。 |
isSubRecordType | 可能返回 | Boolean | 字段是否关联子记录类型。 |
subRecordFields | 可能返回 | String | 关联的子记录类型中的字段。 |
示例¶
返回示例¶
{
"data":[
{
"recordType":"SR",
"name": "Service Request",
"references": [
{
"recordType": "WO",
"foreignKeys": {
"fieldOfThisType": "fieldOfForeignType"
}
}
],
"schema": [{
"field":"field1",
"name":"field1",
"isI18n": false,
"dataType":"String",
"units":"--",
"sortable":false,
"filters":["in",">=",">","==","<","<=","startWith","between"],
"expression":"rawField1",
"enum":{
"0": {
"nameI18n": {
"defaultValue": "Normal",
"i18nValue": {
"en_US": "Normal",
"zh_CN": "健康"
}
}
},
"1": {
"nameI18n": {
"defaultValue": "Underperformed",
"i18nValue": {
"en_US": "Underperformed",
"zh_CN": "亚健康"
}
}
}
}
},
{
"field":"field2",
"name":"field2",
"isI18n": false,
"dataType":"Double",
"units":"kW",
"sortable":true,
"filters":[],
"expression":"rawField2",
"enum":{}
}]
},
{
"recordType":"WO",
"name": "Work Order",
"schema": [{
"field":"field1",
"name":"field1",
"isI18n": false,
"dataType":"String",
"units":"--",
"sortable":false,
"filters":["in",">=",">","==","<","<="],
"expression":"rawField1",
"enum":{}
},
{
"field":"field2",
"name":"field2",
"isI18n": false,
"dataType":"Double",
"units":"kW",
"sortable":true,
"filters":[],
"expression":"rawField2",
"enum":{}
}]
}
],
"code":0,
"msg":"OK",
"traceId": "1234567890abcdefghijkl0987654321"
}