Issue-回复 创建¶
POST /api/v1/issue/reply/create
概述¶
Body 请求参数¶
参数名 | 类型 | 必选 | 说明 |
---|---|---|---|
issueUUID | string | Y | 对应回复issue的UUID 例子: issueUUID 允许为空: False |
attachmentUuids | array | 回复附件上传列表uuids 例子: [] 允许为空: True |
|
content | string | 回复内容 例子: answer_xxx 允许为空: True 允许为空字符串: True $maxCustomLength: 65535 |
|
extend | json | Y | 额外拓展信息,没有内容默认{} 例子: {} 允许为空: True |
参数补充说明¶
基本参数说明
参数名 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
issueUUID | string | Y | 对应回复issue的UUID |
attachmentUuids | array | N | 对应回复issue的附件列表uuid,需先通过 /api/v1/attachment/upload 接口进行上传 |
content | string | N | 回复的内容 |
attachmentUuids | array | N | 附件上传列表uuid |
extend | json | Y | 扩展字段,默认传{} |
扩展字段extend说明
更新场景中,channels和channelUUIDs的作用会默认的向默认频道和追加的频道中进行关联处理, 如果传[],默认只会存在空间默认频道中
参数名 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|
channels | array | N | 期望issue投递的资源列表 |
members | array | N | 期望issue通知的通知对象成员 |
extra | json | N | 回复创建人相关名称等信息, 用于前端回显 |
extend 字段示例:
{
"members": [
{
"type": "@",
"uuid": "acnt_xxxx32",
"exists": true
}
],
"channels": [
{
"type": "#",
"uuid": "chan_xxxx32",
"exists": true
}
],
"extra": {
"creator": {
"name": "xxx",
"email": "xxx@qq.com",
}
}
}
请求例子¶
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
响应¶
{
"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"
}