研发行为

事件来源 #

事件主要有两类来源:软件本身的使用行为以及通过webhook接收的第三方数据.

事件数据结构 #

属性 类型 说明
event_id string 事件ID
user_id string 用户ID
user_display_name string 用户名称
project_id string 项目ID
project_name string 项目名称
event_type int 事件类型
event_time long 事件时间
ref_type int 引用类型
ref_id string 引用ID
event_data 事件内容

事件类型 #

ID 说明
EVENT_TYPE_USER 0 用户相关事件
EVENT_TYPE_PROJECT 1 除任务,缺陷,项目计划,文档,网盘外的项目事件
EVENT_TYPE_TASK 2 任务事件
EVENT_TYPE_BUG 3 缺陷事件
EVENT_TYPE_SPRIT 4 项目迭代事件
EVENT_TYPE_DOC 5 文档事件
EVENT_TYPE_DISK 6 网盘事件
EVENT_TYPE_WORK_SNAPSHOT 7 工作快照事件
EVENT_TYPE_APP 8 项目应用事件
EVENT_TYPE_BOOK_SHELF 9 电子书事件
EVENT_TYPE_ROBOT 10 机器人事件
EVENT_TYPE_EARTHLY 11 ci/cd事件
EVENT_TYPE_GITLAB 100 gitlab事件
EVENT_TYPE_GITHUB 101 github事件
EVENT_TYPE_GITEA 102 gitea事件
EVENT_TYPE_GITEE 103 gitee事件
EVENT_TYPE_GOGS 104 gogs事件
EVENT_TYPE_JIRA 105 jira事件
EVENT_TYPE_CONFLUENCE 106 confluence事件
EVENT_TYPE_JENKINS 107 jenkins事件

引用类型 #

ID 说明
EVENT_REF_TYPE_NONE 0 无引用
EVENT_REF_TYPE_USER 1 用户相关
EVENT_REF_TYPE_PROJECT 2 项目相关
EVENT_REF_TYPE_CHANNEL 3 频道相关
EVENT_REF_TYPE_SPRIT 4 迭代相关
EVENT_REF_TYPE_TASK 5 任务相关
EVENT_REF_TYPE_BUG 6 缺陷相关
EVENT_REF_TYPE_DOC 7 文档相关
EVENT_REF_TYPE_BOOK 8 电子书相关
EVENT_REF_TYPE_ROBOT 9 机器人相关
EVENT_REF_TYPE_REPO 10 代码仓库相关

事件内容格式 #

{
    "EVENT_CATE": {
        "EVENT_TYPE":{
            "EVENT_ATTR": "ATTR_VALUE"
        },
    }
}

EVENT_CATE表示事件类型,EVENT_TYPE表示每类事件中的特定事件.EVENT_ATTR和ATTR_VALUE表示事件的参数和值.

EVENT_CATE取值列表 #

类别ID 名称
ProjectEvent 项目事件
ProjectDocEvent 文档事件
SpritEvent 迭代事件
IssueEvent 工单事件
BookShelfEvent 电子书事件
ExtEvEvent 第三方接入事件
RobotEvent 机器人事件
EarthlyEvent earthly事件
GitlabEvent gitlab事件
GiteeEvent gitee事件

其他 #

我们提供了python代码用来对事件进行转换.