# 获取文件签署节点信息

该接口可以通过电子签文件ID查询到该电子签文件的签署流程的各个节点信息，包括签署节点、盖章节点、审阅节点等，各个节点有对应的内容、完成时间、审阅人、盖章人等信息

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/signature_nodes/list_by_file_id
HTTP Method | GET
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看电子签文件(corehr:signature.file:read)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
file_id | string | 是 | 电子签文件ID，可以通过[【批量获取电子签文件<br>】](/ssl:ttdc/uAjLw4CM/ukTMukTMukTM/corehr-v2/signature_file/list)获取<br>**示例值**：7149088311624091180
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：people_corehr_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>- people_corehr_id：以飞书人事的 ID 来识别用户<br>**默认值**：`people_corehr_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
signature_nodes | signature_node\[\] | 电子签文件签署流程各个节点列表信息
user_infos | signature_user_info\[\] | 节点相关的角色信息
id | string | 员工雇佣ID，可以通过[【搜索员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/search)获取员工详细信息
state | string | 节点状态，枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签文件状态（signature_file_state）枚举定义部分获得
finish_time | string | 节点完成时间
updated_time | string | 节点最近更新时间
is_ongoing | boolean | 当前节点是否为正在处理的节点
role_label | signature_enum_info_label | 当前节点操作名称
zh | string | 当前节点的操作名称中文展示，如：发起
en | string | 当前节点的操作名称英文展示，如：Initiate
sign_role | string | 操作人类型，如：发起人、审阅人、签字人<br>枚举值可通过文档[【飞书人事枚举常量】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/feishu-people-enum-constant)电子签文件流程节点签署角色（signature_node_sign_role）枚举定义部分获得

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "signature_nodes": [
            {
                "user_infos": [
                    {
                        "id": "7300476612163913260"
                    }
                ],
                "state": "Initiated",
                "finish_time": "2021-12-31 12:21:10",
                "updated_time": "2021-12-31 12:21:10",
                "is_ongoing": false,
                "role_label": {
                    "zh": "发起",
                    "en": "Initiate"
                },
                "sign_role": "Initiator"
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1160001 | param is invalid | 请检查请求参数的类型、格式或值是否与接口要求一致，参考文档中的请求参数说明（如file_id需通过[批量获取电子签文件] 获取）