监听事件

监听事件可支持在内部业务事件中提供多渠道的对外信息推送能力;监听事件可选择绑定「推送渠道」,允许该渠道监听在Quick BI上的特定事件行为,这些事件发生时,通过HTTP POST方式通知(超时10s)「推送渠道」指定的Web URL。例如在Quick BI的「测试工作空间」中新建了一张仪表板、发布了一张电子表格等。基于监听事件,可方便实现企业与Quick BI集成时的统一资源管控、权限对接、成员同步等。

重要

1.监听事件属于增值模块,需要额外购买,您可根据业务需求付费购买。

2.监听事件包含产品化配置与自动化配置两种方式,本文将为您介绍产品化配置方式。

自定义渠道的配置

新建自定义渠道

在配置监听事件前,请先配置自定义渠道。

  1. 在组织管理页面,左侧导航栏选择 办公协同 > 推送渠道管理 > 自定义渠道image

  2. 点击 自定义推送渠道 页面右上角 新建自定义渠道 按钮。image

  3. 新建自定义渠道群Webook 对话框,配置以下参数。

    2024-04-15_14-49-51

    参数

    描述

    名称

    输入自定义渠道名称。

    推送地址

    信息推送的地址,设置的接口地址需要支持 POST 请求方式。

    请求添加密钥

    验签使用,会对请求进行验签,业务方需要对收到的内容进行验签处理。

    测试并保存

    会先对接口进行一次请求,如果接口超时或者 status code 不为 2xx 则认为失败,相关的配置不会进行保存;如果没有上述问题,则相关配置将会被保存。

    说明

    每次 Quick BI 请求的最大超时时间为 10 秒

    当配置好的机器人渠道发送时连续失败超过 10 次时,该 webhooks 将会被置为「失效」状态,后续相关的业务将不会继续发送。

外部系统接收与验签方式

实际发送时,Quick BI 以 POST 的方式进行内容推送,并在请求中添加如下内容,业务方可以根据实际需要进行相关校验:

  • 请求头

    • X-TaskId:任务 ID,业务方可以使用该 ID 唯一确认一次任务请求,可以进行重复性校验(即进行重复过滤)或者在出现异常时提供给 Quick BI 业务人员进行问题定位。

  • 请求参数

    • timestamp:时间戳。

    • nonce:随机串。

    • sign:验签信息。

上述请求信息中内容主要用户 webhooks 请求的防重放以及篡改的处理,相关生成方式为:

sign = SHA256.digest(timestamp + nonce + token)

其中token的值就是创建时生成的「请求添加密钥」,业务接收方需要校验生成的 sign 是否与预期一致。

监听事件的配置

说明

Quick BI的监听事件内容默认的推送机制为:当事件满50条或者发生30秒后,才会触发任务进行推送。

事件触发条件支持配置,如需修改,请联系运维同学进行变更。

新建监听事件任务

