Team 事件

注意:

如果有多个应用同时订阅一个事件，应用之间执行是没有顺序的

如果配置 async: false , 它将首先被串行执行，并且需要返回一个结果

否则，应用将异步并行执行，执行结果将被忽略

trigger_execute

Apps 可以订阅以下Team 事件:

Item
Workspace
Filter
View
Board
WorkspaceTemplate

例如：你可以参考触发器示例

Item

在app中，您可以订阅以下Team 事项事件:

BeforeCreate: gei:proxima:item:beforeCreate
BeforeUpdate: gei:proxima:item:beforeUpdate
BeforeDelete: gei:proxima:item:beforeDelete
BeforeRevert: gei:proxima:item:beforeRevert
Created: gei:proxima:item:created
Updated: gei:proxima:item:updated
Deleted: gei:proxima:item:deleted

每个事件都有不同的事件参数。

事项创建之前

在创建事项之前发送一个名为gei:proxima:item:beforeCreate的事件

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:item:beforeCreate`
item	Item	事件相关的事项
actor	User	触发事件的用户
isClone	Boolean	是否从另一个事项克隆。 Yes or No

响应 (可选)

如果你需要向调用者抛出一个错误或者返回修改后的事项数据，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息
item	Item	否	返回的事项数据可以被保存到事项信息中

示例

{
	"event": "gei:proxima:item:created",
	"isClone": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
	}
}

事项更新之前

在事项更新之前会发送一个 gei:proxima:item:beforeUpdate 事件

Payload

参数名	类型	说明
event	String	事项名称 `gei:proxima:item:beforeUpdate`
item	Item	与事件相关的事项（修改后的）
actor	User	触发事件的用户
originalItem	Item	与事件相关的事项（修改之前的）

响应 (可选)

如果你需要向调用者抛出一个错误或者返回修改后的事项数据，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息
item	Item	否	返回的事项数据可以被保存到事项信息中

示例

{
	"event": "gei:proxima:item:beforeUpdate",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	},
    "originalItem": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

事项删除之前

当一个事项被删除之前，会发送名为gei:proxima:item:beforeDelete的事件

参数

参数名	类型	说明
event	String	事项名 `gei:proxima:item:beforeDelete`
item	Item	事件相关的事项
actor	User	触发事件的用户
useMasterKey	Boolean	该事项是否被内部删除，true或false。内部删除将跳过一些权限检查

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	说明
code	number	错误码
message	string	错误信息

示例

{
	"event": "gei:proxima:item:beforeDelete",
	"useMasterKey": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

事项还原之前

当一个事项被删除之前，会发送名为gei:proxima:item:beforeRevert的事件

参数

参数名	类型	说明
event	String	事项名 `gei:proxima:item:beforeRevert`
item	Item	事件相关的事项
actor	User	触发事件的用户

响应 (可选)

如果你需要向调用者抛出一个错误或者返回修改后的事项数据，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息
item	Item	否	返回的事项数据可以被保存到事项信息中

示例

{
	"event": "gei:proxima:item:beforeRevert",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

事项创建之后

当一个事项被创建时，一个名为gei:proxima:item:created的事件被发送

参数

参数名	类型	说明
event	String	事项名 `gei:proxima:item:created`
item	Item	事件相关的事项
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:item:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

事项更新之后

当一个事项被更新时，一个名为gei:proxima:item:updated的事件被发送

参数

参数名	类型	说明
event	String	事项名 `gei:proxima:item:updated`
item	Item	事件相关的事项
originalItem	Item	与事件相关的事项（修改之前的）
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:item:updated",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

事项删除之后

当一个事项被删除之后，会发送名为gei:proxima:item:deleted的事件

参数

参数名	类型	说明
event	String	事项名 `gei:proxima:item:deleted`
item	Item	事件相关的事项
actor	User	触发事件的用户
useMasterKey	Boolean	该事项是否被内部删除，true或false。内部删除将跳过一些权限检查

示例

{
	"event": "gei:proxima:item:deleted",
	"useMasterKey": false,
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"item": {
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"itemGroup": {
			"__type": "Pointer",
			"className": "ItemGroup",
			"objectId": "nFYKjPK8bP"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
		"objectId": "BpPZ2Tk5wS"
	}
}

IQL 事件

在Apps中，您可以订阅以下Team IQL事件:

IQL 执行前事件: gei:proxima:iql:beforeExecute

IQL 执行前事件

在进行IQL查询之前，会发送一个名为gei:proxima:iql:beforeExecute的事件，你可以在这里修改IQL语句。IQL查询包括多种场景，如：列表、看板、日历、报表等。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:iql:beforeExecute`
iql	String	事件相关的IQL
actor	User	触发事件的用户
itemRoles	String[]	用户所拥有的ItemRole，可以用来查看哪些事项

