Skip to main content

查询专家套件分类接口

查询专家套件分类的名称、排序值和修订号。分类标识可用于筛选专家套件列表或为资源指定分类。

  • Scope：admin.v1.expert-suites.read
  • 权限项：专家套件读取（expert-suites）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/expert-suite-categories

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
keywordquerystring否搜索关键词"<string>"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/expert-suite-categories?keyword=<keyword>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray<OpenapifacadeCategoryResponse>是记录列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

字段类型必填说明
category_idstring · uuid是分类（分类 ID）
namestring是分类名称
orderinteger · int64是排序
revisioninteger · int64是分类版本号；更新时作为 expected_revision 传入，用于并发更新校验
{
  "items": [
    {
      "category_id": "<uuid>",
      "name": "<string>",
      "order": 0,
      "revision": 1
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}