Open API 接口文档详细使用说明
API 是否支持上传缺陷附件？
API 是否支持创建需求关联的接口？
创建需求关联接口已下掉，暂时没有其他接口代替， 因为这个接口要重构，重构后才会支持，同学请耐心等待。
API 是否有支持视图里筛选工作项属性的接口？
目前 API 不支持视图里筛选工作项属性的接口。
API 是否支持创建需求的接口，具体如何操作？
API 接口调用出现非 500 类错误码可能的错误原因和自行排查建议？
API 的 user_key 如何获取？
2021年6月前入职的同学，user-key 是邮箱前缀；
2021年6月后入职的同学，user-key 获取方式如下两种：
方法一：在平台页面双击左下角小头像。
250px|700px|reset
API 接口如何通过工作项名称获取工作项 ID？
通过名称获取 ID 列表的请求头如下：
250px|700px|reset
API 添加附件的接口，有时候会覆盖原附件内容怎么办？
短时间内多次上传会出现覆盖的情况，待上传完毕一个附件再上传另一个，或者可尝试一次上传多个附件。
API 是否可以获取控件信息？
api 返回的数据，不包含控件数据，但是会包含[拉群方式选择]、 [角色与人员]的信息。
API 是否支持获取需求下的缺陷列表接口，具体如何操作？
API 如何获取视图 id？
为什么 API 取出的视图数据与实际视图数据不符？
视图中设置筛选条件后点击“保存变更”，将筛选设置保存至视图后，通过 API 获取视图数据与实际数据相同。
250px|700px|reset
如何获取 webhook 推送的服务器 IP ？
使用的是动态IP，无法获取到服务器IP。
通搜接口是哪个？
为什么请求空间数据的接口需要获得“插件”的 token？
调用 Open API 之前需要先创建插件，申请权限然后将插件安装到对应的空间，才可以访问到该空间下面的一些数据。
如何查询自己的 user_key ？
先点击左下角头像，再双击弹窗的小头像即可复制 user_key 。
250px|700px|reset
离职同学的user_key和token还能用吗？
离职同学的user_key和token 不能再使用
API添加的附件如何预览？
- 先用postman试下看，能否预览
- 可以的话借鉴下postman相应语言的代码demo
250px|700px|reset
X-USER-KEY 可以通过API获取吗?
通过插件身份凭证+X-USER-KEY的方式请求 API，对 X-USER-KEY 的权限有什么要求吗？
用 user_key 请求 API 需要有该用户空间对应的权限。例如是空间管理员才能做的某个修改，那么使用Open API 操作修改时， user_key 也应该有管理员权限。
为什么有的人 user_key 是邮箱前缀，有的人是一串数字？
2021年6月前入职的同学 user_key 是邮箱前缀，考虑到信息安全问题，之后入职的同学统一是数字。
如何分辨工作项类型是否为自定义类型？
根据 type_key 识别，例如系统工作项需求——story，缺陷——issue等；自定义工作项是随机串。
如何获取空间 token？
老接口的替换接口？
1、合并原有「获取用户有权限的空间列表」至「获取空间列表」。
2、合并原有用户信息查询接口至「获取用户详情」。
3、更新「人员角色」和「节点负责人」分别对应「更新工作项」中的字段值更新和「更新节点及排期」中的负责人，对应新版详情页该功能拆解。
4、获取空间列表（工作项的建单页字段已拆解到「获取创建工作项元数据」接口）。
5、获取缺陷类型列表（已提供获取「空间下的流程类型列表」接口）。
如何获得各业务线 id？
方式二、空间管理员在空间配置页，F12——检查——网络，过滤 business，即可在预览中查看业务线 id。
250px|700px|reset
海外用户是否可以使用 Open API？
可以正常使用。
通过 API 接口创建需求时，自动拉群可以拉指定机器人入群吗？
Webhook 能否通过 Open API 配置？
暂不支持。
自动化中的字段值 Webhook 触发不了？
目前状态流转表单中的字段值修改无法触发自动化。
token 为什么被封禁了？
Open API 如何配置筛选项？
如何获取已终止的需求？
250px|700px|reset
如何获取 project_key 和 simple_name？
project_key：双击空间名称即可复制 project_key
250px|700px|reset
simple_name：
250px|700px|reset
查询 issue 详情为什么新老版本返回不一致？
出于安全考虑，新版本对返回的字段信息做了严格的管控。
如何通过接口获取单个缺陷信息？
调用接口时为什么字段没有实时更新？
调接口更新工作项会存在一定程度的时延。
有获取 template 节点的接口吗？
【创建工作项】在「描述」字段中如何添加图片？
暂不支持。
【获取指定的工作项列表】可以获取已终止的需求吗？
可以，在sub_stages中加上["closed"]选项即可，且加上closed选项后，只能筛选已终止的。
【获取指定的工作项列表】business 返回的只有 value，没有 label ？
label 可通过获取业务线详情进行映射。
【获取指定的工作项列表（单空间 | 复杂传参）】复杂传参 search_params 支持 work_item_name 模糊搜索吗？
支持，不过 key 应该叫 name。
【获取指定的工作项列表（单空间 | 复杂传参）】是否支持 expand？
支持 expand。
【获取指定的工作项列表（单空间 | 复杂传参）】search_group 获取空间的全部需求（不加筛选参数），这个参数该如何填写？
该接口不支持获取空间的全部需求, 可以通过 获取指定的工作项列表（单空间）将所有的工作项类型列表传递到 work_item_type_keys 参数中；该空间的所有工作项类型可通过 获取工作项详情 获取。
【添加评论】评论内容支持 @ 人员吗？
暂不支持。
【获取工作项下的流程类型】如何获取模板的英文名称？
暂无返回。
【数据结构汇总】SearchParam 的 key 和空间字段的 field_key 相同吗？
SearchParam 的 key 和空间字段的 field_key 是相同的。
