1. 接口说明

产品支持自定义和指标系统(第三方指标数据),该接口支持了从第三方同步指标元信息。

2. 基本信息

名称 参数
API /api/dash/mammutIndicator/sync
METHOD POST

2.1 请求参数


同步指标系统的数据分为三种情况, 全量同步, 单个指标信息同步 以及 删除指标信息

1. 批量同步 : 用于批量同步指标信息, 全量同步某一来源的指标信息;保存数组内的指标信息,同时删除属于该来源的其余指标信息。

字段名称 参数类型 参数说明
type String 标记同步的类型, 全量同步时为 full
source String 用于标记第三方来源
mammutIndicators Array\ 指标数组, 其中 MammutIndicator 为指标对象

2. 单个指标信息同步: 更新或新建某一个指标信息

字段名称 参数类型 参数说明
type String 标记同步的类型, 单个指标信息同步时为 single
source String 用于标记第三方来源
mammutIndicator MammutIndicator 指标对象: MammutIndicator

3. 删除指标信息: 根据 指标ID和来源 删除产品中的某一个指标信息

字段名称 参数类型 参数说明
type String 标记同步的类型, 删除指标信息时为 delete
source String 用于标记第三方来源
mammutIndicator MammutIndicator 指标对象: MammutIndicator

其中 MammutIndicator 的结构

字段名称 参数类型 参数说明
indicatorId Int 指标ID+source, 用于唯一标示
name String(Optional) 指标名称
caliber String(Optional) 业务口径
techCaliber String(Optional) 技术口径, 例如SQL等信息, 用于辅助了解指标信息

2.2 接口返回


// 成功
{ "code": 200 }
// 失败
{
    "code": 731,
    "message": "",    // 报错信息
}