跳到主要内容

GET 项目分析明细列表

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

接口编码所需范围后端接口
project.project-analytics.project-listproject:readGET /v1/project-analytics/project-list(comap-project)

请求参数(query)

字段类型必填说明
projectIdinteger(int64)——
startDatestring——
endDatestring——
topinteger(int32)——

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—ID
namestring—名称
customerNamestring—客户名称
managerNamestring—项目经理姓名
statusstring—项目状态:PENDING=待执行, IN_PROGRESS=进行中, PAUSED=已暂停, COMPLETED=已完工, SETTLED=已结算, TERMINATED=已终止, ARCHIVED=已归档
startDatestring—开始日期
endDatestring—结束日期
progressinteger(int32)—进度
salesAmountnumber—营收金额(来源见 revenueSource)
revenueSourcestring—营收来源:ACTUAL=实际销售额 / ESTIMATED=预计营收 / NONE=无
purchaseCostnumber—purchaseCost
outsourceCostnumber—outsourceCost
laborCostnumber—人工成本
travelCostnumber—travelCost
totalCostnumber—总成本
costStructure3CostStructureVO[]—成本结构列表
receivedAmountnumber—已收金额

错误处理​

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

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

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

← 返回项目分析