Reply Create¶
POST /api/v1/issue/reply/create
Overview¶
Body Request Parameters¶
Parameter | Type | Required | Description |
---|---|---|---|
issueUUID | string | Y | The UUID of the issue to reply to Example: issueUUID Allow empty: False |
attachmentUuids | array | The list of uuids for uploaded attachments Example: [] Allow empty: True |
|
content | string | The content of the reply Example: answer_xxx Allow empty: True Allow empty string: True $maxCustomLength: 65535 |
|
extend | json | Y | Additional extended information, default is {} Example: {} Allow empty: True |
Parameter Additional Description¶
Basic Parameter Description
Parameter | Parameter Type | Required | Parameter Description |
---|---|---|---|
issueUUID | string | Y | The UUID of the issue to reply to |
attachmentUuids | array | N | The list of uuids for uploaded attachments, need to be uploaded via /api/v1/attachment/upload interface first |
content | string | N | The content of the reply |
attachmentUuids | array | N | The list of uuids for uploaded attachments |
extend | json | Y | Extended field, default is {} |
Extended Field extend Description
In the update scenario, the roles of channels and channelUUIDs will default to associating with the default channel and additional channels. If [] is passed, it will only exist in the default channel of the workspace
Parameter | Parameter Type | Required | Parameter Description |
---|---|---|---|
channels | array | N | The list of resources to which the issue is expected to be delivered |
members | array | N | The list of notification target members to whom the issue is expected to notify |
extra | json | N | Information related to the reply creator, such as name, for front-end display |
Example of extend field:
{
"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"
}