Skip to content

Reply Modification



POST /api/v1/issue/reply/{reply_uuid}/modify

Overview

Route Parameters

Parameter Name Type Required Description
reply_uuid string Y reply_uuid

Body Request Parameters

Parameter Name Type Required Description
issueUUID string Y UUID of the issue
Example: issueUUID
Can be empty: False
attachmentUuids array List of UUIDs for uploaded reply attachments
Example: []
Can be empty: True
content string Reply content
Example: answer_xxx
Can be empty: True
Can be an empty string: True
extend json Y Additional extension information, default {} if no content
Example: {}
Can be empty: True

Additional Parameter Notes

Basic Parameter Notes

Parameter Name Parameter Type Mandatory Parameter Description
issueUUID string Y Corresponding UUID of the issue being replied to
attachmentUuids array N List of UUIDs for attachments related to the issue reply; they must first be uploaded via the /api/v1/attachment/upload interface
content string N Content of the reply
extend json Y Extension fields, default is to pass {}

Explanation of the extend Field

In update scenarios, channels and channelUUIDs are associated with default channels and additional channels by default. If passing [], it will only exist in the space's default channel by default.

Parameter Name Parameter Type Mandatory Parameter Description
channels array N Desired list of resources where issues should be delivered
members array N Members who should be notified regarding the issue
extra json N Information about the person updating the reply, used for frontend display

Example of the extend field:

{
    "members": [
        {
            "type": "@",
            "uuid": "acnt_xxxx32",
            "exists": true
        }
    ],
    "channels": [
        {
            "type": "#",
            "uuid": "chan_xxxx32",
            "exists": true
        }
    ],
    "extra": {
                "updator": {
                  "name": "yyy",
                  "email": "xxx@guance.com",
                }
            }
}

Request Example

curl 'https://openapi.guance.com/api/v1/issue/reply/repim_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"issueUUID":"issue_xxxx32","content":"aaaaas","attachmentUuids":[],"extend":{"channels":[],"linkList":[],"members":[],"text":"aaaaas"}}'\
--compressed

Response

{
    "code": 200,
    "content": {
        "content": "aaaaas",
        "createAt": 1690810887,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "extend": {
            "channels": [],
            "linkList": [],
            "members": [],
            "text": "aaaaas"
        },
        "id": 319430,
        "issueUUID": "issue_xxxx32",
        "status": 0,
        "type": "reply",
        "updateAt": 1690811215,
        "updator": "acnt_xxxx32",
        "uuid": "repim_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "13131178623027797701"
} 

Feedback

Is this page helpful? ×