查询属性信息列表

路径 /industry/metadata/property/query
版本号 1.0.3
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
dataId Long 1 所属元数据的id
pageId Int 1 分页查询时的页号
pageSize Int 200 分页查询时的页大小
source String 参数来源源,枚举值,钉钉填写DINGDING,多租户saas应用填SAAS,source、corpId、userId配合使用
corpId String 企业标识,每个企业拥有唯一的CorpID,比如钉钉corpID、LH里面的appId,用参数source来区分参数含义
userId String 员工在当前企业内的唯一标识,比如钉钉userId或者IoT的employeeId
metaDataName String 元数据名称
platform String INDUSTRY_PLATFORM_OPERATION表示行业平台, REGION_PLATFORM_OPERATION表示区域平台

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

propertyDTOList JSON

属性列表

id Long

属性id

dataId Long

所属的元数据id

propertyCode String

属性的code,用于建表时的字段名

propertyDesc String

属性描述

propertyType String

属性类型

isUnique Boolean

是否是唯一键

isNull Boolean

属性是否可空

defaultValue String

字段的默认值

propertyIndex Int

属性下标

propertyLimit JSON

属性的限制信息,比如字符串长度限制,整数的大小范围限制等

len Int

如果属性是字符串类型,这个描述它的长度限制

min Double

如果属性是整型或者浮点型,这个描述它的最小值

max Double

如果属性是整型或者浮点型,这个描述它的最大值

dataId Long

如果该属性是关联其它元数据的,该字段记录对应的元数据id

enumValues JSON

枚举类型的描述

value String

枚举值

remark String

枚举值的描述

booleanValues JSON

布尔属性的描述

value String

布尔值

remark String

布尔值的描述

factoryType String

属性为工厂模型时,具体的工厂模型的类型

technologyType String

属性为工艺路径类型时,具体的工艺路径类型

warehouseType String

属性为库存模型时,具体的库存模型类型

array Boolean

该属性是否允许多值

display Boolean

该属性是否为显示属性

pageId Int

页号

pageSize Int

分页大小

total String

总数,字符串格式

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.3"
	},
	"params":{
		"dataId":1,
		"pageId":1,
		"pageSize":200,
		"source": "value3",
		"corpId": "value4",
		"userId": "value5",
		"metaDataName": "value6",
		"platform": "value7"
	}
}

正常返回示例

JSON 格式

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "data": {
    "pageid": 1,
    "pageSize": 15,
    "total": "5",
    "propertyDTOList": [
      {
        "id": 1573,
        "dataId": 541,
        "propertyCode": "name",
        "propertyDesc": "中文名",
        "propertyType": "STRING",
        "isUnique": false,
        "isNull": false,
        "defaultValue": "",
        "propertyIndex": 3,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 64,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      },
      {
        "id": 1574,
        "dataId": 541,
        "propertyCode": "id",
        "propertyDesc": "工号",
        "propertyType": "STRING",
        "isUnique": true,
        "isNull": false,
        "defaultValue": "",
        "propertyIndex": 4,
        "builtin": 1,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 32,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      }
    ]
  }
}

异常返回示例

JSON 格式

{
  "code": 600181,
  "message": "no permission to query",
  "localizedMsg": "没有查询权限"
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error