Create Issue-Reply¶

POST /api/v1/issue/reply/create

Overview¶

Body Request Parameters¶

Parameter Name	Type	Required	Description
issueUUID	string	Y	UUID corresponding to the issue for reply 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 $maxCustomLength: 65535
extend	json	Y	Additional extended information, defaults to {} if no content is provided Example: {} Can be empty: True

Supplementary Parameter Explanation¶

Basic Parameter Description

Parameter Name	Parameter Type	Required	Parameter Description
issueUUID	string	Y	UUID corresponding to the issue for reply
attachmentUuids	array	N	List of UUIDs for uploaded attachments related to the issue, must first be uploaded via the /api/v1/attachment/upload interface
content	string	N	Content of the reply
attachmentUuids	array	N	List of UUIDs for uploaded attachments
extend	json	Y	Extended fields, default value is {}

Extended Field "extend" Description

In update scenarios, channels and channelUUIDs are by default associated with both the default channel and the appended channels. If you pass [], it will only exist in the workspace's default channel by default.

Parameter Name	Parameter Type	Required	Parameter Description
channels	array	N	List of resources where the issue should be delivered
members	array	N	Members of notification objects that the issue should notify
extra	json	N	Information about the creator of the reply, used for frontend display

Example of the extend field:

name="__codelineno-0-1">{ "members": [ { "type": "@", "uuid": "acnt_xxxx32", "exists": true } ], "channels": [ { "type": "#", "uuid": "chan_xxxx32", "exists": true } ], "extra": { "creator": { "name": "xxx", "email": "xxx@guance.com", } } }

Request Example¶

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

Response¶

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