콘텐츠로 이동

댓글 수정



POST /api/v1/error_track/comment/{comment_uuid}/modify

개요

자신이 생성한 오류 댓글을 수정하고 다시 알림을 보냅니다.

호출 전 및 사용 단계

현재 Key에는 errorCenter.errorTrackManage 권한이 필요합니다. 현재 동일 Key 리소스에서 생성한 활성 댓글만 수정할 수 있으며, 시스템 댓글이나 다른 Key에서 생성한 댓글은 편집할 수 없습니다. comment는 전체 교체됩니다. extend는 생략하면 유지되고, 값이 있으면 전체 교체되며, {}는 비웁니다. 첨부 파일 바인딩은 공유 세션에 먼저 커밋될 수 있어, 이후 실패가 발생해도 본문 롤백을 보장할 수 없습니다.

알림 대상은 기존 담당자에 이번 요청의 extend.members에서 type=@이고 uuid가 비어 있지 않은 대상을 더한 것입니다. 팀은 구성원으로 확장되며 사용 가능한 알림 방식으로 전송됩니다. 일치하는 일정이 없으면 자동으로 폴백됩니다. 수정 시에도 담당자와 이번 @ 대상에게 다시 알림이 전송됩니다. extend를 생략하면 기존 members를 사용해 다시 @하지 않지만, 담당자는 여전히 알림을 받을 수 있습니다. 일반 채널 예외는 대부분 포착되며, 200 응답이 전달을 보장하지 않습니다. 알림 준비에 실패하면 500이 발생할 수 있으며 댓글은 이미 저장되었을 수 있습니다.

extend는 객체로 전달하거나 생략하고, attachmentUUIDs는 배열로 전달하거나 생략하세요. 명시적 null은 공개 선언을 통과하지만 커밋 후 500이 발생할 수 있습니다. members 하위 구조에는 완전한 검증이 없으므로 객체 배열을 직접 구성해야 합니다. 첨부 파일 []는 바인딩을 해제하지 않으며 교체 목록과 같지 않습니다. 첨부 파일을 재사용하면 바인딩이 변경되므로 먼저 모든 UUID를 확인하세요. 실패 시 먼저 댓글/첨부 파일과 실제 알림을 다시 읽어 중복 댓글과 중복 알림을 방지하세요.

경로 파라미터

파라미터 이름 유형 필수 설명
comment_uuid string Y 현재 워크스페이스의 활성 댓글 UUID입니다. 현재 동일 Key 리소스에서 생성해야 하며, 동일 역할/동일 워크스페이스에 속한다는 이유만으로 편집할 수 있는 것은 아닙니다.
빈 문자열 허용: False
예: issetcomment_example
가져오기 또는 입력 방법: 댓글 목록에서 content.data[].uuid를 가져오며, issue_id 또는 isset_ 메타데이터 UUID를 사용할 수 없습니다.

요청 헤더

파라미터 이름 유형 필수 설명
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": "@"}]}
가져오기 또는 입력 방법: 호출자가 본문을 작성하며, 오류 센터 편집기와의 규약에 따라 표시 확장을 저장합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/error_track/comment/issetcomment_example/modify' \
  -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 object 저장된 댓글 엔터티, 첨부 파일 및 오류 유형입니다. 이 페이지에는 creatorInfo/updatorInfo가 포함되지 않습니다.
