查询线上模板ID

更新时间：2022-01-23 23:18:08

文档变更

2022年时，查询e签宝官网模板信息变为查询线上模板ID，仅中文名称变更，其功能保持不变。

接口描述

用于查询企业机构主体下通过线上制作模板方法在e签宝SaaS官网（智能合同）中制作的所有模板信息。

注：

（1）此接口只可以查询 AppID 所归属企业机构主体下的模板。

接口地址&请求方式

接口地址：/v3/flow-templates/basic-info?pageNum=XX&pageSize=XX

请求方式：GET

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

参数名称

类型

必选

参数类型

参数说明

（左右拖动查看完整描述）

pageNum

int

否

query

查询页码，不传默认第1页，起始值：1

pageSize

int

否

query

分页大小，不传默认10条，最大值：100条

响应参数

展开全部参数参数名称				类型	必选	参数说明（左右拖动查看完整描述）
code				int32	是	业务码，0表示成功
message				string	是	业务信息
data				object	否	业务数据
	flowTemplateBasicInfos			array	否	流程模板基础信息
		flowTemplateId		string	否	流程模板编号
flowTemplateName		string	否	流程模板名称
docTemplates		array	否	文件模板基础信息
		docTemplateId	string	否	文件模板ID 注意：该参数值为接口中所需的模板ID
		docTemplateName	string	否	文件模板名称
total			int32	否	数据总条数

响应参数对应官网位置截图

请求示例

GET https://openapi.esign.cn/v3/flow-templates/basic-info?pageNum=1&pageSize=5

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "flowTemplateBasicInfos": [
            {
                "flowTemplateId": "7f3d414144de4633a1e0a3644fc7bab3",
                "flowTemplateName": "流程模板名称3",
                "docTemplates": [
                    {
                        "docTemplateId": "1bf05d2600034aa083eef31b6724e001",
                        "docTemplateName": "test001.pdf"
                    },
                    {
                        "docTemplateId": "30e2dce56e414890b14382ae09812002",
                        "docTemplateName": "test002.pdf"
                    },
                    {
                        "docTemplateId": "f94f4d87938e4aaa898b2b2820fa4002",
                        "docTemplateName": "test003.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "6f64eb48583a4febb9b99147b47a8ab2",
                "flowTemplateName": "流程模板名称2",
                "docTemplates": [
                    {
                        "docTemplateId": "104f9adcce30429195ba526e45cd65001",
                        "docTemplateName": "PDFTemplate001.pdf"
                    }
                ]
            },
            {
                "flowTemplateId": "b188f6064bf74657a580424c97ed2ab1",
                "flowTemplateName": "流程模板名称1",
                "docTemplates": [
                    {
                        "docTemplateId": "61b839c616cb43aaa2a92c99c50ef001",
                        "docTemplateName": "测试签署文件001.pdf"
                    },
                    {
                        "docTemplateId": "e92382ea2b3f4880833c2904571f8002",
                        "docTemplateName": "测试签署文件002.pdf"
                    }
                ]
            }
        ],
        "total": 3
    }
}