用途:通过 Omni REST API 探索和理解 Omni 语义模型,是建模、查询或修改前的起点,建议先查看 Shared 模型(包含经过整理的语义层)。
主要能力:自上而下探索——列出模型→选择模型→列出主题→查看主题→探索视图与字段。可读取模型 YAML(支持按文件名或正则过滤、按分支获取),并支持字段影响分析:在分支上运行内容校验器,找出因字段迁移或删除而引用破损的仪表板和磁贴,再结合 YAML 搜索汇总影响范围报告。
必要用法:先设置环境变量 export OMNI_BASE_URL="https://yourorg.omniapp.co" 和 export OMNI_API_KEY="your-api-key"。API 密钥来自 Settings > API Keys(组织管理员)或用户资料中的个人访问令牌。不确定端点或参数时,可获取 OpenAPI 规范:curl -L "$OMNI_BASE_URL/openapi.json" -H "Authorization: Bearer $OMNI_API_KEY"。
核心调用:列出模型 curl -L "$OMNI_BASE_URL/api/v1/models" -H "Authorization: Bearer $OMNI_API_KEY";列出主题 curl -L "$OMNI_BASE_URL/api/v1/models/{modelId}/topic" -H "Authorization: Bearer $OMNI_API_KEY";查看主题 curl -L "$OMNI_BASE_URL/api/v1/models/{modelId}/topic/{topicName}" -H "Authorization: Bearer $OMNI_API_KEY";读取 YAML curl -L "$OMNI_BASE_URL/api/v1/models/{modelId}/yaml" -H "Authorization: Bearer $OMNI_API_KEY"。
关键概念:视图对应数据库表,含维度与度量;主题将视图连接为可查询单元,含基础视图、默认过滤器和 AI 上下文;关系定义连接方式与类型。字段命名形如 view_name.field_name。计算字段使用 calc_name 和 sql_expression。
限制:仅使用指定 API 端点,具体端点或参数以 OpenAPI 规范为准;其他细节暂未提供。