您可以根据实际需求,对当前业务系统新增监听事件,以实时关注业务变化。具体操作如下。

  1. 开放平台 > 事件中心 > 监听事件 页面,点击右上角 新增事件 按钮。2024-04-15_14-55-07

  2. 推送事件配置 弹窗中配置事件的具体信息。image

    • 业务名称:根据实际情况输入当前事件所关联业务的描述信息。

    • 推送渠道:在下拉列表中选定当前事件需绑定的自定义推送渠道,支持的渠道类型请参见 自定义渠道webhooks

      说明

      相关自定义渠道能显示在当前下拉列表中的前提是:您已经新增了相关自定义渠道。具体操作请参见本文 新建自定义渠道 说明。

    • 监听事件:选择需要配置的具体事件,支持监听的事件信息如下表。

      事件一级分类

      事件二级分类

      事件类型

      事件类型编码

      报表管理

      仪表板

      新增/修改/保存

      PAGE.SAVE

      发布

      PAGE.PUBLISH_ONLINE

      下线

      PAGE.PUBLISH_OFFLINE

      删除

      PAGE.DELETE

      移动

      PAGE.MOVE

      另存为

      PAGE.SAVE_AS

      电子表格

      新增/修改/保存

      REPORT.MODIFY

      发布

      REPORT.PUBLISH_ONLINE

      下线

      REPORT.PUBLISH_OFFLINE

      删除

      REPORT.DELETE

      移动

      REPORT.MOVE

      另存为

      REPORT.SAVE_AS

      即席分析

      新增/修改/保存

      ANALYSIS.SAVE

      发布

      ANALYSIS.PUBLISH_ONLINE

      下线

      ANALYSIS.PUBLISH_OFFLINE

      删除

      ANALYSIS.DELETE

      移动

      ANALYSIS.MOVE

      另存为

      ANALYSIS.SAVE_AS

      自助取数

      新增/修改/保存

      DASHBOARD_OFFLINE_QUERY.SAVE

      删除

      DASHBOARD_OFFLINE_QUERY.DELETE

      移动

      DASHBOARD_OFFLINE_QUERY.MOVE

      另存为

      DASHBOARD_OFFLINE_QUERY.SAVE_AS

      数据大屏

      新增/修改/保存

      SCREEN.SAVE

      发布

      SCREEN.PUBLISH_ONLINE

      下线

      SCREEN.PUBLISH_OFFLINE

      删除

      SCREEN.DELETE

      移动

      SCREEN.MOVE

      另存为

      SCREEN.SAVE_AS

      数据填报

      新增/修改/保存

      DATAFORM.MODIFY

      删除

      DATAFORM.DELETE

      移动

      DATAFORM.MOVE

      复制

      DATAFORM.COPY_DATAFORM

      报表目录管理

      仪表板目录

      新增

      PAGE_DIRECTORY.ADD

      删除

      PAGE_DIRECTORY.DELETE

      重命名

      PAGE_DIRECTORY.RENAME

      移动

      PAGE_DIRECTORY.MOVE

      电子表格目录

      新增

      REPORT_DIRECTORY.ADD

      删除

      REPORT_DIRECTORY.DELETE

      重命名

      REPORT_DIRECTORY.RENAME

      移动

      REPORT_DIRECTORY.MOVE

      即席分析目录

      新增

      ANALYSIS_DIRECTORY.ADD

      删除

      ANALYSIS_DIRECTORY.DELETE

      重命名

      ANALYSIS_DIRECTORY.RENAME

      移动

      ANALYSIS_DIRECTORY.MOVE

      自助取数目录

      新增

      DASHBOARD_OFFLINE_QUERY_DIRECTORY.ADD

      删除

      DASHBOARD_OFFLINE_QUERY_DIRECTORY.DELETE

      重命名

      DASHBOARD_OFFLINE_QUERY_DIRECTORY.RENAME

      移动

      DASHBOARD_OFFLINE_QUERY_DIRECTORY.MOVE

      数据大屏目录

      新增

      SCREEN_DIRECTORY.ADD

      删除

      SCREEN_DIRECTORY.DELETE

      重命名

      SCREEN_DIRECTORY.RENAME

      移动

      SCREEN_DIRECTORY.MOVE

      数据填报目录

      新增

      DATAFORM_DIRECTORY.ADD

      删除

      DATAFORM_DIRECTORY.DELETE

      重命名

      DATAFORM_DIRECTORY.RENAME

      移动

      DATAFORM_DIRECTORY.MOVE

      数据集管理

      数据集

      新增/修改/保存

      CUBE.MODIFY

      移动

      CUBE.MOVE

      删除

      CUBE.DELETE

      数据集目录

      新增

      CUBE_DIRECTORY.ADD

      删除

      CUBE_DIRECTORY.DELETE

      重命名

      CUBE_DIRECTORY.MODIFY

      移动

      CUBE_DIRECTORY.MOVE

      数据门户管理

      数据门户

      新增

      DATAPORTAL.ADD

      修改/保存

      DATAPORTAL.MODIFY

      删除

      DATAPORTAL.DELETE

      授权管理

      仪表板

      授权编辑

      PAGE.SHARE_EDITOR

      授权查看

      PAGE.SHARE_VIEW

      授权导出

      PAGE.SHARE_EXPORT

      取消授权

      PAGE.STOP_SHARE

      电子表格

      授权编辑

      REPORT.SHARE_EDITOR

      授权查看

      REPORT.SHARE_VIEW

      授权导出

      REPORT.SHARE_EXPORT

      取消授权

      REPORT.STOP_SHARE

      即席分析

      授权编辑

      ANALYSIS.SHARE_EDITOR

      授权查看

      ANALYSIS.SHARE_VIEW

      授权导出

      ANALYSIS.SHARE_EXPORT

      取消授权

      ANALYSIS.STOP_SHARE

      自助取数

      授权编辑

      DASHBOARD_OFFLINE_QUERY.SHARE_EDITOR

      授权查看

      DASHBOARD_OFFLINE_QUERY.SHARE_VIEW

      授权导出

      DASHBOARD_OFFLINE_QUERY.SHARE_EXPORT

      取消授权

      DASHBOARD_OFFLINE_QUERY.STOP_SHARE

      数据大屏

      授权编辑

      SCREEN.SHARE_EDITOR

      授权查看

      SCREEN.SHARE_VIEW

      授权导出

      SCREEN.SHARE_EXPORT

      取消授权

      SCREEN.STOP_SHARE

      数据准备

      授权编辑

      ETL.SHARE_EDITOR

      取消授权

      ETL.STOP_SHARE

      数据填报

      授权编辑

      DATAFORM.SHARE_EDITOR

      授权管理全部数据

      DATAFORM.SHARE_MANAGE_ALL_DATA

      授权管理自身数据

      DATAFORM.SHARE_MANAGE_OWN_DATA

      授权提交数据

      DATAFORM.SHARE_SUBMIT_DATA

      取消授权

      DATAFORM.STOP_SHARE

      数据集

      授权编辑

      CUBE.SHARE_EDITOR

      授权使用

      CUBE.SHARE_USE

      取消授权

      CUBE.STOP_SHARE

      数据源

      授权编辑

      DATASOURCE.SHARE_EDITOR

      授权使用

      DATASOURCE.SHARE_USE

      取消授权

      DATASOURCE.STOP_SHARE

      数据门户

      授权编辑

      DATAPRODUCT.SHARE_EDITOR

      取消授权

      DATAPRODUCT.STOP_SHARE

      数据门户菜单

      授权导出

      MENU.SHARE_EXPORT

      授权查看

      MENU.SHARE_VIEW

      授权管理全部数据

      MENU.SHARE_MANAGE_ALL_DATA

      授权管理自身数据

      MENU.SHARE_MANAGE_OWN_DATA

      授权提交数据

      MENU.SHARE_SUBMIT_DATA

      取消授权

      MENU.STOP_SHARE

返回数据结构说明

每个事件类型都有与该事件相关的数据结构。不同的数据结构有所不同,但是都会包含事件的公共属性。整个事件体拆分为了事件模式版本、事件头以及事件内容三个部分。

发送事件头说明

事件头存于 header 中,包含的每个字段释义如下:

字段

字段类型

含义

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

发送事件体说明

事件头存于 event 中,包含的每个字段释义如下:

字段

字段类型

含义

operatorId

string

当前事件操作人的user_id

(Quick BI组织内用户的唯一标识)

targetId

string

操作对象ID

targetName

string

操作对象名称

targetType

string

操作对象类型

extraInfo

Map<String, String>

当前事件的额外信息

xxx

string

额外信息

报表管理事件接口说明

当创建的监听事件任务勾选报表操作事件时,包含以下相关事件接口说明。您可以在对应的业务操作中,进行对应事件的触发,并测试。

报表新增/修改/保存/另存为事件

事件类型:

事件类型

事件含义

起始版本

PAGE.SAVE

仪表板新增/修改/保存

ind_v4.5.3

REPORT.MODIFY

电子表格新增/修改/保存

ind_v4.5.3

ANALYSIS.SAVE

即席分析新增/修改/保存

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY.SAVE

自助取数新增/修改/保存

ind_v4.5.3

SCREEN.SAVE

数据大屏新增/修改/保存

ind_v4.5.4.2

DATAFORM.MODIFY

