POST高危 手动完结单据
POST。body 为 JSON 对象,必填:documentType(必填,单据类型:项目执行单)、documentId(必填,单据ID)、reason(完结原因,2~500 字)、confirmed(必须为 true,确认剩余数量不再执行)、precheckVersion(先调用完结前置校验返回的版本号)。仅部分执行且无未完成下游单据的执行中单据可完结;数据已变化时返回 40911,需重新预检。完结后剩余数量不再执行。 调用前请与用户确认。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
project.document-completion.complete | project:write | POST /v1/document-completion/complete(comap-project) |
⚠️ 高危接口:删除或状态变更类操作,MCP 调用须先向用户复述并获同意后携 confirm: true。
必填字段
| 字段 | 依据 |
|---|---|
documentType | 参数说明 |
documentId | 参数说明 |
reason | 参数说明 |
confirmed | 参数说明 |
precheckVersion | 参数说明 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
documentType | string | — | — |
documentId | integer(int64) | — | — |
reason | string | — | — |
confirmed | boolean | — | — |
precheckVersion | string | — | — |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.document-completion.complete",
"body": {}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
eventNo | string | — | — |
type | string | — | — |
documentType | string | — | — |
documentId | integer(int64) | — | — |
documentNo | string | — | — |
fromStatus | string | — | — |
toStatus | string | — | — |
reason | string | — | — |
operatorId | integer(int64) | — | — |
operatorName | string | — | — |
operatorDept | string | — | — |
operatedAt | string(date-time) | — | — |
totalQty | number | — | — |
executedQty | number | — | — |
closedQty | number | — | — |
unit | string | — | — |
totalAmount | number | — | — |
executedAmount | number | — | — |
closedAmount | number | — | — |
impacts2 | DocumentCompletionImpact[] | — | — |
referenceNos | string[] | — | — |
relatedEventNo | string | — | — |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 project:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-project 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。