답글 수정¶
POST /api/v1/issue/reply/{reply_uuid}/modify
개요¶
현재 API 호출 주체가 생성한 일반 답글 하나를 수정합니다.
호출 전 및 사용 단계¶
답글 목록에서 답글 uuid를 선택하고 해당 issueUUID도 함께 제출합니다. 서버는 현재 호출 주체가 답글 creator와 같아야 합니다. API Key를 변경하면 더 이상 작성자 조건을 충족하지 않을 수 있습니다. content를 생략하면 기존 값이 유지되며, extend는 반드시 제출해야 하고 객체 단위로 교체되므로 유지해야 할 정보는 먼저 복사하세요. 기존 생성자 표시 정보는 서버에서 유지합니다. 채널 참조는 계속 추가 병합됩니다. 첨부 파일을 새로 추가해야 할 때는 먼저 업로드한 다음 attachmentUuids를 전달하여 바인딩합니다. 생략하거나 []를 전달해도 기존 첨부 파일은 삭제되지 않습니다. 유효하지 않거나 더 이상 사용할 수 없는 첨부 파일은 내부 오류를 일으킬 수 있으므로 전송 전에 식별자가 유효한지 확인하세요. API 성공이 알림 전달을 의미하지는 않습니다. 알림은 비동기로 실행되며, 수신자는 채널 구독, 알림 대상, 알림 정책, 담당자 및 이번 @ 멤버에 따라 달라집니다. 콘솔에서 알림 설정과 실제 전달 여부를 확인하세요. 쓰기와 후속 알림, 첨부 파일 처리는 단계적으로 수행되므로 실패하거나 시간 초과된 후에는 먼저 리소스가 생성 또는 업데이트되었는지 조회한 다음 재시도 여부를 결정하여 중복 기록과 알림을 방지하세요.
라우트 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| reply_uuid | string | Y | 단일 답글 UUID이며 Issue UUID를 사용하지 마세요. 예: repim_example가져오기 또는 입력 방법: 답글 목록의 content.data[].uuid 또는 답글 생성의 content.uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| attachmentUuids[*] | json | 업로드된 단일 첨부 파일 UUID입니다. 예: att_example가져오기 또는 입력 방법: 첨부 파일 업로드의 content.attachmentUuid에서 가져옵니다. |
|
| extend.text | json | 선택적 일반 텍스트로, 서버 길이 검사에 사용되며 최대 3000자입니다. 예: 定位生产接口延迟。가져오기 또는 입력 방법: 설명에서 일반 텍스트를 추출하여 3000자 이내로 유지합니다. 생략하면 빈 텍스트로 검사합니다. |
|
| extend.channels | array | 채널 참조 배열입니다. 기존에 바인딩된 채널에 추가 병합되며, []는 기존 바인딩을 비우지 않습니다. 예: [{"type": "#", "uuid": "chan_example", "name": "生产异常"}]가져오기 또는 입력 방법: 채널 목록에서 실제 채널 UUID를 가져와 설명의 # 채널을 참조합니다. 생략하면 추가하지 않습니다. |
|
| extend.channels[*] | json | 채널 참조 객체입니다. 예: {"type": "#", "uuid": "chan_example", "name": "生产异常"}가져오기 또는 입력 방법: 각 항목에서 동일 워크스페이스의 실제 채널 하나를 선택합니다. |
|
| extend.channels[*].uuid | json | 채널 UUID입니다. 예: chan_example가져오기 또는 입력 방법: 채널 목록의 content[].uuid에서 가져옵니다. |
|
| extend.channels[*].name | json | 클라이언트 표시 이름입니다. 예: 生产异常가져오기 또는 입력 방법: 채널 목록에서 해당 name을 가져와 표시에 사용합니다. 생략할 수 있습니다. |
|
| extend.channels[*].type | json | 채널 참조 마커입니다. 예: #가져오기 또는 입력 방법: 채널 참조는 고정적으로 #을 사용하며, 서버에서 읽은 결과에 이 마커가 추가됩니다. |
|
| extend.channels[*].exists | json | 선택적 표시 마커이며 서버의 리소스 검증을 대체하지 않습니다. 예: true가져오기 또는 입력 방법: 유효성 자격 증명으로 전달할 필요가 없습니다. 조회 응답에서는 현재 리소스 존재 여부에 따라 다시 계산됩니다. |
|
| extend.members | array | 이번 @ 멤버 참조로, 일회성 알림 이메일을 수집하는 데 사용됩니다. 담당자 배열이 아닙니다. 예: [{"type": "@", "uuid": "acnt_example", "name": "值班工程师"}]가져오기 또는 입력 방법: 대상 워크스페이스의 멤버 관리에서 계정 UUID를 가져옵니다. 생략하면 이번 @ 멤버를 추가하지 않습니다. |
|
| extend.members[*] | json | 멤버 참조 객체입니다. 예: {"type": "@", "uuid": "acnt_example", "name": "值班工程师"}가져오기 또는 입력 방법: @가 필요한 각 계정에 대해 객체를 작성합니다. |
|
| extend.members[*].uuid | json | 멤버 계정 UUID입니다. 예: acnt_example가져오기 또는 입력 방법: 대상 워크스페이스의 멤버 관리에서 acnt_ 계정 UUID를 가져옵니다. |
|
| extend.members[*].name | json | 클라이언트 표시 이름입니다. 예: 值班工程师가져오기 또는 입력 방법: 멤버 표시 이름을 사용합니다. 생략할 수 있습니다. |
|
| extend.members[*].type | json | 멤버 참조 마커입니다. 예: @가져오기 또는 입력 방법: 멤버 참조에는 @를 사용합니다. |
|
| extend.members[*].exists | json | 선택적 표시 마커입니다. 예: true가져오기 또는 입력 방법: 유효성 자격 증명으로 전달할 필요가 없으며, 조회 시 다시 계산됩니다. |
|
| extend.extra | json | 외부 표시 정보이며 API의 실제 인증/작성자 ID를 대체하지 않습니다. 예: {}가져오기 또는 입력 방법: 서드파티 연동에서 외부 작업자를 표시해야 할 때 작성합니다. 없으면 생략하거나 {}를 전달합니다. |
|
| extend.extra.creator | json | 생성자 표시 객체입니다. 예: {"name": "外部工单创建人", "email": "xxx@guance.com"}가져오기 또는 입력 방법: 연동 시스템의 생성자에서 가져옵니다. 수정 시 기존 creator는 일반적으로 서버에서 유지됩니다. |
|
| extend.extra.creator.name | json | 표시 이름이며 생략할 수 있습니다. 예: 外部工单创建人가져오기 또는 입력 방법: 외부 시스템의 표시 이름을 가져옵니다. |
|
| extend.extra.creator.email | json | 표시 이메일이며 생략할 수 있습니다. 예: xxx@guance.com가져오기 또는 입력 방법: 외부 시스템 이메일을 가져옵니다. 예시는 가상의 주소입니다. |
|
| extend.extra.updator | json | 수정자 표시 객체입니다. 예: {"name": "外部工单更新人", "email": "xxx@guance.com"}가져오기 또는 입력 방법: 수정 시 연동 시스템의 이번 작업자 정보를 가져옵니다. |
|
| extend.extra.updator.name | json | 표시 이름이며 생략할 수 있습니다. 예: 外部工单更新人가져오기 또는 입력 방법: 외부 시스템의 표시 이름을 가져옵니다. |
|
| extend.extra.updator.email | json | 표시 이메일이며 생략할 수 있습니다. 예: xxx@guance.com가져오기 또는 입력 방법: 외부 시스템 이메일을 가져옵니다. |
|
| attachmentUuids | array | 선택적 업로드된 첨부 파일 UUID 배열입니다. 비어 있지 않으면 이 답글에 바인딩하거나 다시 바인딩합니다. 생략하거나 []를 전달해도 기존 첨부 파일은 삭제되지 않습니다. null 허용: True 예: []가져오기 또는 입력 방법: 먼저 첨부 파일 업로드를 호출하고 content.attachmentUuid를 저장합니다. 이 워크스페이스에서 실제로 업로드되었고 사용 가능한 첨부 파일만 사용할 수 있습니다. 생략하거나 []를 전달하면 첨부 파일을 새로 추가하지 않습니다. |
|
| content | string | 선택적 새 답글 내용입니다. 생략하면 기존 내용이 유지되며, 빈 문자열을 전달하면 내용을 비웁니다. 빈 문자열 허용: True null 허용: True 예: 已定位到数据库慢查询,正在优化。가져오기 또는 입력 방법: 처리 진행 상황을 작성합니다. 첨부 파일만 있는 답글은 생략하거나 빈 문자열을 전달할 수 있습니다. |
|
| extend | json | Y | 필수 확장 객체이며 null을 전달하지 마세요. 객체를 전달하면 저장된 확장 내용이 교체됩니다. 일부 생성자 표시 정보는 서버에서 유지됩니다. null 허용: True 예: {}가져오기 또는 입력 방법: 확장 내용이 없으면 {}를 전달합니다. 수정 전에 먼저 원래 값을 읽고, 전체 객체에서 변경할 필드를 조정합니다. |
| issueUUID | string | Y | 답글이 속한 Issue UUID이며 필수입니다. null 허용: False 예: issue_example가져오기 또는 입력 방법: Issue 목록 또는 Issue 상세에서 uuid를 가져옵니다. |
파라미터 추가 설명¶
issueUUID는 답글이 속한 Issue와 일치해야 합니다. 외부 extend.extra.updator는 표시만 제어하며 작성자 검증을 우회하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/reply/repim_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"issueUUID":"issue_example","content":"已完成慢查询优化,持续观察。","extend":{}}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 레코드 번호입니다. Issue/답글 생성 응답이 영속화 전에 구성되는 경우 null일 수 있으므로, 리소스 작업에는 uuid를 사용하세요. |
| content.uuid | string | 리소스 UUID입니다. |
| content.workspaceUUID | string | 속한 워크스페이스 UUID입니다. |
| content.status | integer | 레코드 상태입니다. 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태 statusType과 구분합니다. |
| content.creator | string | 생성 호출 주체로, API Key 식별자, 계정 또는 시스템 ID일 수 있습니다. |
| content.updator | string | 최근 업데이트 주체이며, 설정되지 않은 경우 빈 문자열입니다. |
| content.createAt | integer | 생성 시간, Unix 초입니다. |
| content.updateAt | integer | 최근 업데이트 시간, Unix 초입니다. 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다. |
| content.issueUUID | string | 속한 Issue UUID입니다. |
| content.content | string 또는 null | 답글 또는 작업 기록의 내용입니다. |
| content.type | string | reply는 일반 답글, change는 작업 기록, eventReply는 연결된 이벤트 답글, autoDiscoveryReply는 자동 발견 답글입니다. |
| content.extend | object | 확장 내용입니다. 요청에는 객체 {}를 전달하고 null을 전달하지 마세요. 멤버, 채널 및 담당자 등의 구조는 파라미터 표를 참조하세요. |
| content.extend.text | string | 길이 검사에 사용되는 일반 텍스트이며 최대 3000자입니다. |
| content.extend.channels | array<object> |
설명에서 참조된 채널이며 uuid, name, type, exists를 포함합니다. 반환 시 exists는 현재 리소스 존재 여부에 따라 갱신됩니다. |
| content.extend.channels[].uuid | string | 채널 UUID입니다. |
| content.extend.channels[].name | string 또는 null | 표시 이름입니다. |
| content.extend.channels[].type | string | 채널 참조 마커 #입니다. |
| content.extend.channels[].exists | boolean | 반환 시 해당 채널의 존재 여부입니다. |
| content.extend.members | array<object> |
설명에서 @된 멤버 참조이며 uuid, name, type, exists를 포함합니다. |
| content.extend.members[].uuid | string | 멤버 계정 UUID입니다. |
| content.extend.members[].name | string 또는 null | 표시 이름입니다. |
| content.extend.members[].type | string | 멤버 참조 마커 @입니다. |
| content.extend.members[].exists | boolean | 반환 시 해당 계정의 존재 여부입니다. |
| content.extend.extra | object | 서드파티 연동 표시 정보이며 API의 실제 인증 ID를 변경하지 않습니다. |
| content.extend.extra.creator | object | 서드파티 생성자 표시 정보이며 name, email을 포함할 수 있습니다. |
| content.extend.extra.creator.name | string | 생성자 표시 이름입니다. |
| content.extend.extra.creator.email | string | 생성자 표시 이메일입니다. |
| content.extend.extra.updator | object | 서드파티 수정자 표시 정보이며 name, email을 포함할 수 있습니다. |
| content.extend.extra.updator.name | string | 수정자 표시 이름입니다. |
| content.extend.extra.updator.email | string | 수정자 표시 이메일입니다. |
| content.extend.extra.managerInfos | object | 담당자 이메일을 키로 하는 표시 정보 매핑이며 Issue에서만 사용됩니다. |
| content.extend.extra.managerInfos.이메일.name | string | 해당 이메일 담당자의 표시 이름입니다. |
| content.extend.기타 필드 | JSON | 클라이언트가 저장한 기타 확장 정보입니다. 모두 비즈니스 동작을 트리거한다는 의미는 아닙니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언이며 content의 이 계층에만 추가됩니다. |
{
"code": 200,
"content": {
"id": 301,
"uuid": "repim_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"issueUUID": "issue_example",
"content": "已完成慢查询优化,持续观察。",
"type": "reply",
"extend": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인하세요. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하세요. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | JSON 객체를 제출하세요. |
| 404 | ft.ObjectNotExists | 지정한 리소스가 현재 워크스페이스에 없거나 조회 조건을 충족하지 않음 | 지정한 객체가 존재하지 않음 | 동일 워크스페이스의 리소스 UUID를 다시 가져오고, 이미 삭제되었는지 확인하세요. |
| 400 | ft.IssueReplyNotModify | 현재 호출 주체가 해당 답글의 생성자가 아님 | 해당 답글의 생성자가 아니므로 편집할 수 없습니다 | 답글 생성 시 사용한 것과 동일한 호출 주체를 사용하거나, 권한이 있는 작업자가 비즈니스 프로세스에 따라 처리하세요. |
| 406 | ft.ExceedMaxLengthLimit | extend.text 길이가 3000자를 초과함 | 텍스트 최대 길이 제한 초과 | 일반 텍스트 필드를 줄이고, 대량의 진단 자료는 첨부 파일로 업로드하세요. |
| 500 | ft.InternalServerError | 등급 또는 설정 저장, 감사 또는 기타 내부 처리 실패 | 내부 오류 | 먼저 현재 등급 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하세요. 계속 실패하면 traceId를 제공하세요. |