数据填报新增/修改/保存

ind_v4.7.4

PAGE.SAVE_AS

仪表板另存为

ind_v5.0.3

REPORT.SAVE_AS

电子表格另存为

ind_v5.0.3

ANALYSIS.SAVE_AS

即席分析另存为

ind_v5.0.3

DASHBOARD_OFFLINE_QUERY.SAVE_AS

自助取数另存为

ind_v5.0.3

SCREEN.SAVE_AS

数据大屏另存为

ind_v5.0.3

事件描述:通过该事件监听报表新增/修改/保存/另存为的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板 PAGE

电子表格 REPORT

即席分析ANALYSIS

自助取数 DASHBOARD_OFFLINE_QUERY

数据大屏 SCREEN

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

报表所在目录ID

directoryName

string

报表所在目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中新增/修改/保存/另存为了报表[targetId/targetName/targetType]。

「仪表板保存」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-588f-xxxx-xxxx-e92c7af083ea",
        "eventId": "b8283dd4-xxxx-xxxx-be7b-71570980566f",
        "createTime": "1676xxxx41512",
        "eventType": "PAGE.SAVE"
    },
    "event": {
        "targetName": "模板推送",
        "targetId": "04c67d55-xxxx-xxxx-xxxx-713286e40eed",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0fxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "7508891f-xxxx-xxxx-a65a-a6c4709cbdc6",
            "workspaceName": "测试工作空间",
            "directoryName": "模板推送测试",
            "workspaceId": "83619b9f-8f8c-xxxx-xxxx-55bf69cdb59b"
        }
    }
}

报表发布事件

事件类型:

事件类型

事件含义

起始版本

PAGE.PUBLISH_ONLINE

仪表板发布

ind_v4.5.3

REPORT.PUBLISH_ONLINE

电子表格发布

ind_v4.5.3

ANALYSIS.PUBLISH_ONLINE

即席分析发布

ind_v4.5.3

SCREEN.PUBLISH_ONLINE

数据大屏发布

ind_v4.5.4.2

事件描述:通过该事件监听报表发布的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板 PAGE

电子表格 REPORT

即席分析 ANALYSIS

数据大屏 SCREEN

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中发布了一张报表[targetId/targetName/targetType]

「仪表板发布」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "0152f2ab-xxxx-40c4-xxxx-c206a215d72c",
        "createTime": "1676863096609",
        "eventType": "PAGE.PUBLISH_ONLINE"
    },
    "event": {
        "targetName": "测试模版导入_2022_10_31_20_13_12_723",
        "targetId": "0857b0bc-xxxx-4058-xxxx-f926b15ae003",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "workspaceName": "测试工作空间",
            "workspaceId": "83619b9f-xxxx-4824-xxxx-55bf69cdb59b"
        }
    }
}

报表下线事件

事件类型:PAGE.PUBLISH_OFFLINE

事件类型

事件含义

起始版本

PAGE.PUBLISH_OFFLINE

仪表板下线

ind_v4.5.3

REPORT.PUBLISH_OFFLINE

电子表格下线

ind_v4.5.3

ANALYSIS.PUBLISH_OFFLINE

即席分析下线

ind_v4.5.3

SCREEN.PUBLISH_OFFLINE

数据大屏下线

ind_v4.5.4.2

事件描述:通过该事件监听报表下线的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板 PAGE

电子表格 REPORT

即席分析 ANALYSIS

数据大屏 SCREEN

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中下线了一张报表板[targetId/targetName/targetType]

「仪表板下线」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-xxxx-b3e1-e92c7af083ea",
        "eventId": "50112a64-xxxx-xxxx-ace2-d74900902ebc",
        "createTime": "167xxxx254588",
        "eventType": "PAGE.PUBLISH_OFFLINE"
    },
    "event": {
        "targetName": "测试xxxx_2022_10_31_20_13_12_723",
        "targetId": "0857b0bc-573b-xxxx-xxxx-f926b15ae003",
        "targetType": "PAGE",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "workspaceName": "测试工作空间",
            "workspaceId": "83619b9f-xxxx-xxxx-xxxx-55bf69cdb59b"
        }
    }
}

报表删除事件

事件类型:PAGE.DELETE

事件类型

事件含义

起始版本

PAGE.DELETE

仪表板删除

ind_v4.5.3

REPORT.DELETE

电子表格删除

ind_v4.5.3

ANALYSIS.DELETE

即席分析删除

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY.DELETE

自助取数删除

ind_v4.5.3

SCREEN.DELETE

数据大屏删除

ind_v4.5.4.2

事件描述:通过该事件监听报表删除的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板 PAGE

电子表格 REPORT

即席分析ANALYSIS

自助取数 DASHBOARD_OFFLINE_QUERY

数据大屏 SCREEN

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

删除报表的父目录ID

directoryName

string

删除报表的父目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中删除了一张报表[targetId/targetName/targetType]

「仪表板删除」示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-b9e9-xxxx-xxxx-cf47d6aec920",
        "eventId": "de46f9e8-8471-xxxx-xxxx-119a13d124d7",
        "createTime": "16772xxxx8960",
        "eventType": "PAGE.DELETE"
    },
    "event": {
        "targetName": "仪表板回归",
        "targetId": "3fef2261-664c-xxxx-xxxx-4de6e1788124",
        "targetType": "PAGE",
        "operatorId": "fec07414432xxxxb1905061e6a951a2",
        "extraInfo": {
            "directoryId": "f1a8fb0e-df93-xxxx-xxxx-7ba8b43ba960",
            "workspaceName": "测试工作空间",
            "directoryName": "V453",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

报表移动事件

事件类型:

事件类型

事件含义

起始版本

PAGE.MOVE

仪表板移动

ind_v4.5.3

REPORT.MOVE

电子表格移动

ind_v4.5.3

ANALYSIS.MOVE

即席分析移动

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY.MOVE

自助取数移动

ind_v4.5.3

SCREEN.MOVE

数据大屏移动

ind_v4.5.4.2

事件描述:通过该事件监听报表移动的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板 PAGE

电子表格 REPORT

即席分析ANALYSIS

自助取数 DASHBOARD_OFFLINE_QUERY

数据大屏 SCREEN

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

作品所属工作空间ID

workspaceName

string

作品所属工作空间名称

directoryId

string

作品被移动到的新目录ID

directoryName

string

作品被移动到的新目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]将仪表板[targetId/targetName/targetType]移动到了目录[directoryId/directoryName]中。

「即席分析移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "b1ba8499-5745-xxxx-xxxx-f146da27fc89",
        "createTime": "1676897694386",
        "eventType": "ANALYSIS.MOVE"
    },
    "event": {
        "targetName": "未命名的即席分析",
        "targetId": "2165d7b8-xxxx-4412-xxxx-6a4f92ca272f",
        "targetType": "ANALYSIS",
        "operatorId": "f1f4ab86b0faxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "8a2d84ac-xxxx-45ce-xxxx-6210687aae48",
            "workspaceName": "测试工作空间",
            "directoryName": "wdeqwd",
            "workspaceId": "83619b9f-xxxx-4824-xxxx-55bf69cdb59b"
        }
    }
}

