Skip to content

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
Allow empty: False
$maxCustomLength: 256
level string Level, corresponding to level configuration uuid
Example: level
Allow empty: False
Allow empty string: True
description string Description
Example: description
Allow empty: False
statusType integer Issue status
Example: statusType
Allow empty: False
Optional values: [10, 15, 20, 25, 30]
extend json Y Additional extension information, default {}
Example: {}
Allow empty: True
attachmentUuids array Attachment upload list uuid
Example: []
Allow empty: True

Parameter Additional Explanation

Basic Parameter Explanation

Parameter Name Parameter Type Required Parameter Explanation
name string N Issue title name
level string N Issue level, corresponding to level configuration 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 Attachment upload list uuid, need to be uploaded via /api/v1/attachment/upload interface first
extend json N Extension field, default pass {}

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

Level Value Parameter Explanation
P0 system_level_0 Pass level: system_level_0, indicating system level P0
P1 system_level_1 Pass level: system_level_1, indicating system level P1
P2 system_level_2 Pass level: system_level_2, indicating system level P2
P3 system_level_3 Pass level: system_level_3, indicating system level P3
xxx issl_yyyyy Pass level: issl_yyyyy, indicating custom level xxx

Extension Field extend Explanation

Parameter Name Parameter Type Required Parameter Explanation
channels array N Describes the # in the content: expected issue delivery resource list
linkList array N Add issue links
members array N Describes the @ in the content: expected issue notification target members
manager array N Responsible person information (user account uuid, email, team uuid)
extra json N Issue updator/responsible person email corresponding name and other information, used for front-end display

extend Field Example:

{
    "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"
}

Feedback

Is this page helpful? ×