企业模板管理

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 模板操作相关回调

支持的操作

1. 删除模板 (OperateType=DELETE)

此操作会将模板从企业自有模板中彻底删除，若要保留模板而不删除，可将模板停用。

2. 启用模板 (OperateType=ENABLE)

此操作是将已停用的模板启用，操作幂等，若模板已启用，接口不报错。

3. 停用模板 (OperateType=DISABLE)

此操作是将已启用的模板停用，操作幂等，若模板已停用，接口不报错，停用后，无法通过此模板发起合同，已发起的合同不受影响。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：OperateTemplate。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TemplateId	是	String	模板ID，为32位字符串。 示例值：yDSLZUUckpot5i01UydF1AEvOMQiKaBG
OperateType	是	String	操作类型，可取值如下: DELETE: 删除 ENABLE: 启用 DISABLE: 停用 示例值：DELETE
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除模板

删除企业下的模板yDwivUUckpo2g6ugUu4sxH2i15SY0OZY

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateTemplate
<公共请求参数>

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "OperateType": "DELETE",
    "TemplateId": "yDwivUUckpo2g6ugUu4sxH2i15SY0OZY"
}

输出示例

{
    "Response": {
        "RequestId": "7da39d89-2b6c-4fd9-9f32-735137d5a6e9"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Db	数据库异常。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter	参数错误。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.Forbid	禁止此项操作。
ResourceNotFound.Template	模板不存在，请检查模板参数，模板配置，并稍后重试。