报表目录管理事件接口说明

报表目录新增

事件类型:

事件类型

事件含义

起始版本

PAGE_DIRECTORY.ADD

仪表板目录新增

ind_v4.5.3

REPORT_DIRECTORY.ADD

电子表格目录新增

ind_v4.5.3

ANALYSIS_DIRECTORY.ADD

即席分析目录新增

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY_DIRECTORY.ADD

自助取数目录新增

ind_v4.5.3

SCREEN_DIRECTORY.ADD

数据大屏目录新增

ind_v4.5.4.2

DATAFORM_DIRECTORY.ADD

数据填报目录新增

ind_v4.7.4

事件描述:通过该事件监听作品目录新增的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板目录 PAGE_DIRECTORY

电子表格目录 REPORT_DIRECTORY

即席分析目录 ANALYSIS_DIRECTORY

自助取数目录 DASHBOARD_OFFLINE_QUERY_DIRECTORY

数据大屏目录 SCREEN_DIRECTORY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

新增目录所属工作空间ID

workspaceName

string

新增目录所属工作空间名称

directoryId

string

新增目录的上级目录ID

directoryName

string

新增目录的上级目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中创建了一个目录[targetId/targetName/targetType]

「仪表板目录新增」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-xxxx-b3e1-e92c7af083ea",
        "eventId": "084b72bc-xxxx-xxxx-8c94-34f28fc109fd",
        "createTime": "1676xxxx22991",
        "eventType": "PAGE_DIRECTORY.ADD"
    },
    "event": {
        "targetName": "dasdasdsad",
        "targetId": "6f113f65-90fa-xxxx-xxxx-4a94fe28d5e8",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "f1f4ab86b0fa44xxxx2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "测试工作空间",
            "directoryName": "根目录",
            "workspaceId": "83619b9f-xxxx-xxxx-a87f-55bf69cdb59b"
        }
    }
}

报表目录重命名

事件类型:

事件类型

事件含义

起始版本

PAGE_DIRECTORY.RENAME

仪表板目录重命名

ind_v4.5.3

REPORT_DIRECTORY.RENAME

电子表格目录新增重命名

ind_v4.5.3

ANALYSIS_DIRECTORY.RENAME

即席分析目录新增重命名

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY_DIRECTORY.RENAME

自助取数目录新增重命名

ind_v4.5.3

SCREEN_DIRECTORY.RENAME

数据大屏目录重命名

ind_v4.5.4.2

事件描述:通过该事件监听作品目录重命名的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板目录 PAGE_DIRECTORY

电子表格目录 REPORT_DIRECTORY

即席分析目录 ANALYSIS_DIRECTORY

自助取数目录 DASHBOARD_OFFLINE_QUERY_DIRECTORY

数据大屏目录 SCREEN_DIRECTORY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

originalDirectoryId

string

报表目录ID

originalDirectoryName

string

报表目录原名

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中重命名了一个目录[targetId/targetName/targetType],目录原名为[originalDirectoryName/originalDirectoryId]

「仪表板目录重命名」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "87473a10-xxxx-4d61-xxxx-2017ba082802",
        "createTime": "1677047794924",
        "eventType": "PAGE_DIRECTORY.RENAME"
    },
    "event": {
        "targetName": "打发发到谁发发发",
        "targetId": "ed8d7194-xxxx-42c1-xxxx-4d00c7892056",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "originalDirectoryId": "ed8d7194-xxxx-42c1-xxxx-4d00c7892056",
            "workspaceName": "测试资源包导入",
            "originalDirectoryName": "打发发到谁",
            "workspaceId": "3e60ee7f-xxxx-4231-xxxx-f6d25fcaa886"
        }
    }
}

报表目录删除

事件类型:

事件类型

事件含义

起始版本

PAGE_DIRECTORY.DELETE

仪表板目录删除

ind_v4.5.3

REPORT_DIRECTORY.DELETE

电子表格目录删除

ind_v4.5.3

ANALYSIS_DIRECTORY.DELETE

即席分析目录删除

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY_DIRECTORY.DELETE

自助取数目录删除

ind_v4.5.3

SCREEN_DIRECTORY.DELETE

数据大屏目录删除

ind_v4.5.4.2

事件描述:通过该事件监听作品目录删除的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板目录 PAGE_DIRECTORY

电子表格目录 REPORT_DIRECTORY

即席分析目录 ANALYSIS_DIRECTORY

自助取数目录 DASHBOARD_OFFLINE_QUERY_DIRECTORY

数据大屏目录 SCREEN_DIRECTORY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

删除目录的父目录ID

directoryName

string

删除目录的父目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中删除了一个目录[targetId/targetName/targetType]

「仪表板目录删除」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "420aa716-fa7exxxx4306-xxxx-5bf154213618",
        "createTime": "1677203667959",
        "eventType": "PAGE_DIRECTORY.DELETE"
    },
    "event": {
        "targetName": "打算发放给",
        "targetId": "6a8fdc4c-94ac-xxxx-9e3b-ffd40578973b",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "测试工作空间",
            "directoryName": "根目录",
            "workspaceId": "4d86aec9-14f7-xxxx-v-6de40d6386ad"
        }
    }
}

