接口描述
查询企业用户下的全部流程模板列表，可根据状态筛选
接口地址&请求方法
接口地址：https://{host}/v3/sign-templates
请求方法：GET
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
orgId | string | 是 | query | 机构账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询 |
pageSize | int | 否 | query | 每页显示的数量，最大值：20（默认值 20） |
pageNum | int | 否 | query | 查询页码（默认值 1） |
status | int | 否 | query | 流程模板可用状态，默认查询全部 0 - 停用状态 1 - 启用状态 |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖message 匹配，因为message 可能会调整。 | ||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||
total | int | 是 | 查询结果中的流程模板总数量 | ||
signTemplates（点击“+”展开详情） | array | 是 | 流程模板列表 | ||
signTemplateName | string | 否 | 流程模板名称 | ||
signTemplateId | string | 否 | 流程模板ID | ||
createTime | string | 否 | 创建时间（时间戳） | ||
updateTime | string | 否 | 更新时间（时间戳） | ||
status | int | 否 | 流程模板可用状态 0 - 停用状态 1 - 启用状态 | ||
signTemplateSource | int | 否 | 流程模板来源 扩展字段，固定返回：1 | ||
请求示例
//正式线上环境--GET请求
GET 'https://openapi.esign.cn/v3/sign-templates?orgId=84****5fc91662f'
//沙箱模拟环境--GET请求
GET 'https://smlopenapi.esign.cn/v3/sign-templates?orgId=842ec8****5fc91662f'响应示例
{
"code": 0,
"message": "成功",
"data": {
"total": 87,
"signTemplates": [
{
"signTemplateName": "1111",
"signTemplateId": "cdbcca891111139de7de249194",
"createTime": 1722330948000,
"updateTime": 1722330948000,
"status": 0,
"signTemplateSource": 1
},
{
"signTemplateName": "0718",
"signTemplateId": "73a5f1f1011111111acd54d006e",
"createTime": 1721302250000,
"updateTime": 1721723955000,
"status": 1,
"signTemplateSource": 1
},
{
"signTemplateName": "11111",
"signTemplateId": "e6f87746db11111a9bf773c5506",
"createTime": 1720574701000,
"updateTime": 1720574723000,
"status": 0,
"signTemplateSource": 1
}
]
}
}
我要纠错