查询元数据信息列表

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

请求参数

名称 类型 是否必选 示例值 描述
id Long 1 元数据id
name String 人员 元数据的名字
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
platform String INDUSTRY_PLATFORM_OPERATION表示行业平台, REGION_PLATFORM_OPERATION表示区域平台

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息.

data JSON

响应结果

metaDataDTOS JSON

元数据信息列表

id Long

元数据id

name String

元数据名称

description String

元数据描述

multiVersion Boolean

元数据是否支持多版本

builtin Int

是否是内置元数据

gmtCreate String

创建时间

gmtModified String

修改时间

platformControl Boolean

是否平台管控

prefixNested Boolean

是否有上下级关系

properties JSON

属性列表

propertyCode String

属性标识

propertyDesc String

属性描述(名称)

propertyType String

属性类型

isUnique Boolean

是否唯一键

isNull Boolean

是否可空

array Boolean

是否多值

display String

是否为显示属性

defaultValue String

属性的默认值

propertyLimit JSON

属性的其它限制信息

len Int

字符串属性的最大长度限制

min Double

数值型属性的最小值

max Double

数值型属性的最大值

dataId Long

如果属性类型是主数据,这个是关联的元数据id

factoryType String

工厂模型的属性,这个表示具体的工厂模型

technologyType String

工艺路径的属性,这个表示具体的工艺路径

warehouseType String

库存模型的属性,这个表示具体的库存模型的属性

page JSON

查询结果的分页信息

pageId Int

查询结果所在的页号

pageSize Int

查询结果的页大小

total String

总的数据量

示例

请求示例

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

正常返回示例

JSON 格式

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "data": {
    "digitalFactoryMasterDataDTOList": [
      {
        "id": 541,
        "name": "Employee",
        "description": "人员主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:29.000Z",
        "gmtModified": "2019-02-22T02:25:29.000Z"
      },
      {
        "id": 542,
        "name": "MaterialGroup",
        "description": "物料组主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:30.000Z",
        "gmtModified": "2019-02-22T02:25:30.000Z"
      },
      {
        "id": 543,
        "name": "MaterialType",
        "description": "物料类型主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:30.000Z",
        "gmtModified": "2019-02-22T02:25:30.000Z"
      },
      {
        "id": 544,
        "name": "Material",
        "description": "物料主数据",
        "multiVersion": 1,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:31.000Z",
        "gmtModified": "2019-02-22T02:25:31.000Z"
      },
      {
        "id": 545,
        "name": "EquipmentType",
        "description": "设备类型主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:32.000Z",
        "gmtModified": "2019-02-22T02:25:32.000Z"
      },
      {
        "id": 546,
        "name": "EquipmentModel",
        "description": "设备型号主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:32.000Z",
        "gmtModified": "2019-02-22T02:25:32.000Z"
      },
      {
        "id": 547,
        "name": "Equipment",
        "description": "生产设备主数据",
        "multiVersion": 0,
        "builtin": 1,
        "gmtCreate": "2019-02-22T02:25:33.000Z",
        "gmtModified": "2019-02-22T02:25:33.000Z"
      }
     ]
    }
  }

异常返回示例

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