POST 新建发放单
POST 写操作。body 为 JSON 对象。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
project.drawing.distributions.create | project:write | POST /v1/drawing/distributions/create(comap-project) |
必填字段
| 字段 | 依据 |
|---|---|
drawingId | 接口规格 |
versionId | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
drawingId | integer(int64) | 是 | 图纸ID |
versionId | integer(int64) | 是 | 版本ID |
receiverType | string | — | 接收方类型 INTERNAL_DEPT/INTERNAL_USER/SUPPLIER/CUSTOMER |
receiverIds | integer(int64)[] | — | 接收方ID列表 |
receiverNames | string[] | — | 接收方名称列表(与receiverIds对应) |
receiverContact | string | — | 接收方联系方式 |
purposeCode | string | — | 发放原因/用途 |
method | string | — | 发放方式 SYSTEM/EMAIL/EXPORT/HAND_OVER/WITH_PO |
needConfirm | integer(int32) | — | 需要接收方确认 |
needReceipt | integer(int32) | — | 需要回执 |
receiptRequirement | string | — | 回执要求说明 |
receiptDeadline | string | — | 回执截止日期,为空则不做逾期提醒 |
restrictDownload | integer(int32) | — | 是否限制下载 |
addWatermark | integer(int32) | — | 添加水印 |
watermarkText | string | — | 水印文字 |
description | string | — | 发放说明 |
fileIds | integer(int64)[] | — | 要发放的文件ID列表 |
requireAllConfirm | integer(int32) | — | 多人接收时是否要求全部接收人确认才算完成 |
ccIds | integer(int64)[] | — | 抄送对象ID列表(内部人员) |
ccNames | string[] | — | 抄送对象姓名列表,与ccIds对应 |
distributeNow | boolean | — | 保存后立即发放(同一事务;编辑 DTO 继承本字段) |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.drawing.distributions.create",
"body": {
"drawingId": "1961000000000000001",
"versionId": "1961000000000000001"
}
}'
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 project:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-project 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回图纸发放