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 Allow Empty: False |
| attachmentUuids | array | List of UUIDs for reply attachments upload Example: [] Allow Empty: True |
|
| content | string | Reply content Example: answer_xxx Allow Empty: True Allow Empty String: True |
|
| extend | json | Y | Additional extended information, default {} if no content Example: {} Allow Empty: True |
Parameter Supplementary Explanation¶
Basic Parameter Description
| Parameter Name | Parameter Type | Required | Parameter Description |
|---|---|---|---|
| issueUUID | string | Y | UUID of the corresponding reply issue |
| attachmentUuids | array | N | List of UUIDs for attachments of the corresponding reply issue, must be uploaded first via the /api/v1/attachment/upload interface |
| content | string | N | Content of the reply |
| extend | json | Y | Extended field, default pass {} |
Extended Field extend Description
In update scenarios, the roles of channels and channelUUIDs will by default handle associations to the default channel and appended channels. If [] is passed, 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 expected for issue delivery |
| members | array | N | Notification target members expected to be notified for the issue |
| extra | json | N | Information such as the name of the reply updater, etc., for frontend display |
extend field example:
{
"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"
}