响应 (可选)

当你需要重写IQL，可以配置async: false同步执行插件，并返回以下数据用于重写IQL：

参数名	类型	说明
iql	String	重写后的IQL

参数示例

{
    "event": "gei:proxima:iql:beforeExecute",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
        "updatedAt": "2021-12-22T12: 44: 13.613Z",
        "username": "osc-admin",
        "email": "osc-admin@oschina.cn",
        "enabled": true,
        "deleted": false,
        "nickname": "管理员",
        "language": "zh-CN",
        "role": {
            "createdAt": "2021-11-08T09: 12: 32.585Z",
            "updatedAt": "2021-12-26T04: 00: 09.098Z",
            "name": "superAdmin",
            "isRoot": true,
            "tag": "超级管理员",
            "isSystem": true,
            "objectId": "swvphORBnd"
        },
        "objectId": "jasPZZVVEQ"
    },
    "iql": "空间='需求空间' and 状态 in ['已完成','已拒绝']",
	"itemRoles": [
		"CYCdnCHjEp",
		"O3v02C7wxJ",
	]
}

响应示例

{
	"iql": "空间='需求空间' and 状态 in ['已完成','已拒绝'] and 优先级 in ['高','中']"
}

Workspace

在Apps中，您可以订阅以下Team 空间事件:

创建: gei:proxima:workspace:created
修改: gei:proxima:workspace:updated
删除: gei:proxima:workspace:deleted

空间创建之后

当空间被创建时，会发送一个名为gei:proxima:workspace:created的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspace:created`
workspace	Workspace	事件相关的空间
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:workspace:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

空间更新之后

当空间更新时，会发送一个名为gei:proxima:workspace:updated的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspace:updated`
workspace	Workspace	与事件相关的空间（修改后的）
originalWorkspace	Workspace	与事件相关的空间（修改前的）
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:workspace:updated",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	},
	"originalWorkspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

空间删除之后

当空间更新时，会发送一个名为gei:proxima:workspace:deleted的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspace:deleted`
workspace	Workspace	与事件相关的空间
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:workspace:deleted",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"workspace": {
		"createdAt": "2022-11-09T06:25:24.450Z",
		"updatedAt": "2022-11-09T06:25:27.540Z",
		"name": "需求空间test1",
		"key": "XJKJ_TEST_1",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"lead": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"icon": "/icons/TeamIcon.svg",
		"updatedBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "HV4g5fbg7C"
	}
}

Filter

在app中，你可以订阅以下Team 筛选器事件:

删除之前: gei:proxima:filter:beforeDelete

筛选器删除之前

一个名为gei:proxima:filter:beforeDelete的事件在删除filter之前发送

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:filter:beforeDelete`
filter	Filter	与事件相关筛选器
actor	User	事件触发用户

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	说明
code	number	错误码
message	string	错误信息

实例

参数

{
	"event": "gei:proxima:filter:beforeDelete",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"filter": {
		"createdAt": "2022-11-09T06:20:48.783Z",
		"updatedAt": "2022-11-09T06:20:48.783Z",
		"expression": "'所属空间' in [\"需求空间\"]",
		"name": "测试筛选器",
		"global": true,
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"objectId": "uuoUoRWmMj"
	}
}

View

您可以订阅以下Team 视图事件:

创建之前: gei:proxima:view:beforeCreate
更新之前: gei:proxima:view:beforeUpdate
删除之后: gei:proxima:view:deleted

视图创建之前

当视图创建之前，会发送一个名为gei:proxima:view:beforeCreate的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:view:beforeCreate`
view	View	与事件相关的视图
actor	User	触发事件的用户

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息

示例

{
    "event": "gei:proxima:view:beforeCreate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

视图更新之前

当视图更新之前，会发送一个名为gei:proxima:view:beforeUpdate的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:view:beforeUpdate`
view	View	与事件相关的视图
originalView	View	与事件相关的视图（更新之前）
actor	User	触发事件的用户

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息

示例