报表目录移动

事件类型:

事件类型

事件含义

起始版本

PAGE_DIRECTORY.MOVE

仪表板目录移动

ind_v4.5.3

REPORT_DIRECTORY.MOVE

电子表格目录移动

ind_v4.5.3

ANALYSIS_DIRECTORY.MOVE

即席分析目录移动

ind_v4.5.3

DASHBOARD_OFFLINE_QUERY_DIRECTORY.MOVE

自助取数目录移动

ind_v4.5.3

SCREEN_DIRECTORY.MOVE

数据大屏目录移动

ind_v4.5.4.2

事件描述:通过该事件监听作品目录移动的行为。

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

仪表板目录 PAGE_DIRECTORY

电子表格目录 REPORT_DIRECTORY

即席分析目录 ANALYSIS_DIRECTORY

自助取数目录 DASHBOARD_OFFLINE_QUERY_DIRECTORY

数据大屏目录 SCREEN_DIRECTORY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

移动到的报表目录ID

directoryName

string

移动到的报表目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中将一个目录[targetId/targetName/targetType]移动到[xxx]

「仪表板目录移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "a2782313-db6e-xxxx-xxxx-81b96d0cb77b",
        "createTime": "16770xxxx985",
        "eventType": "PAGE_DIRECTORY.MOVE"
    },
    "event": {
        "targetName": "测试",
        "targetId": "95fb0822-197f-xxxx-xxxx-3087aa510d93",
        "targetType": "PAGE_DIRECTORY",
        "operatorId": "fec07414432xxxx905061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "测试工作空间",
            "directoryName": "根目录",
            "workspaceId": "3e60ee7f-a99f-xxxx-xxxx-f6d25fcaa886"
        }
    }
}

数据集管理事件

数据集新增/修改/保存事件

事件类型: CUBE.MODIFY

事件描述:通过该事件监听数据集保存的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

数据集ID

targetName

string

数据集名称

targetType

string

操作对象类型:

数据集 CUBE

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

数据集所属工作空间ID

workspaceName

string

数据集所属工作空间名称

directoryId

string

数据集所在目录ID

directoryName

string

数据集所在目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中创建了一个数据集[targetId/targetName/targetType]

「数据集保存」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "4332e2c3-xxxx-xxxx-a447-c1d938766cf1",
        "createTime": "16770xxxx5986",
        "eventType": "CUBE.MODIFY"
    },
    "event": {
        "targetName": "测试",
        "targetId": "9f7ab6fd-xxxx-xxxx-9df6-f63e735cb3f2",
        "targetType": "CUBE",
        "operatorId": "fec07414432xxxx4b1905061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "测试导入",
            "directoryName": "根目录",
            "workspaceId": "3e60ee7f-a99f-xxxx-xxxx-f6d25fcaa886"
        }
    }
}

数据集移动

事件类型: CUBE.MOVE

事件描述:通过该事件监听数据集移动的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

数据集 CUBE

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

数据集所属工作空间ID

workspaceName

string

数据集所属工作空间名称

directoryId

string

移动到的目录ID

directoryName

string

移动到的目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]将仪表板[targetId/targetName/targetType]移动到了目录[directoryId/directoryName]中。

「即席分析移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-58xxxx8f-xxxx-b3e1-e92c7af083ea",
        "eventId": "b1ba8499-5745-xxxx-xxxx-f146da27fc89",
        "createTime": "16768xxxx94386",
        "eventType": "ANALYSIS.MOVE"
    },
    "event": {
        "targetName": "未命名的即席分析",
        "targetId": "2165d7b8-xxxx-4412-xxxx-6a4f92ca272f",
        "targetType": "ANALYSIS",
        "operatorId": "f1f4ab86b0fxxxxe2fbe0a204675a1",
        "extraInfo": {
            "directoryId": "8a2d84ac-xxxx-45cexxxxabe3-6210687aae48",
            "workspaceName": "测试工作空间",
            "directoryName": "wdeqwd",
            "workspaceId": "83619b9f-xxxx-xxxx-a87f-55bf69cdb59b"
        }
    }
}

数据集删除

事件类型: CUBE.DELETE

事件描述:通过该事件监听数据集删除的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

数据集 CUBE

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

数据集所属工作空间ID

workspaceName

string

数据集所属工作空间名称

directoryId

string

数据集父目录ID

directoryName

string

数据集父目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]将仪表板[targetId/targetName/targetType]移动到了目录[directoryId/directoryName]中。

「即席分析移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7dxxxx9f20-cf47d6aec920",
        "eventId": "d8acd8be-46b2-xxxx-xxxx-d46f80ffb008",
        "createTime": "167705xxxx0252",
        "eventType": "CUBE.DELETE"
    },
    "event": {
        "targetName": "null",
        "targetId": "8c9f808f-xxxx-xxxx-8e3a-788d7514b864",
        "targetType": "CUBE",
        "operatorId": "fec07414432xxxx4b1905061e6a951a2",
        "extraInfo": {
            "workspaceName": "测试工作空间",
            "workspaceId": "3e60ee7f-xxxx-xxxx-9138-f6d25fcaa886"
        }
    }
}

数据集目录新增

事件类型: CUBE_DIRECTORY.MODIFY

事件描述:通过该事件监听数据集目录新增的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

数据集目录 CUBE_DIRECTORY.MODIFY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

新增目录所属工作空间ID

workspaceName

string

新增目录所属工作空间名称

directoryId

string

新增目录的上级目录ID

directoryName

string

新增目录的上级目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中创建了一个目录[targetId/targetName/targetType]

「数据集目录新增」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "2ce66456-xxxx-4271-xxxx-a6170c4df59d",
        "createTime": "1677203977445",
        "eventType": "CUBE_DIRECTORY.ADD"
    },
    "event": {
        "targetName": "打的方法",
        "targetId": "9283fe90-xxxx-4206-xxxx-57581b53542a",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "directoryId": "-1",
            "workspaceName": "测试工作空间",
            "directoryName": "根目录",
            "workspaceId": "4d86aec9-xxxx-493e-xxxx-6de40d6386ad"
        }
    }
}

