慧企星助 开放平台文档

慧企星助 开放平台面向企业三方系统提供标准 HTTP API,支持员工、绑定关系、项目、目标与目标复盘、任务、通知、便签、标签、贡献点和附件上传能力。 所有接口默认只作用于当前 API Key 所属企业,权限由后端统一控制并在请求时强校验。

显示全部接口

目标与复盘接口

目标、关键结果和周期接口使用 objectives.readobjectives.write;复盘接口使用独立的 objectiveReviews.readobjectiveReviews.write。所有资源均按当前企业和操作员工权限校验。

标识规则:目标、关键结果、周期和复盘资源均使用 id(Guid)作为资源标识;员工对象只返回公开展示字段和当前 API Key 范围内的 virtualId,不会返回手机号、账号、部门内部 Id 或真实员工 Guid,不得用员工 virtualId 替代业务资源 id

目标接口

GET/api/openplatform/objectives

查询目标列表。

参数类型必填说明
pageint页码。
pageSizeint每页条数。
keywordstring目标关键字。
groupint目标分组。
levelint目标层级。
cycleguid目标周期 ID。
departmentIdguid部门 ID。
POST/api/openplatform/objectives

创建目标。人员字段请使用 ownerVirtualIdsparticipantVirtualIds,不得传内部员工 Guid。

GET/api/openplatform/objectives/{id}

查询目标详情。

路径参数:id 为目标 Guid。

PATCH/api/openplatform/objectives/{id}

修改目标字段。

路径参数:id 为目标 Guid。

DELETE/api/openplatform/objectives/{id}

删除目标。

路径参数:id 为目标 Guid。

GET/api/openplatform/objectives/{id}/children

查询子目标,支持 pagepageSize 分页参数。

路径参数:id 为父目标 Guid。

GET/api/openplatform/objectives/{id}/keyResults

查询目标的关键结果。

路径参数:id 为目标 Guid。

POST/api/openplatform/objectives/{id}/keyResults

新增目标关键结果。

路径参数:id 为目标 Guid。

PATCH/api/openplatform/objectives/{objectiveId}/keyResults/{keyResultId}

修改关键结果。

路径参数:objectiveId 为所属目标 Guid,keyResultId 为关键结果 Guid。

DELETE/api/openplatform/objectives/{objectiveId}/keyResults/{keyResultId}

删除关键结果。

路径参数:objectiveId 为所属目标 Guid,keyResultId 为关键结果 Guid。

GET/api/openplatform/objectives/{objectiveId}/keyResults/{keyResultId}/progress

查询关键结果进度记录。

路径参数:objectiveId 为所属目标 Guid,keyResultId 为关键结果 Guid。

GET/api/openplatform/objectives/cycles

查询当前企业的目标周期。

目标复盘接口

复盘字段:复盘独立于绩效评价模块。复盘内容使用 valueAndGain(价值与收获)、deficiencyAndMethod(不足与改进方法)、improvementPlan(改进计划)、participantVirtualIdsattachmentUrls(附件)。
GET/api/openplatform/objectives/{id}/reviews

查询目标复盘列表。

路径参数:id 为目标 Guid。

POST/api/openplatform/objectives/{id}/reviews

提交目标复盘。

路径参数:id 为目标 Guid。

{
  "valueAndGain": "达成了跨部门交付目标",
  "deficiencyAndMethod": "前期排期沟通不足",
  "improvementPlan": "下周期提前完成资源评审",
  "participantVirtualIds": ["emp_xxx"],
  "attachmentUrls": []
}
PATCH/api/openplatform/objectives/{objectiveId}/reviews/{reviewId}

修改目标复盘。objectiveId 为所属目标 Guid,reviewId 为复盘 Guid。