{
    "event": "gei:proxima:view:beforeUpdate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

视图删除之后

当视图删除之后，会发送一个名为gei:proxima:view:deleted的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:view:deleted`
view	View	与事件相关的视图
actor	User	触发事件的用户

示例

{
    "event": "gei:proxima:view:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "view": {
        "permission": {
            "category": "private",
            "shareList": []
        },
        "component": "Default",
        "name": "view-demo",
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        }
    },
}

Board

您可以订阅以下Team 面板事件:

创建之前: gei:proxima:board:beforeCreate
更新之前: gei:proxima:board:beforeUpdate
删除之后: gei:proxima:board:deleted

面板创建之前

当面板创建之前，会发送一个名为gei:proxima:board:beforeCreate的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:board:beforeCreate`
board	Board	与事件相关的面板
actor	User	触发事件的用户

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息

示例

{
    "event": "gei:proxima:board:beforeCreate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

面板更新之前

当面板更新之前，会发送一个名为gei:proxima:board:beforeUpdate的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:board:beforeUpdate`
board	Board	与事件相关的面板
originalBoard	Board	与事件相关的面板（更新之前）
actor	User	触发事件的用户

响应 (可选)

如果你需要向调用者抛出一个错误，你可以配置async: false并返回以下数据:

警告

如果应用不是production，而是staging或者development，则async: false不生效，即以下返回不生效。

参数名	类型	是否必须	说明
code	number	否	错误码，有错误时才需要返回
message	string	否	错误信息

示例

{
    "event": "gei:proxima:board:beforeUpdate",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

面板删除之后

当面板删除之后，会发送一个名为gei:proxima:board:deleted的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:board:deleted`
board	Board	与事件相关的面板
actor	User	触发事件的用户

示例

{
    "event": "gei:proxima:board:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "board": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "All items",
        "key": "8ecf5af6-be57-49c6-8335-9807bc9d528f",
        "workspace": {
            "__type": "Pointer",
            "className": "Workspace",
            "objectId": "UZCwfVUg7G"
        },
        "createdBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "updatedBy": {
            "__type": "Pointer",
            "className": "_User",
            "objectId": "jasPZZVVEQ"
        },
        "filterSource": "inWorkspace",
        "icon": "/icons/Panel1",
        "objectId": "adHo7mvrCB"
    },
}

WorkspaceTemplate

您可以订阅以下Team 空间模板事件:

创建之后: gei:proxima:workspaceTemplate:created
更新之后: gei:proxima:workspaceTemplate:updated
删除之后: gei:proxima:workspaceTemplate:deleted

空间模板创建之后

空间模板创建之后，会发送一个名为gei:proxima:workspaceTemplate:created的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspaceTemplate:created`
workspaceTemplate	WorkspaceTemplate	与事件相关的空间模板
actor	User	触发事件的用户

示例

{
    "event": "gei:proxima:workspaceTemplate:created",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

空间模板更新之后

空间模板更新之后，会发送一个名为gei:proxima:workspaceTemplate:updated的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspaceTemplate:updated`
workspaceTemplate	WorkspaceTemplate	与事件相关的空间模板
originalWorkspaceTemplate	WorkspaceTemplate	与事件相关的空间模板 (更新之前的对象)
actor	User	触发事件的用户

示例

