查询所有 Schema 记录

GET

/yiask_schema:list

支持通过 URL 参数进行过滤和关联查询。

示例：查询指定 Schema 并加载 properties 关联

bash curl --location -g --request GET 'http://localhost:13000/api/yiask_schema:list?filter[id]=dim_prods&filter[database.database]=demo-test&appends=properties' \\ --header 'X-SPACES: default' \\ --header 'Authorization: Bearer YOUR_TOKEN'

过滤参数说明： - filter[id]=xxx - 按 ID 过滤 - filter[database.database]=yyy - 按关联字段过滤（belongs_to 关系） - appends=properties - 加载 properties 关联数据

多个 appends 用逗号分隔： bash appends=properties,database,someOtherRelation

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

Header 参数

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/yiask_schema:list?filter=id=xxx%26database.database=yyy&appends=properties,database' \
--header 'X-SPACES: default' \
--header 'X-SPACES: {{space}}' \
--header 'Authorization: Bearer <token>'

返回响应

🟢200成功

application/json

Schema 列表

Body

示例

[
    {
        "sid": "string",
        "id": "string",
        "name": "string",
        "title": "string",
        "spaceName": "string",
        "db": "string",
        "properties": [
            {
                "sid": "string",
                "id": "string",
                "name": "string",
                "type": "string",
                "primal_type": "string",
                "fiele_type": "string",
                "description": "string",
                "schemaID": "string",
                "ref": "string",
                "SemanticType": "string",
                "is_analyzable": true,
                "isMetric": true,
                "syno": [
                    "string"
                ]
            }
        ],
        "type": "entity"
    }
]

修改于 2026-03-27 07:29:34

更新自定义指标记录

查询所有 Property 记录