数据集目录重命名

事件类型: CUBE_DIRECTORY.MODIFY

事件描述:通过该事件监听作品目录重命名的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

数据集目录 CUBE_DIRECTORY.MODIFY

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

数据集目录所属工作空间ID

workspaceName

string

数据集目录所属工作空间名称

originalDirectoryId

string

数据里目录ID

originalDirectoryName

string

数据集目录原名

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中重命名了一个目录[targetId/targetName/targetType],目录原名为[originalDirectoryName/originalDirectoryId]

「数据集目录重命名」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "005593c0-3904-xxxx-xxxx-49eb08056fe8",
        "createTime": "167xxxx05737",
        "eventType": "CUBE_DIRECTORY.MODIFY"
    },
    "event": {
        "targetName": "方法的健身房",
        "targetId": "f098d41a-v-xxxx-992f-f0eeadbf758c",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec0741443204xxxx05061e6a951a2",
        "extraInfo": {
            "originalDirectoryId": "f098d41a-xxxx-xxxx-992f-f0eeadbf758c",
            "workspaceName": "测试工作空间",
            "originalDirectoryName": "方法",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

数据集目录删除

事件类型: CUBE_DIRECTORY.DELETE

事件描述:通过该事件监听数据集目录删除的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

数据集目录ID

targetName

string

数据集目录名称

targetType

string

操作对象类型:

数据集目录 CUBE_DIRECTORY.DELETE

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

删除目录的父目录ID

directoryName

string

删除目录的父目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中删除了一个目录[targetId/targetName/targetType]

「数据集目录删除」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-4a7d-xxxx-cf47d6aec920",
        "eventId": "635a0094-3941-xxxx-xxxx-692dbeaeabc5",
        "createTime": "1677xxxx6406",
        "eventType": "CUBE_DIRECTORY.DELETE"
    },
    "event": {
        "targetName": "null",
        "targetId": "2e07d9ce-xxxx-xxxx-b0a1-db1dcf614e96",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec07414xxxx4b1905061e6a951a2",
        "extraInfo": {
            "workspaceName": "测试工作空间",
            "workspaceId": "4d86aec9-xxxx-xxxx-b1d8-6de40d6386ad"
        }
    }
}

数据集目录移动

事件类型: CUBE_DIRECTORY.MOVE

事件描述:通过该事件监听作品目录移动的行为。

版本起始:@since ind_v4.5.3

事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

eventId

string

事件ID

eventType

string

事件类型

createTime

string

事件的创建时间(时间戳)

organizationId

string

当前事件所属的组织ID

event

-

-

operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

targetId

string

报表ID

targetName

string

报表名称

targetType

string

操作对象类型:

数据集目录 CUBE_DIRECTORY.DELETE

extraInfo

Map<String, String>

事件的其他参考信息

workspaceId

string

报表所属工作空间ID

workspaceName

string

报表所属工作空间名称

directoryId

string

移动到的父目录ID

directoryName

string

移动到的父目录名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]的目录[directoryId/directoryName]中将一个目录[targetId/targetName/targetType]移动到[xxx]

「数据集目录移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "b5fb3d10-xxxx-xxxx-9f20-cf47d6aec920",
        "eventId": "77f565ae-xxxx-xxxx-a63b-8b2e5a684019",
        "createTime": "1677xxxx2297",
        "eventType": "CUBE_DIRECTORY.MOVE"
    },
    "event": {
        "targetName": "V45日期类型",
        "targetId": "f5f86731-04cd-xxxx-xxxx-48600f159c2b",
        "targetType": "CUBE_DIRECTORY",
        "operatorId": "fec07414432041xxxx5061e6a951a2",
        "extraInfo": {
            "directoryId": "f098d41a-xxxx-xxxx-992f-f0eeadbf758c",
            "workspaceName": "测试工作空间",
            "directoryName": "方法的健身房",
            "workspaceId": "4d86aec9-14f7-xxxx-xxxx-6de40d6386ad"
        }
    }
}

数据门户管理事件

数据门户新增

  • 事件类型: DATAPORTAL.ADD

  • 事件描述:通过该事件监听数据门户新增的行为。

  • 版本起始:@since ind_v4.6.0.2

  • 事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

  • eventId

string

事件ID

  • eventType

string

事件类型

  • createTime

string

事件的创建时间(时间戳)

  • organizationId

string

当前事件所属的组织ID

event

-

-

  • operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

  • targetId

string

操作对象ID

  • targetName

string

操作对象名称

  • targetType

string

操作对象类型:

  • 数据门户:DATAPORTAL

  • extraInfo

Map<String, String>

事件的其他参考信息

  • workspaceId

string

操作对象所属工作空间ID

  • workspaceName

string

