
在使用jira rest api通过jrjc创建或更新问题时,设置自定义字段是一个常见的需求。然而,开发者经常会遇到“字段无法设置”的错误,即使代码看起来是正确的。这通常不是jrjc代码本身的语法问题,而是jira服务器端的配置(如屏幕方案、字段上下文或权限)限制了字段的可见性和可编辑性。本文将深入探讨这一问题,并提供全面的解决方案。
JIRA中的自定义字段类型多样,包括文本、数字、日期、下拉列表、多选框等。通过REST API设置这些字段时,需要根据字段类型传递相应格式的值。JRJC库通过IssueInputBuilder提供了一个便捷的接口setFieldValue()来完成这项任务。
对于下拉列表(Select List)或单选按钮(Radio Buttons)等具有预定义选项的自定义字段,其值通常需要通过选项的ID来指定,或者封装成CustomFieldOption对象。
JRJC中设置自定义字段的基本方法
IssueInputBuilder是构建问题输入的核心,它允许我们设置标准字段(如摘要、描述、项目、问题类型)以及自定义字段。
import com.atlassian.jira.rest.client.api.domain.IssueInput;
import com.atlassian.jira.rest.client.api.domain.IssueInputBuilder;
import com.atlassian.jira.rest.client.api.domain.CustomFieldOption;
import com.atlassian.jira.rest.client.api.JiraRestClient;
import com.atlassian.jira.rest.client.internal.async.AsynchronousJiraRestClientFactory;
import java.net.URI;
// 假设jiraRestClient已初始化
// JiraRestClient jiraRestClient = new AsynchronousJiraRestClientFactory().createWithBasicHttpAuthentication(jiraUri, username, password);
public class JiraIssueCreator {
private final JiraRestClient jira;
private final String projectKey;
private final Long testIssueTypeId;
public JiraIssueCreator(JiraRestClient jira, String projectKey, Long testIssueTypeId) {
this.jira = jira;
this.projectKey = projectKey;
this.testIssueTypeId = testIssueTypeId;
}
public String createIssueWithCustomField(String summary, String description,
String customFieldName, Long customFieldOptionId, String customFieldOptionValue) {
IssueInputBuilder builder = new IssueInputBuilder(projectKey, testIssueTypeId, summary)
.setDescription(description);
// 示例:设置一个下拉列表或单选按钮类型的自定义字段
// 注意:customFieldOptionId 是选项的ID,customFieldOptionValue 是选项的显示值
// JIRA REST API通常更倾向于接收ID,但在某些情况下,CustomFieldOption对象可能需要完整信息。
// 这里的CustomFieldOption构造函数参数为:ID, 自我链接URI, 值, 父选项, 独立选项标志
// 大多数情况下,只需提供ID和值即可。
builder.setFieldValue(customFieldName,
new CustomFieldOption(customFieldOptionId, null, customFieldOptionValue, null, null));
// 示例:设置一个文本类型的自定义字段
// builder.setFieldValue("我的文本字段", "这是一个文本值");
// 示例:设置一个数字类型的自定义字段
// builder.setFieldValue("我的数字字段", 12345);
IssueInput input = builder.build();
try {
return jira.getIssueClient().createIssue(input).claim().getKey();
} catch (Exception e) {
System.err.println("创建问题失败: " + e.getMessage());
throw new RuntimeException("创建JIRA问题时发生错误", e);
}
}
// 辅助方法,用于获取问题类型ID,实际应用中可能从JIRA API查询
private Long getTestIssueTypeId(String projectKey) {
// 实际实现会查询JIRA API获取问题类型ID
return 10001L; // 示例ID
}
public static void main(String[] args) {
// 实际使用时替换为您的JIRA实例信息
URI jiraUri = URI.create("https://your-jira-instance.com");
String username = "your_username";
String password = "your_password";
String projectKey = "TEST";
Long issueTypeId = 10001L; // 您的目标问题类型ID
JiraRestClient jiraRestClient = new AsynchronousJiraRestClientFactory()
.createWithBasicHttpAuthentication(jiraUri, username, password);
JiraIssueCreator creator = new JiraIssueCreator(jiraRestClient, projectKey, issueTypeId);
try {
// 假设 "Application" 是一个自定义字段,ID为14314的选项值为"NA:12345"
String createdIssueKey = creator.createIssueWithCustomField(
"通过JRJC创建的问题",
"这是一个通过JRJC创建的问题的描述。",
"Application", // 自定义字段名称
14314L, // 选项ID
"NA:12345" // 选项显示值
);
System.out.println("成功创建问题: " + createdIssueKey);
} catch (RuntimeException e) {
System.err.println("无法创建问题: " + e.getMessage());
} finally {
try {
jiraRestClient.close();
} catch (Exception e) {
System.err.println("关闭JIRA REST客户端失败: " + e.getMessage());
}
}
}
}当您尝试使用上述代码设置自定义字段,但收到类似 RestClientException{statusCode=Optional.of(400), errorCollections=[ErrorCollection{status=400, errors={Test Type=Field 'Test Type' cannot be set. It is not on the appropriate screen, or unknown.}, errorMessages=[]}]} 的错误时,这通常意味着以下两种情况之一:
解决此类问题的关键在于检查和调整JIRA服务器端的配置。
确保自定义字段已添加到目标问题类型和操作的屏幕方案中。
步骤一:确定问题类型和操作
步骤二:查找字段的上下文和屏幕方案
步骤三:检查问题类型和操作对应的屏幕方案
具体操作流程示例: 假设您的项目使用“默认屏幕方案”,并且您要为“任务”问题类型在创建时设置“Application”字段:
确保执行REST API调用的用户具有在目标项目中创建/编辑问题的权限,以及可能存在的字段级权限。
项目权限:
字段级安全权限(较少见): JIRA允许对特定字段设置权限,限制谁可以查看或编辑它。
如果出于某种原因不希望将字段直接添加到屏幕上,或者字段值需要在特定条件下自动设置,可以考虑通过JIRA工作流的“后置函数”(Post Function)来设置字段值。例如,在问题创建转换后,添加一个后置函数来设置自定义字段的值。这需要JIRA管理员权限来修改工作流。
通过JRJC使用JIRA REST API设置自定义字段时,成功的关键在于理解JIRA服务器端的配置与客户端代码的交互。当遇到“字段无法设置”的错误时,应首先排查JIRA的屏幕配置和权限设置,确保自定义字段在目标问题类型和操作的上下文中是可见且可编辑的。一旦服务器端配置正确,JRJC代码便能顺畅地完成字段值的设置。
以上就是JIRA JRJC REST API设置自定义字段:深入理解屏幕配置与权限的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号