电子合同API开发文档 v5

获取模板详情

接口地址:https://api.1dq.com/v5/Templates/getDetailsById.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
未提供

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
id - STRING -
模板id

请求示范

 POST https://api.1dq.com/v5/Templates/getDetailsById.json
 {
    "id": ""
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

----name

- STRING 模板名称

----status

- INT 模板状态,1正常

----file_id

- STRING 文件id

----version

- STRING 模板版本号

----field

- ARRAY 模板可编辑的字段

----content

- ARRAY 模板内容v2,v1版本返回

----update_time

- STRING 最后更新时间

----create_time

- STRING 创建时间

----down_link

- STRING 下载链接,15分钟有效

成功示范

{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "28542021152656998111",
        "name": "测试文件模板",
        "status": 1,
        "file_id": "template-e0dbe964c15beaf50b25eb601582b2bf-74e37546-0001",
        "version": "v3",
        "field": [],
        "content": "",
        "update_time": "2021-10-03 22:46:09",
        "create_time": "2021-10-03 22:46:09",
        "down_link": "https:\/\/safe-storage.1dq.com\/template\/e0dbe964c15beaf50b25eb601582b2bf\/74e37546.docx?OSSAccessKeyId=LTAI4Fdnk3tG4K2FVQaBkzpW&Expires=1636094793&Signature=pVJB9gMAK2UCJo2x2dOzko%2F5N20%3D"
    }
}

失败示范

{
    "code": 404,
    "msg": "您无法访问该资源",
    "data": [],
    "requestId": "4cb75754-3dfc-11ec-97d9-0242ac110004"
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码