댓글 목록¶
GET /api/v1/error_track/comment/{issue_id}/list
개요¶
오류 댓글, 시스템 댓글 및 첨부파일 요약을 페이지 단위로 조회합니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackQuery 권한이 필요하며, 현재 워크스페이스에서만 사용할 수 있습니다. 경로에는 실제 텔레메트리 issue_id를 사용합니다. 상위 오류의 존재 여부를 먼저 강제로 검증하지 않으며, []는 레코드가 없음을 나타낼 수 있으므로 이를 근거로 텔레메트리 또는 메타데이터가 존재하지 않는다고 판단해서는 안 됩니다.
createAt 기준 내림차순으로 정렬되며 기본 페이지당 10건입니다. 동일한 초에 생성된 레코드에는 안정적인 2차 정렬이 없습니다. 활동 댓글에는 수동 댓글과 시스템 상태/담당자 변경 댓글이 포함됩니다. creatorInfo/updatorInfo는 실제 주체에서 가져오며 extend에서 표시 신원을 위조하지 않습니다. 첨부파일에는 uuid/fileName/fileSuffix만 포함됩니다.
content는 {data,declaration} 객체를 유지하고 pageInfo는 응답 최상위에 있습니다. data 항목에는 공통 선언이 자동으로 추가되지 않습니다. 이 조회는 댓글을 작성하지 않고, 첨부파일을 바인딩하지 않으며, 알림을 전송하지 않습니다. 과거 extend=null/구조 손상으로 인해 500이 발생할 수 있으므로 traceId를 보관하여 이전 기록을 확인하세요.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| issue_id | string | Y | 오류 집계 비즈니스 식별자이며 그대로 전달합니다. refData.uuid(isset_) 또는 댓글 UUID가 아닙니다. 경로는 URL 인코딩으로 처리됩니다. 상세 API로 텔레메트리 존재 여부를 검증하지 마세요. null 허용: False 예: err_payment_timeout가져오기 또는 입력 방법: 오류 추적 목록에서 content.data[].issue_id를 가져오거나, 현재 워크스페이스 오류 센터 텔레메트리 레코드의 issue_id를 사용합니다. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageIndex | integer | 선택적 정수이며 생략 시 1입니다. 현재 이 ErrorTrack 진입점들은 양수/최대 제한을 선언하지 않았으므로 클라이언트는 양의 정수만 사용해야 합니다. null 허용: False 예: 1가져오기 또는 입력 방법: 호출자가 페이지 처리를 제어하며 1부터 시작합니다. |
|
| pageSize | integer | 선택적 정수이며 생략 시 10입니다. 선언된 상한은 없으므로 작은 페이지로 조회하는 것을 권장하며, 0/음수를 전달하여 구현 동작에 의존해서는 안 됩니다. null 허용: False 예: 10가져오기 또는 입력 방법: 호출자가 표시/일괄 처리 규모에 따라 선택합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/error_track/comment/err_payment_timeout/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 페이지 내용 객체입니다. |
| content.data | array<object> |
이 페이지의 레코드이며 일치 항목이 없으면 []입니다. |
| content.data[].id | integer 또는 null | 데이터베이스 행 ID이며 경로 위치 지정에는 사용하지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.data[].uuid | string | 로컬 리소스 UUID입니다. 상세 메타데이터는 isset_, 작업 기록은 issetoper_, 댓글은 issetcomment_입니다. |
| content.data[].status | integer | 리소스 상태이며 일반적으로 0입니다. 소프트 삭제 상태 3은 조회에서 제외됩니다. |
| content.data[].creator | string | 생성 주체입니다. 자동 초기화 메타데이터는 sys이며, Key로 기록된 주체는 wsak_입니다. |
| content.data[].updator | string | 최근 업데이트 주체이며 업데이트되지 않은 경우 비어 있을 수 있습니다. |
| content.data[].createAt | integer | Unix 초 단위 생성 시간입니다. |
| content.data[].updateAt | integer | Unix 초 단위 업데이트 시간이며 업데이트되지 않은 경우 -1일 수 있습니다. 동일 값으로 상태/담당자를 업데이트해도 반드시 갱신되지는 않습니다. |
| content.data[].deleteAt | integer | Unix 초 단위 삭제 시간이며 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.data[].workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.data[].issueUUID | string | 로컬 메타데이터 isset_ UUID이며 경로 issue_id로 사용할 수 없습니다. |
| content.data[].issueID | string | 텔레메트리 issue_id 비즈니스 식별자입니다. |
| content.data[].comment | string | 댓글 본문 또는 현지화된 시스템 변경 문구입니다. |
| content.data[].extend | object 또는 null | 시스템 작업 확장 또는 일반 댓글 비즈니스 확장입니다. 과거의 비정상 값은 조회 시 500을 유발할 수 있습니다. |
| content.data[].extend.operate_type | string | 시스템 작업 유형: assigner_update 또는 status_update입니다. 일반 댓글에는 없을 수 있습니다. |
| content.data[].extend.operator | string | 시스템 작업 주체 UUID입니다. |
| content.data[].extend.before | string 또는 array<string> |
status_update인 경우 이전 상태 문자열이고, assigner_update인 경우 이전 담당자 배열입니다. |
| content.data[].extend.after | string 또는 array<string> |
status_update인 경우 새 상태 문자열이고, assigner_update인 경우 새 담당자 배열입니다. |
| content.data[].extend.operator_info | object | 선택적 작업 주체 요약이며 일치 항목이 없으면 {}입니다. |
| content.data[].extend.before_info | array<object> |
assigner_update의 이전 담당자에 대해 확인 가능한 요약이며, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info | array<object> |
assigner_update의 새 담당자에 대해 확인 가능한 요약입니다. |
| content.data[].extend.operator_info.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.status | integer | 주체 상태입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.username | string | 로그인 이름 또는 Key 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.name | string | 표시 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.iconUrl | string | 프로필 이미지 URL이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 전송 가능성은 보장되지 않습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.operator_info.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].status | integer | 주체 상태입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].username | string | 로그인 이름 또는 Key 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].name | string | 표시 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].iconUrl | string | 프로필 이미지 URL이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 전송 가능성은 보장되지 않습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.before_info[].acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].status | integer | 주체 상태입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].username | string | 로그인 이름 또는 Key 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].name | string | 표시 이름입니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].iconUrl | string | 프로필 이미지 URL이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 전송 가능성은 보장되지 않습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.after_info[].acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. 계정 필드는 생략될 수 있고, 팀은 uuid/name만 포함합니다. |
| content.data[].extend.members | array<object> |
이번 편집의 선택적 @ 대상 목록이며 항상 객체 배열로 유지하는 것을 권장합니다. |
| content.data[].extend.members[].uuid | string | @ 대상 주체 UUID입니다. 현재 워크스페이스 멤버/팀 목록에서 유효한 acnt_/group_을 가져오는 것을 권장합니다. |
| content.data[].extend.members[].type | string | 값이 @이고 uuid가 비어 있지 않은 항목만 알림에 참여합니다. |
| content.data[].extend.사용자 정의 키 | JSON | 호출자가 저장한 기타 JSON 확장이며 고정된 실행 의미는 없습니다. |
| content.data[].attachments | array<object> |
해당 댓글에 바인딩된 유효한 첨부파일 요약이며 다운로드 URL/파일 내용은 포함하지 않습니다. 첨부파일이 없으면 []입니다. |
| content.data[].attachments[].uuid | string | 첨부파일 UUID이며 권한이 부여된 첨부파일 조회/관리에 사용됩니다. |
| content.data[].attachments[].fileName | string | 파일 이름입니다. |
| content.data[].attachments[].fileSuffix | string | 마지막 점 이후의 확장자입니다. 점이 없으면 전체 이름일 수 있습니다. |
| content.data[].creatorInfo | object | 주체 요약이며 일치 항목이 없으면 {}입니다. 시스템 주체는 필드가 적을 수 있습니다. |
| content.data[].creatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].creatorInfo.status | integer | 주체 상태입니다. |
| content.data[].creatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. |
| content.data[].creatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].creatorInfo.name | string | 표시 이름입니다. |
| content.data[].creatorInfo.iconUrl | string | 프로필 이미지 URL이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 전송 가능성은 보장되지 않습니다. |
| content.data[].creatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.data[].creatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo | object | 주체 요약이며 일치 항목이 없으면 {}입니다. 시스템 주체는 필드가 적을 수 있습니다. |
| content.data[].updatorInfo.uuid | string | 주체 UUID이며 계정, Key 또는 시스템 식별자일 수 있습니다. |
| content.data[].updatorInfo.status | integer | 주체 상태입니다. |
| content.data[].updatorInfo.wsAccountStatus | integer | 현재 워크스페이스 멤버 관계 상태 요약입니다. |
| content.data[].updatorInfo.username | string | 로그인 이름 또는 Key 이름입니다. |
| content.data[].updatorInfo.name | string | 표시 이름입니다. |
| content.data[].updatorInfo.iconUrl | string | 프로필 이미지 URL이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.email | string | 이메일입니다. Key 주체는 자체 UUID일 수 있으며 전송 가능성은 보장되지 않습니다. |
| content.data[].updatorInfo.mobile | string | 휴대폰 번호이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.countryCode | string | 전화 국가 코드이며 비어 있을 수 있습니다. |
| content.data[].updatorInfo.acntWsNickname | string | 현재 워크스페이스 닉네임이며 비어 있을 수 있습니다. |
| pageInfo | object | 페이지 메타 정보이며 OpenAPI에서는 최상위에 있습니다. content는 객체를 유지합니다. |
| pageInfo.count | integer | 이 페이지의 실제 건수입니다. |
| pageInfo.totalCount | integer | 필터를 만족하는 후보/로컬 레코드의 총수입니다. 텔레메트리 목록은 후보 10,000개 상한이 적용됩니다. |
| pageInfo.pageIndex | integer | 페이지 번호이며 1부터 시작합니다. |
| pageInfo.pageSize | integer | 이번 요청의 페이지당 요청 수입니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공통 선언입니다. content 상위 객체에만 추가되며 data 항목에는 재귀적으로 추가되지 않습니다. |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "issetcomment_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"issueUUID": "isset_example",
"issueID": "err_payment_timeout",
"comment": "已定位超时原因,正在处理。",
"extend": {
"members": [
{
"uuid": "acnt_example",
"type": "@"
}
]
},
"attachments": [],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 10
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반한 경우 | 파라미터 구문 분석 실패 | Query 파라미터 표와 예시를 확인하세요. |
| 500 | ft.InternalServerError | 데이터베이스 조회, 과거 JSON 구조 또는 연관 요약 생성 중 처리되지 않은 예외가 발생한 경우 | 내부 오류 | traceId를 보관하고 백오프하세요. 계속 실패하면 관리자가 관련 이전 기록과 설정을 확인해야 합니다. |