GET 项目详情

GET 查询。query 参数见接口参考。

接口编码	所需范围	后端接口
`project.projects.detail`	`project:read`	`GET /v1/projects/detail`（comap-project）

请求参数（query）

字段	类型	必填	说明
`id`	integer(int64)	是	—
`syncOrderRelations`	boolean	—	—

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验，标「—」不等于可以不传；租户在主站配置的字段必填不约束本接口。详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "project.projects.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	string	—	ID
`projectNo`	string	—	项目编号
`name`	string	—	名称
`projectTypeId`	string	—	项目类型ID
`projectTypeName`	string	—	项目类型名称
`customerId`	string	—	客户ID
`customerName`	string	—	客户名称
`managerId`	string	—	项目经理ID
`managerName`	string	—	项目经理姓名
`managerAvatar`	string	—	项目经理头像地址
`status`	string	—	项目状态：PENDING=待执行, IN_PROGRESS=进行中, PAUSED=已暂停, COMPLETED=已完工, SETTLED=已结算, TERMINATED=已终止, ARCHIVED=已归档
`priority`	string	—	优先级
`startDate`	string(date-time)	—	开始日期
`endDate`	string(date-time)	—	结束日期
`progress`	integer(int32)	—	进度
`description`	string	—	描述
`address`	string	—	地址
`contactPerson`	string	—	contactPerson
`contactPhone`	string	—	contactPhone
`estimatedRevenue`	number	—	estimatedRevenue
`estimatedBudget`	number	—	estimatedBudget
`salesAmount`	number	—	销售金额
`purchaseCost`	number	—	purchaseCost
`laborCost`	number	—	人工成本
`travelCost`	number	—	travelCost
`outsourceCost`	number	—	outsourceCost
`totalCost`	number	—	总成本
`costStructure`3	CostStructureVO[]	—	成本结构列表
`totalContractCost`	number	—	totalContractCost
`receivedAmount`	number	—	已收金额
`starred`	integer(int32)	—	当前用户是否已关注该项目
`members`13	MemberVO[]	—	成员列表
`milestones`8	MilestoneVO[]	—	里程碑列表
`attachments`12	ProjectAttachmentVO[]	—	附件列表
`salesOrderCount`	integer(int32)	—	销售订单数量
`purchaseOrderCount`	integer(int32)	—	采购订单数量
`hasCost`	boolean	—	是否有费用成本
`createTime`	string(date-time)	—	创建时间
`updateTime`	string(date-time)	—	更新时间
`customFieldValues`10	FieldDataBO[]	—	自定义字段值

错误处理

响应统一信封 { code, message, data }，code == 200 为成功。以下是本接口可能返回的开放平台层错误：

错误码	说明	可重试
92101	访问凭证无效	否
92201	接口未登记或已停用	否
92202	超出凭证授权范围——本接口需 `project:read`	否
92204	绑定员工无此接口的功能权限	否
92203	上游服务调用失败	是
92301	请求过于频繁	是

除此之外，comap-project 自身的业务校验失败会原样透传其业务码与提示（如字段校验、状态不允许、数据不存在），这类码不在开放平台的号段内，以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回项目

错误处理​

错误处理