DocuSign Rooms API无法访问'Side'(transactionSide)字段的获取与更新问题咨询
DocuSign Rooms
transactionSide(界面显示为Side字段)API操作说明 问题解答
1. 该字段的API可行获取方法
此前调用GET /restapi/v2/accounts/{accountId}/rooms/{roomId}、GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data两个端点无法获取该字段,核心原因是transactionSide不属于房间基础元数据,也不归属field_data接口管理的自定义扩展字段集合。
- 可使用的获取路径:调用
GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/details房间详情接口,返回的结构化原生交易属性中直接包含该字段,可读取到buy、sell、listbuy、refi四类枚举取值。 - 若调用上述接口未返回对应字段,需检查API应用的授权范围,确认是否已开通
rooms.details.read权限项——默认授权范围不会开放原生交易属性的读取能力,需要在应用权限配置中手动勾选对应权限。
2. 该字段的API更新规则
无法通过PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data接口对该字段进行更新。
- 不支持的原因:
transactionSide是房间初始化阶段写入的核心原生属性,不属于field_data接口管理的扩展字段集合,在该接口的请求体中传入对应参数会被直接过滤,不会产生实际生效的更新。 - 合规更新路径:调用
PUT /restapi/v2/accounts/{accountId}/rooms/{roomId}房间基础属性更新接口,在请求体中传入对应枚举值的transactionSide参数即可完成修改;部分老旧企业账户如果未开放该端点对该字段的写权限,需要联系账户对应的DocuSign对接人申请开通字段写操作白名单。
内容的提问来源于stack exchange,提问作者Volodymyr
相关产品推荐
相关产品推荐

