댓글 생성¶
POST /api/v1/issue/reply/create
개요¶
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issueUUID | string | Y | 댓글을 작성할 issue의 UUID 예시: issueUUID NULL 허용: False |
| attachmentUuids | array | 댓글 첨부 파일 업로드 목록 UUID 예시: [] NULL 허용: True |
|
| content | string | 댓글 내용 예시: answer_xxx NULL 허용: True 빈 문자열 허용: True $maxCustomLength: 65535 |
|
| extend | json | Y | 추가 확장 정보, 내용이 없으면 기본값 {} 예시: {} NULL 허용: True |
파라미터 추가 설명¶
기본 파라미터 설명
| 파라미터명 | 파라미터 유형 | 필수 여부 | 파라미터 설명 |
|---|---|---|---|
| issueUUID | string | Y | 댓글을 작성할 issue의 UUID |
| attachmentUuids | array | N | 댓글 첨부 파일 목록 UUID, 먼저 /api/v1/attachment/upload API를 통해 업로드해야 함 |
| 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@guance.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"
}