如何使用JIRA Cloud REST API在jira问题上创建内部注释

时间:2017-07-11 10:07:01

标签: json groovy jira jira-rest-api

很难找到关于如何针对仅限内部问题创建评论的明确答案。

1 个答案:

答案 0 :(得分:2)

JIRA Cloud REST API文档指定了在创建或更新事件评论时设置评论属性的以下模式

https://docs.atlassian.com/jira/REST/cloud/#api/2/issue/{issueIdOrKey}/comment-addComment

"properties": {
    "type": "array",
    "items": {
        "title": "Entity Property",
        "type": "object",
        "properties": {
            "key": {
                "type": "string"
            },
            "value": {}
        },
        "additionalProperties": false
    }
}

要对内部问题发表评论(意味着只有服务台代理可以看到评论),您需要将sd.public.comment键设置为值{ "internal": true } 这可以通过在创建或更新API请求的主体中传递以下JSON来实现。

{
    "properties": {
        "key": "sd.public.comment",
        "value": {
            "internal": true
        }
    }
}

您还需要在请求中设置Content-Type标头。

Content-Type: application/json

以下是使用Groovy脚本创建内部注释的示例 - ScriptRunner(一种流行的JIRA插件)使用的脚本语言

post("/rest/api/2/issue/${issue.id}/comment")
    .header("Content-Type", "application/json")
    .body([
        body: "This is the text which will appear in the comment",
        properties: [
            [key: "sd.public.comment", value: [ "internal": true ]]
        ]
    ]).asString()

请注意,Object / JSON映射将根据您使用的脚本语言或HTTP请求框架而有所不同。