慧企星助开放平台文档

项目接口

项目接口以当前 X-Employee-Virtual-Id 对应员工的项目可见范围和业务权限为准。查询使用 projects.read，创建、修改和删除使用 projects.write。

标识规则：请求体中的责任人和参与人只能传 virtualId，不得传内部员工 Guid。响应中的员工对象只返回公开展示字段和当前 API Key 范围内的 virtualId，不会返回手机号、账号、部门内部 Id 或真实员工 Guid；项目自身仍使用 id（Guid）作为详情、修改、删除等资源路径参数。

GET/api/openplatform/projects

查询当前员工可见的项目列表。

参数	类型	必填	说明
`page`	int	否	页码。
`pageSize`	int	否	每页条数。
`keyword`	string	否	项目名称关键字。
`status`	int	否	项目状态：0 新项目、1 待执行、2 进行中、3 待评定、4 已结束。

POST/api/openplatform/projects

创建项目。

字段	类型	必填	说明
`title`	string	是	项目标题。
`startAt`	string	否	项目开始时间，ISO 8601。
`endAt`	string	否	项目结束时间，ISO 8601。
`ownerVirtualIds`	string[]	是	项目责任人 `virtualId` 列表。
`content`	string	否	项目内容。
`priority`	int	否	优先级。
`totalScore`	decimal	否	项目总贡献点，单位为“点”。
`visibleRange`	int	否	项目可见范围。
`participantVirtualIds`	string[]	否	项目参与人 `virtualId` 列表。
`objectiveId`	guid	否	关联目标 ID。
`requiresCompletionAttachment`	bool	否	完成任务时是否必须上传附件。
`disallowsDecomposition`	bool	否	是否禁止分解任务。
`allowsTaskAfterEnd`	bool	否	项目结束后是否允许新增任务。
`attachmentUrls`	string[]	否	项目附件 URL 列表。

{
  "title": "客户交付项目",
  "content": "交付范围与阶段目标",
  "startAt": "2026-08-18T09:00:00+08:00",
  "endAt": "2026-09-30T18:00:00+08:00",
  "priority": 3,
  "totalScore": 100,
  "visibleRange": 0,
  "ownerVirtualIds": ["emp_xxx"],
  "participantVirtualIds": ["emp_yyy"]
}

GET/api/openplatform/projects/{id}

查询项目详情。

路径参数：id 为项目 Guid。

PATCH/api/openplatform/projects/{id}

修改项目的单个字段，请求体必须且只能包含一个可修改字段。

路径参数：id 为项目 Guid。

字段	类型	必填	说明
`title`	string	否	项目标题。
`content`	string	否	项目内容。
`totalScore`	decimal	否	项目总贡献点。
`priority`	int	否	项目优先级。
`endAt`	string	否	项目结束时间，ISO 8601。
`ownerVirtualIds`	string[]	否	项目负责人 `virtualId` 列表。
`startAt`	string	否	项目开始时间，ISO 8601。

{
  "title": "更新后的项目标题"
}

DELETE/api/openplatform/projects/{id}

删除项目。

路径参数：id 为项目 Guid。

GET/api/openplatform/projects/{id}/groups

查询项目分组。

路径参数：id 为项目 Guid。

GET/api/openplatform/projects/{id}/members

查询项目责任人。

路径参数：id 为项目 Guid。

GET/api/openplatform/projects/activeProgress

查询当前员工进行中项目的进度。