跳到主要内容

合同备注管理

1. 接口描述​

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

此接口（OperateFlowRemarks）用于对企业合同备注进行管理操作，支持新增，创建和删除。

用户可以通过接口对合同备注进行管理，支持对创建后的备注进行搜索关联的合同流程。

image

注：

对合同备注进行操作前，操作人需要获取对应权限：合同操作 - 设置合同类型及备注。

image

没有对应权限的用户，并且不属于超管、法人，该合同的参与方（包含签署方与发起方），将无法对对应合同的备注进行编辑，如果备注内容包含敏感信息，将会对其进行打码显示。

image

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：OperateFlowRemarks。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo

执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

OperateType是String

操作类型，可取值如下:

  • DELETE: 删除
  • ENABLE: 启用
  • DISABLE: 停用
  • COPY: 复制新建

示例值：UPDATE
FlowId否String

对应的合同流程id

目标合同为合同组时此参数不填


示例值：yDt**wzZ
Agent否Agent

代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

FlowGroupId否String

对应合同组id

目标合同为单份合同时此参数不填


示例值：yD3**CkC
FlowItem否FlowRemarkItem

合同备注信息。

入参限制：当OperateType为UPDATE和DELETE时，通过该结构体进行对应备注操作，合同备注数量范围为 1 - 5个。

FlowItems.N否Array of String

合同备注列表。

入参限制：当OperateType为CREATE时，通过该参数进行全量的合同备注创建。


示例值：["合同组标签1"]

3. 输出参数​

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

4. 示例​

示例1 更新合同备注​

输入示例​

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

{
    "Operator": {
        "UserId": "yDCp0UUckpay74u2Uxgcd4v1197NeSXv"
    },
    "FlowId": "yDt**************************wzZ",
    "OperateType": "UPDATE",
    "FlowItem": {
        "RemarkId": 1,
        "RemarkValue": "新的标签"
    },
    "FlowGroupId": "yD3**************************CkC"
}

输出示例​

{
    "Response": {
        "RequestId": "5de73ff1-d7ab-4292-9c0c-fc412ae28f3f"
    }
}

示例2 创建合同备注​

输入示例​

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

{
    "Operator": {
        "UserId": "yDC**************************SXv"
    },
    "OperateType": "CREATE",
    "FlowGroupId": "yD3**************************CkC",
    "FlowItems": [
        "合同组标签1"
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "31b900d2-18ce-4304-9164-63fa98b6375e"
    }
}

5. 错误码​

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

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