查询已发布本体对象类型
更新时间：2026-10-23
接口描述
分页查询工作空间中已发布的本体对象类型。调用方从响应对象的 apiName 字段取得本体类型标识，并将其填入对话请求的 selected_ontology。
该接口虽然使用 v1 路径，但属于已对外开放的 OpenAPI。
请求结构
Plain Text
1GET /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published路径参数
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
workspaceId |
string | 是 | 工作空间 ID |
ontology |
string | 是 | 本体名称（填工作空间名称） |
Query 参数
| 参数名 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
search |
string | 否 | - | 按中文名或英文名搜索；多个搜索词使用英文逗号分隔，匹配任意一个即可 |
status |
string | 否 | - | 状态，可选 EXPERIMENTAL、ACTIVE、DEPRECATED |
visibility |
string | 否 | - | 可见性，可选 NORMAL、HIGHLIGHT、HIDDEN |
searchType |
string | 否 | NAME |
搜索范围：NAME、NAME_DESC、FULL |
listOrderByKey |
string | 否 | PUBLISH_TIME |
排序字段：CREATE_TIME、UPDATE_TIME、PUBLISH_TIME、RID |
projectIds |
string | 否 | - | 项目 ID，多个值使用英文逗号分隔；不传表示全部项目 |
pageNo |
integer | 是 | 1 |
页码，从 1 开始 |
pageSize |
integer | 是 | 10 |
每页数量 |
请求示例
Bash
1curl -G \
2 'https://{host}/databuilder/api/databuilder/v1/workspaces/workspace_9862_0763f283d58a/ontologies/demo_workspace/objectTypes/published' \
3 -H 'X-App-Id: databuilder-ontology-metadata-service' \
4 -H 'Authorization: <签名串>' \
5 --data-urlencode 'pageNo=1' \
6 --data-urlencode 'pageSize=100' \
7 --data-urlencode 'searchType=NAME'响应示例
成功（HTTP 200）
JSON
1{
2 "requestId": "trace_id_string",
3 "code": "SUCCESS",
4 "message": "success",
5 "result": {
6 "pageNo": 1,
7 "pageSize": 100,
8 "totalPage": 1,
9 "total": 1,
10 "objectTypes": [
11 {
12 "id": "object_type_abc123",
13 "apiName": "Order",
14 "name": "Order",
15 "chineseName": "订单",
16 "description": "订单对象类型",
17 "status": "ACTIVE",
18 "visibility": "NORMAL",
19 "indexStatus": "INDEXED",
20 "privileges": ["VIEW", "EXECUTE"]
21 }
22 ]
23 }
24}调用对话接口时使用 apiName：
JSON
1{
2 "selected_ontology": ["Order"]
3}评价此篇文章