Modify¶

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

Overview¶

Route Parameters¶

Parameter Name	Type	Required	Description
issue_uuid	string	Y	issueUUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string		Title name Example: name Can be empty: False $maxCustomLength: 256
level	string		Level, corresponding to the level configuration uuid Example: level Can be empty: False Can be an empty string: True
description	string		Description Example: description Can be empty: False
statusType	integer		Status of the issue Example: statusType Can be empty: False Possible values: [10, 15, 20, 25, 30]
extend	json	Y	Additional extended information, defaults to {} if no content is provided Example: {} Can be empty: True
attachmentUuids	array		List of UUIDs for uploaded attachments Example: [] Can be empty: True

Parameter Additional Explanation¶

Basic Parameter Explanation

Parameter Name	Parameter Type	Required	Parameter Description
name	string	N	Issue title name
level	string	N	Issue level corresponding to the configuration level uuid
statusType	integer	N	Issue status, 10: Open, 15: Working, 20: Resolved, 25: Closed, 30: Pending
description	string	N	Issue description information
attachmentUuids	array	N	List of UUIDs for uploaded attachments, must first be uploaded via the /api/v1/attachment/upload interface
extend	json	N	Extended fields, default is to pass {}

Level Field Explanation The level is divided into system levels/custom levels (can be configured in the configuration management)

level	value	Parameter Description
P0	system_level_0	Pass parameter level: system_level_0, indicates system level P0
P1	system_level_1	Pass parameter level: system_level_1, indicates system level P1
P2	system_level_2	Pass parameter level: system_level_2, indicates system level P2
P3	system_level_3	Pass parameter level: system_level_3, indicates system level P3
xxx	issl_yyyyy	Pass parameter level: issl_yyyyy, indicates custom level xxx

Extended Field "extend" Explanation

Parameter Name	Parameter Type	Required	Parameter Description
channels	array	N	Description content’s # : Expected list of resources where issues should be delivered
linkList	array	N	Add issue links
members	array	N	Description content’s @ : Expected notification target members for issue notifications
manager	array	N	Responsible person information (user account uuid, email, team uuid)
extra	json	N	Information about the issue updater/responsible person's email correspondence names, used for front-end display

Example of the extend field:

name="__codelineno-0-1">{ "members": [ { "type": "@", "uuid": "acnt_xxxx32", "exists": true } ], "channels": [ { "type": "#", "uuid": "chan_xxxx32", "exists": true } ], "manager": [ "acnt_xxxxx", "xxx@guance.com", "group_xxx", "xxx@guance.com" ], "linkList": [ { "name": "Resolve", "link": "https://sd.com", } ], "extra":{ "updator": { "name": "xxx", "email": "xxx@guance.com", }, "managerInfos": { "xxx@guance.com": {"name": "111"}, "xxx@guance.com": {"name": "222"} } } }

Request Example¶

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

Response¶

{
    "code": 200,
    "content": {
        "createAt": 1686398344,
        "creator": "acnt_xxxx32",
        "creatorInfo": {
            "acntWsNickname": "",
            "email": "xxx@guance.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "xxx@guance.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": "xxx@guance.com",
            "iconUrl": "",
            "name": "wanglei-testing",
            "username": "xxx@guance.com"
        },
        "uuid": "issue_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1744405827768254151"
}