操作对象所属工作空间名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中创建了一个数据门户[targetId/targetName/targetType]

  • 「数据集目录移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.ADD"
    },
    "event": {
        "targetName": "新建站点",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "测试空间",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

数据门户修改/保存

  • 事件类型: DATAPORTAL.MODIFY

  • 事件描述:通过该事件监听数据门户修改保存的行为。

  • 版本起始:@since ind_v4.6.0.2

  • 事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

  • eventId

string

事件ID

  • eventType

string

事件类型

  • createTime

string

事件的创建时间(时间戳)

  • organizationId

string

当前事件所属的组织ID

event

-

-

  • operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

  • targetId

string

操作对象ID

  • targetName

string

操作对象名称

  • targetType

string

操作对象类型:

  • 数据集门户:DATAPORTAL

  • extraInfo

Map<String, String>

事件的其他参考信息

  • workspaceId

string

操作对象所属工作空间ID

  • workspaceName

string

操作对象所属工作空间名称

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中修改/保存了一个数据门户[targetId/targetName/targetType]

  • 「数据集目录移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.MODIFY"
    },
    "event": {
        "targetName": "新建站点",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "测试空间",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

数据门户删除

  • 事件类型: DATAPORTAL.DELETE

  • 事件描述:通过该事件监听数据门户删除的行为。

  • 版本起始:@since ind_v4.6.0.2

  • 事件体:

名称

类型

描述

schema

string

事件模式

header

event_header

事件头

  • eventId

string

事件ID

  • eventType

string

事件类型

  • createTime

string

事件的创建时间(时间戳)

  • organizationId

string

当前事件所属的组织ID

event

-

-

  • operatorId

string

当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

  • targetId

string

操作对象ID

  • targetName

string

操作对象名称

  • targetType

string

操作对象类型:

  • 数据门户:DATAPORTAL

  • extraInfo

Map<String, String>

事件的其他参考信息

  • workspaceId

string

操作对象所属工作空间ID

  • workspaceName

string

操作对象所属工作空间名称

  • directoryId

string

操作对象所在目录ID

以上事件体可对当前事件翻译为:[operator]在时间[createTime]于工作空间[workspaceId/workspaceName]中删除了一个数据门户[targetId/targetName/targetType]

  • 「数据集目录移动」事件体示例:

{
    "schema": "1.0",
    "header": {
        "organizationId": "2fe4fbd8-xxxx-489a-xxxx-e92c7af083ea",
        "eventId": "6bfb14a1-xxxx-4be3-xxxx-73cec74d2fd4",
        "createTime": "1683276951024",
        "eventType": "DATAPORTAL.DELETE"
    },
    "event": {
        "targetName": "新建站点",
        "targetId": "e5294d62-xxxx-433b-xxxx-2178623b319c",
        "targetType": "DATAPORTAL",
        "operatorId": "9ab47db9xxxx4098axxxx8e6cca0d465",
        "extraInfo": {
            "workspaceName": "测试空间",
            "workspaceId": "0def8c85-xxxx-40f6-xxxx-0de02ed4e175"
        }
    }
}

授权管理事件接口说明

当创建的事件订阅任务勾选授权操作事件时,包含以下相关事件接口说明。您可以通过在对应业务操作中,进行对应事件的触发,并测试。

报表授权事件

  • 事件类型:

    事件类型

    事件含义

    版本起始

    PAGE.SHARE_EDITOR

    仪表板-授权编辑

    ind_v5.1.2

    PAGE.SHARE_VIEW

    仪表板-授权查看

    ind_v5.1.2

    PAGE.SHARE_EXPORT

    仪表板-授权导出

    ind_v5.1.2

    PAGE.STOP_SHARE

    仪表板-取消授权

    ind_v5.1.2

    REPORT.SHARE_EDITOR

    电子表格-授权编辑

    ind_v5.1.2

    REPORT.SHARE_VIEW

    电子表格-授权查看

    ind_v5.1.2

    REPORT.SHARE_EXPORT

    电子表格-授权导出

    ind_v5.1.2

    REPORT.STOP_SHARE

    电子表格-取消授权

    ind_v5.1.2

    ANALYSIS.SHARE_EDITOR

    即席分析-授权编辑

    ind_v5.1.2

    ANALYSIS.SHARE_VIEW

    即席分析-授权查看

    ind_v5.1.2

    ANALYSIS.SHARE_EXPORT

    即席分析-授权导出

    ind_v5.1.2

    ANALYSIS.STOP_SHARE

    即席分析-取消授权

    ind_v5.1.2

    DASHBOARD_OFFLINE_QUERY.SHARE_EDITOR

    自助取数-授权编辑

    ind_v5.1.2

    DASHBOARD_OFFLINE_QUERY.SHARE_VIEW

    自助取数-授权查看

    ind_v5.1.2

    DASHBOARD_OFFLINE_QUERY.SHARE_EXPORT

    自助取数-授权导出

    ind_v5.1.2

    DASHBOARD_OFFLINE_QUERY.STOP_SHARE

    自助取数-取消授权

    ind_v5.1.2

    SCREEN.SHARE_EDITOR

    数据大屏-授权编辑

    ind_v5.1.2

    SCREEN.SHARE_VIEW

    数据大屏-授权查看

    ind_v5.1.2

    SCREEN.SHARE_EXPORT

    数据大屏-授权导出

    ind_v5.1.2

    SCREEN.STOP_SHARE

    数据大屏-取消授权

    ind_v5.1.2

  • 事件描述:授权报表事件

  • 事件体:

    名称

    类型

    描述

    schema

    string

    事件模式

    header

    event_header

    事件头

    • eventId

    string

    事件ID

    • eventType

    string

    事件类型

    • createTime

    string

    事件的创建时间(时间戳)

    • organizationId

    string

    当前事件所属的组织ID

    event

    -

    -

    • operatorId

    string

    当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

    • targetId

    string

    报表ID

    • targetName

    string

    报表名称

    • targetType

    string

    操作对象类型:

    仪表板 PAGE

    电子表格 REPORT

    即席分析ANALYSIS

    自助取数 DASHBOARD_OFFLINE_QUERY

    数据大屏 SCREEN

    • grantedId

    string

    被授权目标ID

    • grantedType

    string

    被授权目标类型:

    • 用户 USER

    • 全部组织成员 ALLUSER

    • 全部空间成员 WORKSPACEUSER

    • 用户组 USERGROUP

    以上事件体可对当前事件翻译为:[operator]在时间[createTime]将报表[targetId/targetName/targetType]授权给指定目标[grantedId/grantedType]

  • 「报表授权」事件体示例:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "PAGE.SHARE_EDITOR"
  },
  "event": {
    "targetName": "未命名_202404111755_副本",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "PAGE",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

数据准备、数据集和数据源授权事件

  • 事件类型:

    事件类型

    事件含义

    版本起始

    ETL.SHARE_EDITOR

    数据准备-授权编辑

    ind_v5.1.2

    ETL.STOP_SHARE

    数据准备-取消授权

    ind_v5.1.2

    CUBE.SHARE_EDITOR

    数据集-授权编辑

    ind_v5.1.2

    CUBE.SHARE_USE

    数据集-授权使用

    ind_v5.1.2

    CUBE.STOP_SHARE

    数据集-取消授权

    ind_v5.1.2

    DATASOURCE.SHARE_EDITOR

    数据源-授权编辑

    ind_v5.1.2

    DATASOURCE.SHARE_USE

    数据源-授权使用

    ind_v5.1.2

    DATASOURCE.STOP_SHARE

    数据源-取消授权

    ind_v5.1.2

  • 事件描述:授权数据准备、数据集和数据源事件

  • 事件体:

    名称

    类型

    描述

    schema

    string

    事件模式

    header

    event_header

    事件头

    • eventId

    string

    事件ID

    • eventType

    string

    事件类型

    • createTime

    string

    事件的创建时间(时间戳)

    • organizationId

    string

    当前事件所属的组织ID

    event

    -

    -

    • operatorId

    string

    当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

    • targetId

    string

    报表ID

    • targetName

    string

    报表名称

    • targetType

    string

    操作对象类型

    • ETL 数据准备

    • CUBE 数据集

    • DATASOURCE 数据源

    • grantedId

    string

    被授权目标ID

    • grantedType

    string

    被授权目标类型:

    • 用户 USER

    • 全部组织成员 ALLUSER

    • 全部空间成员 WORKSPACEUSER

    • 用户组 USERGROUP

    以上事件体可对当前事件翻译为:[operator]在时间[createTime]将数据准备/数据集/数据源[targetId/targetName/targetType]授权给指定目标[grantedId/grantedType]

  • 「数据准备/数据集/数据源授权」事件体示例:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "ETL.SHARE_EDITOR"
  },
  "event": {
    "targetName": "未命名_202404111755_副本",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "ETL",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

数据填报授权事件

  • 事件类型:

    事件类型

    事件含义

    版本起始

    DATAFORM.SHARE_EDITOR

    授权编辑

    ind_v5.1.2

    DATAFORM.SHARE_MANAGE_ALL_DATA

    授权管理全部数据

    ind_v5.1.2

    DATAFORM.SHARE_MANAGE_OWN_DATA

    授权管理自身数据

    ind_v5.1.2

    DATAFORM.SHARE_SUBMIT_DATA

    授权提交数据

    ind_v5.1.2

    DATAFORM.STOP_SHARE

    取消授权

    ind_v5.1.2

  • 事件描述:授权数据填报事件

  • 事件体:

    名称

    类型

    描述

    schema

    string

    事件模式

    header

    event_header

    事件头

    • eventId

    string

    事件ID

    • eventType

    string

    事件类型

    • createTime

    string

    事件的创建时间(时间戳)

    • organizationId

    string

    当前事件所属的组织ID

    event

    -

    -

    • operatorId

    string

    当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

    • targetId

    string

    报表ID

    • targetName

    string

    报表名称

    • targetType

    string

    操作对象类型

    • DATAFORM 数据填报

    • grantedId

    string

    被授权目标ID

    • grantedType

    string

    被授权目标类型:

    • 用户 USER

    • 全部组织成员 ALLUSER

    • 全部空间成员 WORKSPACEUSER

    • 用户组 USERGROUP

    以上事件体可对当前事件翻译为:[operator]在时间[createTime]将数据填报[targetId/targetName/targetType]授权给指定目标[grantedId/grantedType]

  • 「数据填报授权」事件体示例:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "DATAFORM.SHARE_EDITOR"
  },
  "event": {
    "targetName": "未命名_202404111755_副本",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "DATAFORM",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}

