流程文档添加
接口地址 /v1/signflows/{flowId}/documents
请求方式 POST
接口描述 向流程中添加待签署文档，文档必须先用文档管理接口创建，创建方式请参见文件管理接口文档。已经开启的流程不能再添加签署文档.
请求参数
| 参数名称 | 说明 | 参数类型 | 必填 | 类型 | |
|---|---|---|---|---|---|
| flowId | 流程id | path | true | string | |
| docs | 文档列表数据 | body | true | array | |
| fileId | 文档id | body | true | string | |
| encryption | 是否加密，0-不加密，1-加，默认0 | body | false | int32 | |
| fileName | 文档名称,默认文件名称 | body | false | string | |
| filePassword | 文档密码, 如果encryption值为1, 文档密码不能为空，默认没有密码 | body | false | string |
请求示例
POST https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/documents
{
"docs":[
{
"encryption":0,
"fileId":"01e50a9cedb74493a2d320b4f4732a29",
"fileName":"第一份合同.pdf",
"filePassword":""
}
]
}
响应参数
无
响应示例
{
"code":0,
"message":"成功",
"data":null
}
错误码
| 错误码 | 错误信息 | 错误原因 |
|---|---|---|
| 1437502 | 流程非草稿状态，不允许添加文档 | 只有草稿状态的流程才能新增流程签署文档 |
| 1437503 | 文档ID重复 | 添加的文档列表中存在相同的文档id, 不能重复添加 |
| 1437504 | 流程已添加文档ID:XXX | 流程中已经存在相同的文档id |
| 1437508 | 文档类型与流程签署类型不匹配 | 文档的类型是原文但流程指定的签署类型是摘要签 或者 文档的类型是摘要但流程指定的签署类型是原文签 |