贡献申请接口
贡献申请接口用于三方系统提交贡献申请、查询申请列表、查询行为标准、获取申请详情等。所有接口都必须通过 X-Employee-Virtual-Id 指定当前操作人。
apiKeyId 和 apiKeyName 字段,用于标识该申请来源于哪个三方应用。
获取贡献申请初始化参数,包括是否允许匿名申请、自定义申请的分值上下限等。
{
"statusCode": 100,
"msg": "获取成功",
"data": {
"allowAnonymous": true,
"minScore": 1,
"maxScore": 100
}
}获取行为标准列表(分页),支持按关键字搜索。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
page | int | 否 | 页码,默认 1。 |
pageSize | int | 否 | 每页条数,默认 20。 |
keyword | string | 否 | 行为标准名称关键字。 |
{
"statusCode": 100,
"msg": "获取成功",
"data": {
"total": 10,
"items": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "优秀代码贡献",
"description": "对项目有显著贡献的代码提交",
"score": 10,
"category": "技术贡献"
}
]
}
}列表响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
data.total | long | 符合关键字筛选条件的行为标准总数。 |
data.page | int | 当前页码,从 1 开始。 |
data.pageSize | int | 当前页返回条数上限,范围为 1 到 100。 |
data.items | StandardItem[] | 当前页行为标准数据。 |
id | guid | 行为标准标识,用于提交申请时的 standardItemId。 |
name | string | 行为标准名称。 |
description | string | 行为标准说明。 |
score | decimal | 标准贡献点,单位为“点”。 |
category | string | 行为标准所属分类。 |
提交贡献申请,支持自定义申请和行为标准申请两种类型。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
applicationType | string | 是 | 申请类型(字符串枚举):standard 按行为标准申请、custom 自定义分值申请。 |
targetEmployeeVirtualIds | string[] | 是 | 目标员工 virtualId 列表。 |
amount | decimal | 否 | 申请贡献点(自定义申请时必填)。 |
reason | string | 否 | 申请理由。 |
attachmentUrls | string[] | 否 | 附件 URL 列表。 |
isAnonymous | bool | 否 | 是否匿名申请。 |
standardItems | object[] | 否 | 行为标准申请项列表(行为标准申请时必填)。 |
standardItems 项结构
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
standardItemId | string | 是 | 行为标准项 ID (UUID)。 |
amount | decimal | 是 | 申请贡献点。 |
reason | string | 否 | 申请理由。 |
attachmentUrls | string[] | 否 | 附件 URL 列表。 |
{
"statusCode": 100,
"msg": "申请已提交",
"data": {
"id": "b34b6f3f-f84e-45ce-8c44-bb85d55a9ef5",
"message": "申请已提交"
}
}分页查询贡献申请列表,一个接口覆盖待操作、进行中、历史三档(参考任务列表 view 分组模式)。view=pendingActions 待我处理(待我审批/确认/处理驳回申诉/处理投诉)、view=inProgress 进行中(与我相关且未完结)均与当前操作人身份绑定,仅支持 keyword 筛选;view=history 历史归档(已归档申请)按操作人的贡献可见权限判定范围,额外支持来源人、被申请人、申请类型与申请时间筛选。已执行的贡献流水明细请用贡献点接口的 scoreChanges(与历史申请同一查询口径)。
查询参数:
view:列表分组,必填:pendingActions待我处理、inProgress进行中、history历史归档keyword:标题/行为关键字模糊筛选,三档通用,可选applicationType:申请类型筛选(仅view=history支持),可选:standard行为标准、custom自定义分值applicantVirtualId:来源人(申请人)virtualId 筛选(仅view=history支持),可选targetEmployeeVirtualId:被申请(受益)员工 virtualId 筛选(仅view=history支持),可选startAt/endAt:申请时间范围起止(含),ISO 8601 格式(仅view=history支持),可选page:页码,从 1 开始,默认 1pageSize:每页条数,1-100,默认 20
响应行字段说明:creator 为来源人(申请人)成员对象(virtualId/name/phone,手机号脱敏);匿名申请(isAnonymous 为 true)时除申请人本人外 creator 返回 null。applicationType 对外口径为 standard/custom/system,status/statusName 为申请状态数值与中文名(待审批/待确认/已执行/归档/被驳回/申诉中)。
{
"statusCode": 100,
"msg": "获取成功",
"data": {
"total": 2,
"page": 1,
"pageSize": 20,
"items": [
{
"id": "4a5b6c7d-8e9f-4a1b-8c9d-0e1f2a3b4c5d",
"status": 0,
"statusName": "待审批",
"applicationType": "standard",
"score": 10,
"title": "季度优秀协作",
"reason": "跨部门项目支撑",
"isAnonymous": false,
"employeeVirtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
"employeeName": "张三",
"creator": {
"virtualId": "emp_R8sP3nWq6tMv2xK9yB4cD7eF0gH1jLkA",
"name": "李四",
"phone": "138****5678"
},
"appliedAt": "2026-06-01T10:00:00",
"confirmedAt": null,
"apiKeyName": null
},
{
"id": "9d0e1f2a-3b4c-4d5e-8f9a-1b2c3d4e5f6a",
"status": 3,
"statusName": "归档",
"applicationType": "custom",
"score": -2,
"title": "匿名调整",
"reason": "匿名贡献",
"isAnonymous": true,
"employeeVirtualId": "emp_T7dQ2mYk8rLp4cN1sVx3bH9wAe6fJuKz",
"employeeName": "张三",
"creator": null,
"appliedAt": "2026-06-02T10:00:00",
"confirmedAt": "2026-06-03T10:00:00",
"apiKeyName": null
}
]
}
}获取贡献申请详情。
{
"statusCode": 100,
"msg": "获取成功",
"data": {
"id": "b34b6f3f-f84e-45ce-8c44-bb85d55a9ef5",
"status": 1,
"applicationType": 1,
"apiKeyId": "c56d7f8g-h90i-1234-jklm-no5678901234",
"apiKeyName": "我的三方应用",
"score": 10,
"reason": "优秀代码贡献",
"attachmentUrls": [],
"isAnonymous": false,
"createdAt": "2026-06-18T10:00:00+08:00"
}
}详情响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | guid | 贡献申请标识。 |
status | int | 贡献申请当前状态码。 |
applicationType | int | 申请类型:0 行为标准申请,1 自定义申请。 |
apiKeyId | guid | 创建申请的 API Key 标识;非开放平台创建的申请为 Guid.Empty。 |
apiKeyName | string | 创建申请的三方应用名称;非开放平台创建的申请为空字符串。 |
score | decimal | 申请贡献点,单位为“点”。 |
reason | string | 申请理由。 |
attachmentUrls | string[] | 申请附件的公开访问 URL 列表。 |
isAnonymous | bool | 是否匿名申请。 |
createdAt | string | 申请创建时间,ISO 8601 带时区字符串。 |