content.id integer 또는 null 데이터베이스 행 ID이며 경로 식별에 사용되지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다.
content.uuid string 로컬 리소스 UUID입니다. 상세 메타데이터는 isset_, 작업 기록은 issetoper_, 댓글은 issetcomment_입니다.
content.status integer 리소스 상태이며 일반적으로 0입니다. 소프트 삭제된 3은 조회에서 제외됩니다.
content.creator string 생성 주체입니다. 자동 초기화된 메타데이터는 sys, Key로 기록된 주체는 wsak_입니다.
content.updator string 최근 업데이트 주체이며, 업데이트되지 않은 경우 비어 있을 수 있습니다.
content.createAt integer Unix 초 단위 생성 시간입니다.
content.updateAt integer Unix 초 단위 업데이트 시간이며, 업데이트되지 않은 경우 -1일 수 있습니다. 동일 값으로 상태/담당자를 업데이트해도 갱신되지 않을 수 있습니다.
content.deleteAt integer Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다.
content.workspaceUUID string 현재 Key가 속한 워크스페이스입니다.
content.issueUUID string 로컬 메타데이터 isset_ UUID이며 경로의 issue_id로 사용할 수 없습니다.
content.issueID string 텔레메트리 issue_id 비즈니스 식별자입니다.
content.comment string 댓글 본문 또는 현지화된 시스템 변경 문구입니다.
content.extend object 또는 null 저장된 댓글 확장입니다. 새 요청에서는 객체를 사용하여 null로 인한 후속 오류를 피하세요.
content.extend.members array<object> 선택적이며 이번 편집의 @ 대상 목록입니다. 항상 객체 배열로 사용하는 것이 좋습니다.
content.extend.members[].uuid string @ 대상 주체 UUID이며, 현재 워크스페이스 구성원/팀 목록에서 유효한 acnt_/group_을 가져오는 것이 좋습니다.
content.extend.members[].type string 값이 @이고 uuid가 비어 있지 않은 항목만 알림에 참여합니다.
content.extend.사용자 지정 키 JSON 호출자가 저장한 기타 JSON 확장이며 고정된 실행 의미는 없습니다.
content.attachments array<object> 해당 댓글에 바인딩된 유효 첨부 파일 요약이며 다운로드 URL/파일 내용은 포함하지 않습니다. 첨부 파일이 없으면 []입니다.
content.attachments[].uuid string 첨부 파일 UUID이며 권한이 부여된 첨부 파일 읽기/관리에 사용됩니다.
content.attachments[].fileName string 파일 이름입니다.
content.attachments[].fileSuffix string 마지막 점 뒤의 확장자이며, 점이 없으면 전체 이름이 될 수 있습니다.
content.errorType string 상위 로컬 메타데이터 extend.errorType이며 비어 있을 수 있습니다.
content.declaration object 또는 null 현재 워크스페이스의 공개 선언입니다.
{
  "code": 200,
  "content": {
    "id": 7,
    "uuid": "issetcomment_example",
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427260,
    "deleteAt": -1,
    "workspaceUUID": "wksp_example",
    "issueUUID": "isset_example",
    "issueID": "err_payment_timeout",
    "comment": "타임아웃 원인을 확인했으며 처리 중입니다.",
    "extend": {
      "members": [
        {
          "uuid": "acnt_example",
          "type": "@"
        }
      ]
    },
    "attachments": [],
    "errorType": "js_error",
    "declaration": {}
  },
  "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 파일 형식 오류 댓글 파라미터 객체를 제출하세요.
404 ft.ObjectNotExists 현재 워크스페이스의 활성 댓글 또는 해당 로컬 상위 메타데이터가 존재하지 않습니다. 지정한 객체가 존재하지 않습니다. 현재 워크스페이스 댓글 목록을 새로 고쳐 UUID를 확인하고, 알 수 없는 객체를 반복 수정하지 마세요.
400 ft.IssueReplyNotModify 댓글 생성 주체가 현재 Key 리소스가 아닙니다. 귀하는 해당 답글의 생성자가 아니므로 편집할 수 없습니다 원래 생성 Key를 사용하거나 허용된 제품 흐름에서 처리하세요. 동일 역할의 다른 Key는 대신 수정할 수 없습니다.
401 ft.WKSPNotExistOrReleased 담당자 또는 이번 @ 대상이 있고, 수신자 준비 과정에서 워크스페이스를 다시 조회하지 못했습니다. 워크스페이스가 존재하지 않거나 이미 해제되었습니다 공간이 여전히 유효한지 확인하세요. 댓글/상위 메타데이터는 이미 커밋되었을 수 있으므로 먼저 다시 읽어 중복 댓글이나 중복 알림을 피하세요.
500 ft.InternalServerError 데이터베이스, 기존 JSON, 첨부 파일 또는 알림 준비 등에서 처리되지 않은 예외가 발생했습니다. 응답 구성/Resolved 동기화가 커밋 후 실패해도 500이 발생할 수 있습니다. 내부 오류 먼저 상세, 댓글 및 작업 기록을 읽어 실제 상태를 확인하세요. 이미 저장되었거나 알림이 전송되었을 수 있으므로 무작정 재시도하지 마세요. traceId를 보관하여 추적하세요.

문서 평가

이 페이지가 도움이 되었나요?