数据门户授权事件

  • 事件类型:

    事件类型

    事件含义

    版本起始

    DATAPRODUCT.SHARE_EDITOR

    数据门户-授权编辑

    ind_v5.1.2

    DATAPRODUCT.STOP_SHARE

    数据门户-取消授权

    ind_v5.1.2

    MENU.SHARE_EXPORT

    数据门户菜单-授权导出

    ind_v5.1.2

    MENU.SHARE_VIEW

    数据门户菜单-授权查看

    ind_v5.1.2

    MENU.SHARE_MANAGE_ALL_DATA

    数据门户菜单-授权管理全部数据

    ind_v5.1.2

    MENU.SHARE_MANAGE_OWN_DATA

    数据门户菜单-授权管理自身数据

    ind_v5.1.2

    MENU.SHARE_SUBMIT_DATA

    数据门户菜单-授权提交数据

    ind_v5.1.2

    MENU.STOP_SHARE

    数据门户菜单-取消授权

    ind_v5.1.2

  • 事件描述:授权数据门户事件

  • 事件体:

    名称

    类型

    描述

    schema

    string

    事件模式

    header

    event_header

    事件头

    • eventId

    string

    事件ID

    • eventType

    string

    事件类型

    • createTime

    string

    事件的创建时间(时间戳)

    • organizationId

    string

    当前事件所属的组织ID

    event

    -

    -

    • operatorId

    string

    当前事件操作人的user_id(Quick BI组织内用户的唯一标识)

    • targetId

    string

    报表ID

    • targetName

    string

    报表名称

    • targetType

    string

    操作对象类型

    • DATAPRODUCT 数据门户

    • MENU 数据门户菜单

    • grantedId

    string

    被授权目标ID

    • grantedType

    string

    被授权目标类型:

    • 用户 USER

    • 全部组织成员 ALLUSER

    • 全部空间成员 WORKSPACEUSER

    • 用户组 USERGROUP

    以上事件体可对当前事件翻译为:[operator]在时间[createTime]将数据门户[targetId/targetName/targetType]授权给指定目标[grantedId/grantedType]

  • 「数据门户授权」事件体示例:

{
  "schema": "1.0",
  "header": {
    "organizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
    "eventId": "637c2c83-6e12-465b-8dc9-e5864586cf24",
    "createTime": "1716433937829",
    "eventType": "DATAPRODUCT.SHARE_EDITOR"
  },
  "event": {
    "targetName": "未命名_202404111755_副本",
    "grantedId": "39735014-1eab-44ac-b94b-f0947990d6df",
    "targetId": "8c699d2e-a5f1-4d48-9dd1-e91e060f5894",
    "grantedType": "WORKSPACEUSER",
    "targetType": "DATAPRODUCT",
    "operatorId": "f1f4ab86b0fa44519e2fbe0a204675a1"
  }
}