查询主数据记录列表

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

请求参数

名称 类型 是否必选 示例值 描述
dataId Long 1 元数据的id,该字段跟元数据名称必须填一个
dapIds List 主数据记录的id列表
condition Struct {"col": "phone", "op": "EQUAL", "value": "XXXXX"} 查询的具体过滤条件;例如人员主数据记录中有一个属性的propertyCode为phone,查询某个特定手机号的人员信息,可以这么指定condition: "condition": {"col": "phone", "op": "EQUAL", "value": "XXXXX"}
op String 逻辑操作,目前支持的有, AND, OR, EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, IN, NOT_IN, LIKE, NOT_LIKE, NOTNULL, ISNULL.
value String 逻辑操作的右值。如果操作符op是EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, LIKE, NOT_LIKE中的其中一个时,value是一个字符串,表示待比较的值;如果操作符op是IN, NOT_IN,value则是一个字符串列表,表示操作数的集合; 如果操作符op是AND/OR, value无效,这时候需要指定子级condition
col String 列名,逻辑操作的左值
condition List 查询的过滤条件
op String 逻辑操作,目前支持的有, AND, OR, EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, IN, NOT_IN, LIKE, NOT_LIKE, NOTNULL, ISNULL
value String 逻辑操作的右值。如果操作符op是EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, LIKE, NOT_LIKE中的其中一个时,value是一个字符串,表示待比较的值;如果操作符op是IN, NOT_IN,value则是一个字符串列表,表示操作数的集合; 如果操作符op是AND/OR, value无效,这时候需要指定子级condition
col String 列名,逻辑操作的左值
condition List 查询过滤条件
op String 逻辑操作,目前支持的有, AND, OR, EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, IN, NOT_IN, LIKE, NOT_LIKE, NOTNULL, ISNULL
value String 逻辑操作的右值。如果操作符op是EQUAL, NOT_EQUAL, LESS_EQUAL, GREATER_EQUAL, LESS, GREATER, LIKE, NOT_LIKE中的其中一个时,value是一个字符串,表示待比较的值;如果操作符op是IN, NOT_IN,value则是一个字符串列表,表示操作数的集合; 如果操作符op是AND/OR, value无效,这时候需要指定子级condition
col String 列名,逻辑操作的左值
pageId Int 分页查询时的页号
pageSize Int 分页查询时的页大小
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 String

数据部分,是一个二维字符串数组结构的json字符串,表示查出的数据, nodes标识列名,data标识数据。例如: "nodes":"姓名", "工号", "data": ["张三", "123", "李四", "456"]。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.5"
	},
	"params":{
		"dataId":1,
		"dapIds": "value1",
		"condition":{
			"col": "phone",
			"op": "EQUAL",
			"value": "XXXXX"
		},
		"pageId": "value3",
		"pageSize": "value4",
		"source": "value5",
		"corpId": "value6",
		"userId": "value7",
		"metaDataName": "value8",
		"platform": "value9"
	}
}

正常返回示例

JSON 格式

{
  "code": 200,
  "data": "{\"data\":[[\"张三\",\"1\",\"11112345678\",\"2018/04/27 02:00:00\",\"张家老三\",\"9\",\"待发布\",\"0\",\"V1.0\"],[\"中文名3\",\"125\",\"125\",null,\"中文名3\",\"6\",\"待发布\",\"0\",\"V1.0\"],[\"中文名6\",\"126\",\"126\",null,\"中文名6\",\"13\",\"待发布\",\"0\",\"V1.0\"],[\"中文名7\",\"127\",\"127\",null,\"中文名7\",\"14\",\"待发布\",\"0\",\"V1.0\"],[\"中文名8\",\"128\",\"128\",null,\"中文名8\",\"15\",\"待发布\",\"0\",\"V1.0\"],[\"李四\",\"2\",\"22212345678\",\"2018/04/27 02:00:00\",\"李家老四\",\"10\",\"待发布\",\"0\",\"V1.0\"]],\"nodes\":[\"name\",\"id\",\"phone\",\"hired_date\",\"remark\",\"dap_id_\",\"dap_status_\",\"dap_refcnt_\",\"dap_row_version_\"],\"page\":{\"size\":1500,\"to\":1,\"total\":6}}",
  "message": "success",
  "localizedMsg": null
}

异常返回示例

JSON 格式

{
  "code": 600181,
  "message": "no permission to query record",
  "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