{"componentChunkName":"component---src-templates-acg-portal-new-template-tsx","path":"/jmuf9e7fc","result":{"data":{"markdownRemark":{"html":"

接口描述

\n

检索指定工作空间下已发布的对象类型（Object Type），支持按名称/描述/属性搜索、状态与可见性过滤、排序与分页。为更新已有接口。

\n

权限说明

\n

需具备对应工作空间及本体（ontology）的查看权限。

\n

注意事项

\n
    \n
  1. workspaceId、ontology 不存在或无权限时，请求会失败。
    2. \n
  2. pageNo、pageSize 为必需参数。
    3. \n
\n

请求结构

\n\n
\n
\n
\n Plain Text\n \n
\n
\n 
1GET /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published HTTP/1.1\n2Host: databuilder.bd.baidubce.com\n3Authorization: authorization string
\n
\n
\n
\n \n

请求头域

\n

除公共头域（含 Authorization 鉴权）外，无其它特殊头域。

\n

请求参数

\n

Path 参数

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必须含义
workspaceIdString是工作空间 ID
ontologyString是本体名称（workspace name）
\n

Query 参数

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必须含义
searchstring否搜索，支持中文名、英文名；多字段场景下可用逗号分隔，任何一个字段满足条件即符合条件
statusstring否状态
visibilitystring否可见性
pageNointeger否分页页码: 默认1
pageSizeinteger否每页条数: 默认10
searchTypestring否搜索类型，默认 NAME。支持：NAME（从英文名和中文名中查找）、NAME_DESC（从英文名、中文名和描述中查找）、FULL（从英文名、中文名、描述和属性名称/描述中查找）
listOrderByKeystring否可选值：CREATE_TIME、UPDATE_TIME、PUBLISH_TIME、RID
projectIdsstring否项目 id，逗号分割字符串，空为全部
\n

响应头域

\n

除公共头域外，无其它特殊头域。

\n

响应参数

\n

分页获取对象类型列表响应。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必须说明
requestIdString是本次请求的唯一标识，用于排查日志
codeString是业务响应状态码，枚举值：SUCCESS、FAILURE
messageString否失败时返回错误信息
resultObject是分页结果主体，见下
\n

result

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必须说明
pageNointeger是当前页码
pageSizeinteger是每页条数
totalPageinteger否总页数
totalinteger是总记录数
objectTypesArray<Object>是对象类型数据列表，元素见下
\n

result.objectTypes 元素

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
参数名类型是否必须说明
privilegesArray否当前用户对该对象的权限列表
idString否唯一 ID
ridString是唯一资源 ID
apiNameString是apiName 唯一标识
nameString是英文名称
chineseNameString是中文名称
descriptionString是对象类型描述
statusString是状态（如 ACTIVE / EXPERIMENTAL）
visibilityString是可见性（如 NORMAL / HIGHLIGHT / HIDDEN）
updatedTimeString是更新时间（ISO 8601）
createdTimeString是创建时间（ISO 8601）
modifyUserNameString是最后修改人
creatorNameString是创建人
propertyCountinteger是属性数量
linkCountinteger是关系（Link）数量
saveLocationString否本体对应文件 id，通过该 id 可以获取目录
iconObject否图标信息
\n

错误码

\n

通用错误码可参考如下（本体接口专属错误码待确认，以最新实现为准）：

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
错误码错误描述HTTP 状态码中文解释
AccessDenied无操作权限403暂无操作权限
IllegalArgument参数非法400用户提供参数错误
\n

请求示例

\n\n
\n
\n
\n Plain Text\n \n
\n
\n 
1GET /v1/workspaces/{workspaceId}/ontologies/{ontology}/objectTypes/published?search=order&status=active&searchType=NAME&listOrderByKey=PUBLISH_TIME&pageNo=1&pageSize=10\n2Host: databuilder.bd.baidubce.com\n3Authorization: xxxxxx
\n
\n
\n
\n \n

响应示例

\n\n
\n
\n
\n JSON\n \n
\n
\n 
1{\n2    \"requestId\": \"xxxx\",\n3    \"code\": \"SUCCESS\",\n4    \"result\": {\n5        \"pageNo\": 1,\n6        \"pageSize\": 10,\n7        \"totalPage\": 1,\n8        \"total\": 2,\n9        \"objectTypes\": [\n10            {\n11                \"privileges\": [\"VIEW\",\"EXECUTE\",\"MODIFY\",\"MANAGE\"],\n12                \"id\": \"id1\",\n13                \"apiName\": \"device\",   // apiName 唯一标识\n14                \"name\": \"device\",      // 英文名\n15                \"chineseName\": \"设备\",   // 中文名\n16                \"description\": \"设备对象类型\",  // 描述\n17                \"status\": \"ACTIVE\",           // 状态\n18                \"visibility\": \"PROMINENT\",    // 可见性\n19                \"indexStatus\": \"INDEXED\",     // 索引状态\n20                \"publishIssue\": \"发布失败原因\", // 发布失败原因\n21                \"updateTime\": \"2025-12-26T07:40:21.402+00:00\", // 更新时间\n22                \"modifyUser\": \"admin\",      // 修改人\n23                \"propertyCount\": 12,        // 属性数量\n24                \"linkCount\": 3,             // link 数量\n25                \"saveLocation\": \"file_ac87_0256c449fb7c\"，  // 所属位置 id\n26                 \"icon\": {         // 图标信息\n27                    \"name\": \"device.svg\",\n28                    \"color\": \"blue\"}\n29            },\n30            {\n31                \"privileges\": [\"VIEW\",\"EXECUTE\",\"MODIFY\",\"MANAGE\"],\n32                \"id\": \"id2\",\n33                \"apiName\": \"material\",\n34                \"name\": \"material\",\n35                \"chineseName\": \"物料\",\n36                \"description\": \"物料对象类型\",\n37                \"status\": \"EXPERIMENTAL\",\n38                \"visibility\": \"NORMAL\",\n39                \"indexStatus\": \"UNINDEXED\",\n40                \"publishIssue\": \"发布失败原因\",\n41                \"updateTime\": \"2025-12-26T07:40:21.402+00:00\",\n42                \"modifyUserName\": \"admin\",\n43                \"propertyCount\": 8,\n44                \"linkCount\": 1,\n45                \"saveLocationFolderId\": \"folder_ac87_0256c449fb7c\",\n46                 \"icon\": {\n47                    \"name\": \"device.svg\",\n48                    \"color\": \"blue\"}\n49            }\n50        ]\n51    }\n52}
\n
\n
\n
\n ","fields":{"slug":"jmuf9e7fc","title":"对象类型搜索","date":"2026-09-24","extractedHeadings":[]},"headings":[{"value":"接口描述","depth":2},{"value":"权限说明","depth":2},{"value":"注意事项","depth":2},{"value":"请求结构","depth":2},{"value":"请求头域","depth":2},{"value":"请求参数","depth":2},{"value":"Path 参数","depth":3},{"value":"Query 参数","depth":3},{"value":"响应头域","depth":2},{"value":"响应参数","depth":2},{"value":"result","depth":3},{"value":"result.objectTypes 元素","depth":3},{"value":"错误码","depth":2},{"value":"请求示例","depth":2},{"value":"响应示例","depth":2}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"jmuf9e7fc","prev":{"id":"Fmdzezn5a","name":"工作流及实例","path":"Fmdzezn5a","filePath":"API参考/工作流和工作实例/附录.md","seo":null,"parentIds":["jm99rjcbz","nmizr4bz2"],"parents":[{"id":"jm99rjcbz","documentId":"b03bbd23-302f-4394-b482-b080ad9e0537","name":"API参考","repoName":"DataBuilder","filePath":"API参考","disabled":false,"path":"jm99rjcbz","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null,"solutionTag":null,"solutionColor":null},{"id":"nmizr4bz2","documentId":"e1a26365-27e9-4560-b6ca-128c7bea70a5","name":"工作流及实例","repoName":"DataBuilder","filePath":"API参考/工作流和工作实例","disabled":false,"path":"nmizr4bz2","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"next":{"id":"mmufdy77n","name":"对象类型详情","path":"mmufdy77n","filePath":"API参考/本体管理/对象类型详情.md","seo":null,"parentIds":["jm99rjcbz","omuf9ddqe"],"parents":[{"id":"jm99rjcbz","documentId":"b03bbd23-302f-4394-b482-b080ad9e0537","name":"API参考","repoName":"DataBuilder","filePath":"API参考","disabled":false,"path":"jm99rjcbz","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null,"solutionTag":null,"solutionColor":null},{"id":"omuf9ddqe","documentId":"7e91749b-6045-4d95-bd23-4681ee2b3383","name":"本体管理","repoName":"DataBuilder","filePath":"API参考/本体管理","disabled":false,"path":"omuf9ddqe","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"parents":[{"id":"jm99rjcbz","documentId":"b03bbd23-302f-4394-b482-b080ad9e0537","name":"API参考","repoName":"DataBuilder","filePath":"API参考","disabled":false,"path":"jm99rjcbz","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":null,"solutionTag":null,"solutionColor":null},{"id":"omuf9ddqe","documentId":"7e91749b-6045-4d95-bd23-4681ee2b3383","name":"本体管理","repoName":"DataBuilder","filePath":"API参考/本体管理","disabled":false,"path":"omuf9ddqe","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}],"specificSeo":null}}}