对象类型搜索
更新时间:2026-09-24
接口描述
检索指定工作空间下已发布的对象类型(Object Type),支持按名称/描述/属性搜索、状态与可见性过滤、排序与分页。为更新已有接口。
权限说明
需具备对应工作空间及本体(ontology)的查看权限。
注意事项
- workspaceId、ontology 不存在或无权限时,请求会失败。
- pageNo、pageSize 为必需参数。
请求结构
Plain Text
1GET /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published HTTP/1.1
2Host: databuilder.bd.baidubce.com
3Authorization: authorization string
请求头域
除公共头域(含 Authorization 鉴权)外,无其它特殊头域。
请求参数
Path 参数
| 参数名 | 类型 | 是否必须 | 含义 |
|---|---|---|---|
| workspaceId | String | 是 | 工作空间 ID |
| ontology | String | 是 | 本体名称(workspace name) |
Query 参数
| 参数名 | 类型 | 是否必须 | 含义 |
|---|---|---|---|
| search | string | 否 | 搜索,支持中文名、英文名;多字段场景下可用逗号分隔,任何一个字段满足条件即符合条件 |
| status | string | 否 | 状态 |
| visibility | string | 否 | 可见性 |
| pageNo | integer | 否 | 分页页码: 默认1 |
| pageSize | integer | 否 | 每页条数: 默认10 |
| searchType | string | 否 | 搜索类型,默认 NAME。支持:NAME(从英文名和中文名中查找)、NAME_DESC(从英文名、中文名和描述中查找)、FULL(从英文名、中文名、描述和属性名称/描述中查找) |
| listOrderByKey | string | 否 | 可选值:CREATE_TIME、UPDATE_TIME、PUBLISH_TIME、RID |
| projectIds | string | 否 | 项目 id,逗号分割字符串,空为全部 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
分页获取对象类型列表响应。
| 参数名 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| requestId | String | 是 | 本次请求的唯一标识,用于排查日志 |
| code | String | 是 | 业务响应状态码,枚举值:SUCCESS、FAILURE |
| message | String | 否 | 失败时返回错误信息 |
| result | Object | 是 | 分页结果主体,见下 |
result
| 参数名 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| pageNo | integer | 是 | 当前页码 |
| pageSize | integer | 是 | 每页条数 |
| totalPage | integer | 否 | 总页数 |
| total | integer | 是 | 总记录数 |
| objectTypes | Array<Object> | 是 | 对象类型数据列表,元素见下 |
result.objectTypes 元素
| 参数名 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| privileges | Array |
否 | 当前用户对该对象的权限列表 |
| id | String | 否 | 唯一 ID |
| rid | String | 是 | 唯一资源 ID |
| apiName | String | 是 | apiName 唯一标识 |
| name | String | 是 | 英文名称 |
| chineseName | String | 是 | 中文名称 |
| description | String | 是 | 对象类型描述 |
| status | String | 是 | 状态(如 ACTIVE / EXPERIMENTAL) |
| visibility | String | 是 | 可见性(如 NORMAL / HIGHLIGHT / HIDDEN) |
| updatedTime | String | 是 | 更新时间(ISO 8601) |
| createdTime | String | 是 | 创建时间(ISO 8601) |
| modifyUserName | String | 是 | 最后修改人 |
| creatorName | String | 是 | 创建人 |
| propertyCount | integer | 是 | 属性数量 |
| linkCount | integer | 是 | 关系(Link)数量 |
| saveLocation | String | 否 | 本体对应文件 id,通过该 id 可以获取目录 |
| icon | Object | 否 | 图标信息 |
错误码
通用错误码可参考如下(本体接口专属错误码待确认,以最新实现为准):
| 错误码 | 错误描述 | HTTP 状态码 | 中文解释 |
|---|---|---|---|
| AccessDenied | 无操作权限 | 403 | 暂无操作权限 |
| IllegalArgument | 参数非法 | 400 | 用户提供参数错误 |
请求示例
Plain Text
1GET /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published?search=order&status=active&searchType=NAME&listOrderByKey=PUBLISH_TIME&pageNo=1&pageSize=10
2Host: databuilder.bd.baidubce.com
3Authorization: xxxxxx
响应示例
JSON
1{
2 "requestId": "xxxx",
3 "code": "SUCCESS",
4 "result": {
5 "pageNo": 1,
6 "pageSize": 10,
7 "totalPage": 1,
8 "total": 2,
9 "objectTypes": [
10 {
11 "privileges": ["VIEW","EXECUTE","MODIFY","MANAGE"],
12 "id": "id1",
13 "apiName": "device", // apiName 唯一标识
14 "name": "device", // 英文名
15 "chineseName": "设备", // 中文名
16 "description": "设备对象类型", // 描述
17 "status": "ACTIVE", // 状态
18 "visibility": "PROMINENT", // 可见性
19 "indexStatus": "INDEXED", // 索引状态
20 "publishIssue": "发布失败原因", // 发布失败原因
21 "updateTime": "2025-12-26T07:40:21.402+00:00", // 更新时间
22 "modifyUser": "admin", // 修改人
23 "propertyCount": 12, // 属性数量
24 "linkCount": 3, // link 数量
25 "saveLocation": "file_ac87_0256c449fb7c", // 所属位置 id
26 "icon": { // 图标信息
27 "name": "device.svg",
28 "color": "blue"}
29 },
30 {
31 "privileges": ["VIEW","EXECUTE","MODIFY","MANAGE"],
32 "id": "id2",
33 "apiName": "material",
34 "name": "material",
35 "chineseName": "物料",
36 "description": "物料对象类型",
37 "status": "EXPERIMENTAL",
38 "visibility": "NORMAL",
39 "indexStatus": "UNINDEXED",
40 "publishIssue": "发布失败原因",
41 "updateTime": "2025-12-26T07:40:21.402+00:00",
42 "modifyUserName": "admin",
43 "propertyCount": 8,
44 "linkCount": 1,
45 "saveLocationFolderId": "folder_ac87_0256c449fb7c",
46 "icon": {
47 "name": "device.svg",
48 "color": "blue"}
49 }
50 ]
51 }
52}
评价此篇文章