{
    "event": "gei:proxima:workspaceTemplate:updated",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

空间模板删除之后

空间模板删除之后，会发送一个名为gei:proxima:workspaceTemplate:deleted的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:workspaceTemplate:deleted`
workspaceTemplate	WorkspaceTemplate	与事件相关的空间模板
actor	User	触发事件的用户

示例

{
    "event": "gei:proxima:workspaceTemplate:deleted",
    "actor": {
        "createdAt": "2021-10-20T14: 08: 16.652Z",
    		"updatedAt": "2021-12-22T12: 44: 13.613Z",
    		"username": "osc-admin",
    		"email": "osc-admin@oschina.cn",
    		"enabled": true,
    		"deleted": false,
    		"nickname": "管理员",
    		"language": "zh-CN",
    		"role": {
    			"createdAt": "2021-11-08T09: 12: 32.585Z",
    			"updatedAt": "2021-12-26T04: 00: 09.098Z",
    			"name": "superAdmin",
    			"isRoot": true,
    			"tag": "超级管理员",
    			"isSystem": true,
    			"objectId": "swvphORBnd"
    		},
    		"objectId": "jasPZZVVEQ"
    },
    "workspaceTemplate": {
        "createdAt": "2023-12-21T09:06:46.389Z",
        "updatedAt": "2024-01-03T02:55:28.571Z",
        "name": "Workspace Template",
        "workspace": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "itemTypeScreenScheme": {
          "objectId": "UZCwfVUg7G"
        },
        "workflowScheme": {
          "objectId": "UZCwfVUg7G"
        },
    },
}

BaseLineItems

您可以订阅以下Team基线事项版本事件:

创建之后: gei:proxima:baseLineItems:created

创建基线事项版本之后

事项版本创建之后，会发送一个名为gei:proxima:baseLineItems:created的事件。

参数

参数名	类型	说明
event	String	事件名 `gei:proxima:baseLineItems:created`
baseLineItems	BaseLineItem[]	与事件相关的事项版本数据
actor	User	触发事件的用户

示例

{
	"event": "gei:proxima:baseLineItems:created",
	"actor": {
		"createdAt": "2021-10-20T14: 08: 16.652Z",
		"updatedAt": "2021-12-22T12: 44: 13.613Z",
		"username": "osc-admin",
		"email": "osc-admin@oschina.cn",
		"enabled": true,
		"deleted": false,
		"nickname": "管理员",
		"language": "zh-CN",
		"role": {
			"createdAt": "2021-11-08T09: 12: 32.585Z",
			"updatedAt": "2021-12-26T04: 00: 09.098Z",
			"name": "superAdmin",
			"isRoot": true,
			"tag": "超级管理员",
			"isSystem": true,
			"objectId": "swvphORBnd"
		},
		"objectId": "jasPZZVVEQ"
	},
	"baseLineItems": [{
		"objectId": "0PDMY4mPiN",
		"itemId": "pEEC1GclyB",
		"ancestors": [],
		"values": {
			"editor_intent_desc": [null],
			"editor_intent_target": [null],
			"priority": "90c529a1-8717-4a6b-b0e9-89de31a5b73b",
			"__screen_type": "create"
		},
		"name": "34",
		"workspace": {
			"__type": "Pointer",
			"className": "Workspace",
			"objectId": "RBSqxbkjEr"
		},
		"itemType": {
			"__type": "Pointer",
			"className": "ItemType",
			"objectId": "noJue4D20k"
		},
		"createdAt": "2022-11-08T10: 41: 16.893Z",
		"createdBy": {
			"__type": "Pointer",
			"className": "_User",
			"objectId": "jasPZZVVEQ"
		},
		"key": "TEST_01-45",
		"status": {
			"__type": "Pointer",
			"className": "Status",
			"objectId": "1cGVyj2879"
		},
		"updatedAt": "2022-11-08T10: 41: 16.893Z",
	}]
}

Item​

事项创建之前​

参数​

响应 (可选)​

示例​

事项更新之前​

Payload​

响应 (可选)​

示例​

事项删除之前​

参数​

响应 (可选)​

示例​

事项还原之前​

参数​

响应 (可选)​

示例​

事项创建之后​

参数​

示例​

事项更新之后​

参数​

示例​

事项删除之后​

参数​

示例​

IQL 事件​

IQL 执行前事件​

参数​

响应 (可选)​

参数示例​

响应示例​

Workspace​

空间创建之后​

参数​

示例​

空间更新之后​

参数​

示例​

空间删除之后​

参数​

示例​

Filter​

筛选器删除之前​

参数​

响应 (可选)​

实例​

View​

视图创建之前​

参数​

响应 (可选)​

示例​

视图更新之前​

参数​

响应 (可选)​

示例​

视图删除之后​

参数​

示例​

Board​

面板创建之前​

参数​

响应 (可选)​

示例​

面板更新之前​

参数​

响应 (可选)​

示例​

面板删除之后​

参数​

示例​

WorkspaceTemplate​

空间模板创建之后​

参数​

示例​

空间模板更新之后​

参数​

示例​

空间模板删除之后​

参数​

Item

事项创建之前

参数

响应 (可选)

示例

事项更新之前

Payload

响应 (可选)

示例

事项删除之前

参数

响应 (可选)

示例

事项还原之前

参数

响应 (可选)

示例

事项创建之后

参数

示例

事项更新之后

参数

示例

事项删除之后

参数

示例

IQL 事件

IQL 执行前事件

参数

响应 (可选)

参数示例

响应示例

Workspace

空间创建之后

参数

示例

空间更新之后

参数

示例

空间删除之后

参数

示例

Filter

筛选器删除之前

参数

响应 (可选)

实例

View

视图创建之前

参数

响应 (可选)

示例

视图更新之前

参数

响应 (可选)

示例

视图删除之后

参数

示例

Board

面板创建之前

参数

响应 (可选)

示例

面板更新之前

参数

响应 (可选)

示例

面板删除之后

参数

示例

WorkspaceTemplate

空间模板创建之后

参数

示例

空间模板更新之后

参数

示例

空间模板删除之后

参数