查询流程基础信息

1. 接口描述

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

查询流程基础信息
适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。

注: 每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取流程基础信息

获取流程基础信息, 例子中查询2个合同流程的基础信息

输入示例

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "FlowIds": [
        "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
        "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "s123456789",
        "FlowBriefs": [
            {
                "FlowId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R",
                "FlowName": "张三的入职合同",
                "FlowDescription": "张三10230822日入职需要签署的合同",
                "FlowType": "入职合同",
                "FlowStatus": 1,
                "CreatedOn": 1604910798,
                "FlowMessage": "",
                "Deadline": 1606910798,
                "Creator": "yDxbWUyKQDxPGGUuO4zjEyI4pZLqE2gh"
            },
            {
                "FlowId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
                "FlowName": "采购1000台MacMini2合同",
                "FlowDescription": "8G256G配置电脑采购",
                "FlowType": "采购销售",
                "FlowStatus": 1,
                "CreatedOn": 1604910797,
                "FlowMessage": "",
                "Deadline": 1606910798,
                "Creator": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            }
        ]
    }
}

示例2 获取流程基础信息失败情况

获取流程基础信息, 但是没有对应合同流程的权限, 所以失败

输入示例

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "FlowIds": [
        "yDwqYUZzwwjn1UEq1XhgvJVGELPHP6pB"
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "无查看权限, 请检查"
        },
        "RequestId": "s1692325082060040872"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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