跳转至

Issue 修改


POST /api/v1/issue/{issue_uuid}/modify

概述

路由参数

参数名 类型 必选 说明
issue_uuid string Y issueUUID

Body 请求参数

参数名 类型 必选 说明
name string 标题名称
例子: name
允许为空: False
$maxCustomLength: 256
level string 等级,对应等级配置uuid
例子: level
允许为空: False
允许为空字符串: True
description string 描述
例子: description
允许为空: False
statusType integer issue的状态
例子: statusType
允许为空: False
可选值: [10, 20, 30]
extend json Y 额外拓展信息，没有内容默认{}
例子: {}
允许为空: True
attachmentUuids array 附件上传列表uuid
例子: []
允许为空: True

参数补充说明

基本参数说明

参数名 参数类型 是否必填 参数说明
name string N issue标题名称
level string N issue等级 对应配置等级uuid
statusType integer N issue状态, 10: Open, 20: Resolved, 30: Pending
decription string N issue描述信息
attachmentUuids array N 附件上传列表uuid, 需先通过 /api/v1/attachment/upload 接口进行上传
extend json N 扩展字段，默认传{}

level 等级字段说明 level 分为系统等级/自定义等级(可在配置管理中进行配置)

level value 参数说明
P0 system_level_0 传参 level: system_level_0, 表示系统等级 P0
P1 system_level_1 传参 level: system_level_1, 表示系统等级 P1
P2 system_level_2 传参 level: system_level_2, 表示系统等级 P2
P3 system_level_3 传参 level: system_level_3, 表示系统等级 P3
xxx issl_yyyyy 传参 level: issl_yyyyy, 表示自定义等级 xxx

扩展字段extend说明

参数名 参数类型 是否必填 参数说明
channels array N 描述内容里的 # : 期望issue投递的资源列表,
linkList array N 添加issue 链接
members array N 描述内容里的 @ 期望issue通知的通知对象成员
manager array N 用户账号uuid, 邮箱, 团队uuid
extra json N issue更新人/负责人邮箱对应名称等信息, 用于前端回显

extend 字段示例: 

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "channels": [
        {
            "type": "#",
            "uuid": "chan_xxxx32",
            "exists": true
        }
    ],
    "manager": [
        "acnt_xxxxx",
        "111@qq.com",
        "group_xxx",
        "222@qq.com"
    ],
    "linkList": [
        {
            "name": "解决",
            "link": "https://sd.com",
        }
    ],
    "extra":{
              "updator": {
                  "name": "xxx",
                  "email": "xxx@qq.com",
              },
              "managerInfos": {
                  "111@qq.com": {"name": "111"},
                  "222@qq.com": {"name": "222"}
              }
            }
}

请求例子

curl 'https://openapi.guance.com/api/v1/issue/issue_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"statusType":20}'\
--compressed

响应

{
    "code": 200,
    "content": {
        "createAt": 1686398344,
        "creator": "acnt_xxxx32",
        "creatorInfo": {
            "acntWsNickname": "",
            "email": "1061379682@qq.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "1061379682@qq.com"
        },
        "deleteAt": -1,
        "description": "",
        "extend": {
            "channels": [
                {
                    "exists": true,
                    "type": "#",
                    "uuid": "chan_xxxx32"
                }
            ],
            "view_isuue_url": ""
        },
        "id": 47402,
        "level": "system_level_2",
        "name": "dcacscsc",
        "resource": "",
        "resourceType": "",
        "resourceUUID": "",
        "status": 0,
        "statusType": 20,
        "subIdentify": "",
        "updateAt": 1686400483,
        "updator": "acnt_xxxx32",
        "updatorInfo": {
            "acntWsNickname": "",
            "email": "1061379682@qq.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "1061379682@qq.com"
        },
        "uuid": "issue_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1744405827768254151"
}

文档评价

文档内容是否对您有帮助？ ×