获取质量追溯的工艺关键参数和质检指定里面定义的属性参数

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

请求参数

名称 类型 是否必选 示例值 描述
id Long 否 属性的id
dataId Long 否 所属元数据的id
stepCode String 否 工艺建模的步骤编码，根据步骤编码获取指定步骤下的工艺关键参数或者质检指标，dataId和stepId至少要填一个，dataId优先。
dataType String 是 获取工艺关键参数时填固定值-TechnocsParam，获取质检指标时填固定值-QualityControl
pageId Int 否 分页查询时的页号，起始为1
pageSize Int 否 分页查询时的页大小
corpId String 否 企业标识，每个企业拥有唯一的CorpID，比如钉钉corpID、LH里面的appId，用参数source来区分参数含义
userId String 否 员工在当前企业内的唯一标识，比如钉钉userId或者IoT的employeeId
source String 否 参数来源源，枚举值，钉钉填写DINGDING，多租户saas应用填SAAS，source、corpId、userId配合使用

返回数据

名称 类型 示例值 描述
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 Int

字段是否唯一，1表示唯一，2表示不唯一
isNull Int

是否可空，3表示可空，4表示不可空
defaultValue String

字段的默认值
propertyIndex Int

属性下标
builtin Int

是否为内置属性
status String

目前固定为effective
propertyLimit JSON

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

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

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

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

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

枚举类型的描述
value String

枚举值
remark String

枚举值的描述
booleanValues JSON

布尔属性的描述
value String

布尔值
remark String

布尔值的描述
array Boolean

该属性是否允许多值
display Boolean

该属性是否为显示属性
page JSON

分页查询的分页信息
pageId Int

分页查询的当前页号
pageSize Int

分页查询时当前页大小
total Long

数据总量

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"id": "value0",
		"dataId": "value1",
		"stepCode": "value2",
		"dataType": "value3",
		"pageId": "value4",
		"pageSize": "value5",
		"corpId": "value6",
		"userId": "value7",
		"source": "value8"
	}
}

正常返回示例

JSON 格式 

{
  "code": 200,
  "message": "success",
  "localizedMsg": null,
  "data": {
    "page": {
      "pageid": 1,
      "pageSize": 15,
      "total": 5
    },
    "propertyDTOList": [
      {
        "id": 1573,
        "dataId": 541,
        "propertyCode": "name",
        "propertyDesc": "中文名",
        "propertyType": "STRING",
        "isUnique": 2,
        "isNull": 4,
        "defaultValue": "",
        "propertyIndex": 3,
        "builtin": 1,
        "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": 1,
        "isNull": 4,
        "defaultValue": "",
        "propertyIndex": 4,
        "builtin": 1,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 32,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      },
      {
        "id": 1575,
        "dataId": 541,
        "propertyCode": "phone",
        "propertyDesc": "手机号码",
        "propertyType": "STRING",
        "isUnique": 2,
        "isNull": 3,
        "defaultValue": "",
        "propertyIndex": 5,
        "builtin": 1,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 32,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      },
      {
        "id": 1576,
        "dataId": 541,
        "propertyCode": "hired_date",
        "propertyDesc": "入职时间",
        "propertyType": "DATE",
        "isUnique": 2,
        "isNull": 3,
        "defaultValue": "",
        "propertyIndex": 6,
        "builtin": 1,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 32,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      },
      {
        "id": 1577,
        "dataId": 541,
        "propertyCode": "remark",
        "propertyDesc": "备注",
        "propertyType": "STRING",
        "isUnique": 2,
        "isNull": 3,
        "defaultValue": "",
        "propertyIndex": 4,
        "builtin": 1,
        "status": "effective",
        "propertyLimit": {
          "min": null,
          "max": null,
          "len": 256,
          "dataId": null,
          "enumValues": null,
          "booleanValues": null,
          "innerExtInfo": null
        }
      }
    ]
  }
}

异常返回示例

JSON 格式 

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

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
200 403 request forbidden. 请求没有权限
200 403 request forbidden. 请求没有权限