댓글 추가¶
POST /api/v1/error_track/comment/{issue_id}/add
개요¶
오류 댓글을 추가하고 담당자 및 이번 @ 대상에게 알림을 보냅니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackManage 권한이 필요합니다. 경로에는 실제 issue_id를 사용합니다. 상위 로컬 메타데이터가 없으면 먼저 초기화하고 제출합니다. 텔레메트리가 실제로 존재하는지는 검증하지 않습니다. 새 댓글은 먼저 제출된 후 첨부 파일 바인딩, 요약 구성 및 알림이 수행되므로 실패 시 이미 저장되었을 수 있습니다. 멱등 키가 없으므로 500/타임아웃만으로 직접 재시도해서는 안 됩니다. 성공 시 true만 반환하고 새 댓글 UUID는 반환하지 않으므로 댓글 목록에서 다시 읽어야 합니다.
알림 대상은 기존 담당자와 이번 요청의 extend.members에서 type=@이고 uuid가 비어 있지 않은 대상입니다. 팀은 구성원으로 확장되어 사용 가능한 알림 방식으로 전송되며, 일치하는 일정이 없으면 자동으로 폴백됩니다. 일반 채널의 예외는 대부분 포착되며, 200이 전달을 보장하지는 않습니다. 알림 준비 실패 시 500이 발생할 수 있으며 이때 댓글은 이미 저장되었을 수 있습니다.
extend는 객체를 사용하거나 생략하고, attachmentUUIDs는 배열을 사용하거나 생략하세요. 명시적 null은 공개 선언을 통과하지만 제출 후 500이 발생할 수 있습니다. members 하위 구조에는 완전한 검증이 없으므로 객체 배열을 직접 구성해야 합니다. 첨부 파일 []은 바인딩을 해제하지 않으며 교체 목록과 동일하지 않습니다. 첨부 파일을 재사용하면 바인딩이 변경되므로 먼저 모든 UUID를 확인하세요. 실패 시 먼저 댓글/첨부 파일과 실제 알림을 다시 읽어 중복 댓글과 중복 알림을 방지하세요.
경로 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_id | string | Y | 오류 집계 비즈니스 식별자이며 그대로 전달합니다. refData.uuid(isset_) 또는 댓글 UUID가 아닙니다. 경로는 URL 인코딩으로 처리되며, 상세 API로 텔레메트리 존재 여부를 검증하지 마세요. 빈 문자열 허용: False 예: err_payment_timeout가져오기 또는 입력 방법: 오류 추적 목록에서 content.data[].issue_id를 가져오거나 현재 워크스페이스 오류 센터 텔레메트리 레코드의 issue_id를 사용합니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| extend.members | array | 선택적 객체 배열이며 type=@이고 uuid가 비어 있지 않은 항목만 알림 대상이 됩니다. 생략/[]는 이번 @ 대상을 추가하지 않습니다. 하위 객체에는 완전한 선언 검증이 없으며 null/잘못된 형태는 500을 발생시킬 수 있습니다. 저장에 성공해도 대상이 유효하거나 전달 가능함을 보장하지 않습니다. 예: [{"uuid": "acnt_example", "type": "@"}]가져오기 또는 입력 방법: 워크스페이스 구성원 또는 팀 목록에서 현재 워크스페이스의 유효한 주체를 선택하고 편집기 @ 내용에 맞게 구성합니다. |
|
| extend.members[*] | json | @ 대상 객체 하나입니다. 예: {"uuid": "acnt_example", "type": "@"}가져오기 또는 입력 방법: 현재 워크스페이스의 실제 @ 대상으로 구성합니다. |
|
| extend.members[*].uuid | string | 대상 주체 식별자이며 acnt_ 또는 group_을 권장합니다. 서로 다른 주체는 알림 수신자 리졸버에서 처리하며, 알 수 없는 값이 반드시 오류를 반환하는 것은 아닙니다. 예: acnt_example가져오기 또는 입력 방법: 현재 워크스페이스 구성원/팀 목록에서 가져오며 역할 UUID는 사용하지 않습니다. |
|
| extend.members[*].type | string | 값 @는 알림에 참여하며, 다른 값은 저장될 수 있지만 @ 대상으로 전송되지는 않습니다. 예: @가져오기 또는 입력 방법: 댓글 편집기 @ 표기 프로토콜입니다. |
|
| extend.自定义键 | any | 임의의 JSON 값(객체/배열/숫자/문자열/불리언/null)이며 추가 서버 실행 매개변수가 아닙니다. 예: incident-123가져오기 또는 입력 방법: 호출자가 자체 댓글 표시 정보를 저장합니다. |
|
| attachmentUUIDs[*] | string | 단일 첨부 파일 UUID 문자열이며 URL 또는 파일 이름이 아닙니다. 바인딩은 첨부 파일 출처를 업데이트하므로 다른 댓글의 첨부 파일을 재사용하지 마세요. 예: att_example가져오기 또는 입력 방법: 현재 워크스페이스에 업로드된 첨부 파일의 uuid입니다. |
|
| attachmentUUIDs | array | 선택적 첨부 파일 UUID 배열이며 생략하면 바인딩하지 않습니다. []는 기존 첨부 파일을 지우지 않으며 나열된 유효 첨부 파일만 추가/바인딩 변경합니다. 선언상 null을 허용하지만 순회 시 500이 발생하므로 클라이언트에서 null을 전달해서는 안 됩니다. 존재하지 않거나 비활성인 UUID도 500을 발생시킬 수 있으며, 서버가 항목별로 결과를 반환하거나 전체 배치의 원자성을 보장하지 않습니다. null 허용: True 예: ["att_example"]가져오기 또는 입력 방법: 먼저 현재 워크스페이스의 첨부 파일 업로드를 통해 content.attachmentUuid를 가져오고, 사용 가능한 것으로 확인한 첨부 파일만 사용하세요. |
|
| comment | string | Y | 필수 문자열입니다. 현재 선언에서 비어 있지 않음을 강제하지 않지만 호출자는 이해 가능한 비어 있지 않은 본문을 제공해야 합니다. 수정 시 본문을 전체 교체합니다. null 허용: False 예: 타임아웃 원인을 확인했으며 처리 중입니다.가져오기 또는 입력 방법: 호출자가 본문을 작성하며 오류 센터 편집기와 합의된 표시 확장 정보를 저장합니다. |
| extend | json | 선택적 JSON 객체이며, 존재하면 전체 교체되고 수정 시 생략하면 유지됩니다. 생성 시에는 생략하거나 {}를 사용합니다. 선언상 null을 허용하지만 알림에서 extend.get을 읽을 때 500이 발생하고 댓글은 이미 저장되었을 수 있으므로 클라이언트는 생략하거나 {}를 전달하고 null을 전달해서는 안 됩니다. 루트 배열/문자열은 사전 검사에서 406으로 거부됩니다. null 허용: True 예: {"members": [{"uuid": "acnt_example", "type": "@"}]}가져오기 또는 입력 방법: 호출자가 본문을 작성하며 오류 센터 편집기와 합의된 표시 확장 정보를 저장합니다. |
매개변수 추가 설명¶
요청 매개변수 설명
| 매개변수 이름 | 매개변수 유형 | 필수 여부 | 매개변수 설명 |
|---|---|---|---|
| attachmentUUIDs | array | N | 해당 댓글 issue의 첨부 파일 목록 uuid이며, 먼저 /api/v1/attachment/upload API를 통해 업로드해야 합니다 |
| comment | string | Y | 댓글 내용 |
| extend | json | N | 확장 필드이며 기본값으로 {}를 전달합니다 |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track/comment/err_payment_timeout/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"comment":"타임아웃 원인을 확인했으며 처리 중입니다.","extend":{"members":[{"uuid":"acnt_example","type":"@"}]}}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며 댓글 UUID/객체 또는 declaration을 포함하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
비즈니스 주체/첨부 파일은 후속 알림 또는 응답 완료보다 먼저 제출될 수 있습니다. HTTP 실패가 댓글이나 알림이 없었다는 것을 의미하지는 않습니다. 공통 인증/선언 오류는 공통 오류 설명에 따라 처리되며, 루트 extend가 객체가 아니면서 null도 아닌 경우 406으로 거부됩니다. null 및 유효하지 않은 하위 구조/첨부 파일의 후속 예외는 일반적으로 500으로 통일됩니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 매개변수 구문 분석 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인하세요. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하세요. |
| 400 | ft.JsonFormatError | 요청 JSON 최상위가 객체가 아닙니다 | 일부 json 파일 형식 오류 | 댓글 매개변수 객체를 제출하세요. |
| 401 | ft.WKSPNotExistOrReleased | 담당자 또는 이번 @ 대상이 존재하며, 수신자 준비 과정에서 워크스페이스 재조회에 실패했습니다 | 워크스페이스가 존재하지 않거나 해제되었습니다 | 워크스페이스가 여전히 유효한지 확인하세요. 댓글/상위 메타데이터가 이미 제출되었을 수 있으므로 먼저 다시 읽어 중복 댓글이나 알림을 방지하세요. |
| 500 | ft.InternalServerError | 데이터베이스, 기존 JSON, 첨부 파일 또는 알림 준비 등의 처리되지 않은 예외입니다. 응답 구성/Resolved 동기화가 제출 후 실패해도 500이 발생할 수 있습니다 | 내부 오류 | 먼저 상세 정보, 댓글 및 작업 기록을 읽어 실제 상태를 확인하세요. 이미 저장되었거나 알림이 발송되었을 수 있으므로 무작정 재시도하지 마세요. traceId를 보관해 위치를 파악하세요. |