Jira REST API创建工单:如何获取工作流过渡验证器定义的必填字段
Jira Cloud REST API 获取工作流创建验证器必填字段方案
可以通过REST API获取工作流创建过渡验证器中定义的额外必填字段,以下是两种可落地的实现方案:
方案1:静态解析工作流验证器配置
适合需要提前拉取全量字段配置的场景,操作步骤如下:
- 调用
/rest/api/3/workflow/search接口,传入projectIds、issuetypeIds参数筛选目标项目、工单类型关联的工作流,从返回结果的initialTransitions节点中获取工单创建对应的初始过渡ID - 调用
/rest/api/3/workflow/transitions/{transitionId}/configurations接口,替换路径中的{transitionId}为上一步获取的初始过渡ID,在返回结果的validators节点下查找类型为FieldsRequiredValidator的规则,规则配置的fieldIds数组就是该验证器要求的必填字段ID
注意:如果使用第三方插件提供的自定义必填验证器,需要根据对应插件的验证器类型标识解析配置,规则结构可能存在差异。
方案2:动态调用创建校验接口(兼容性更高,推荐使用)
不需要解析复杂的工作流配置,适配所有类型的必填验证规则,包含条件必填场景,操作步骤如下:
- 调用
POST /rest/api/3/issue/validate接口,请求体中仅填写fields基础结构,指定目标项目ID、工单类型ID,不需要填充任何其他字段值 - 接口返回的400错误响应中会列出所有必填字段缺失的错误,包含
createmeta返回的标准必填字段和工作流验证器定义的必填字段,直接从错误项的field属性中提取字段ID即可
该方案无需适配不同类型的验证器规则,返回的必填字段结果和实际创建工单的校验逻辑完全一致,适合自动填充字段的场景使用。
内容的提问来源于stack exchange,提问作者csa
相关产品推荐
相关产品推荐

