콘텐츠로 이동

Reply 목록



GET /api/v1/issue/reply/{issue_uuid}/list

개요

Issue의 일반 Reply, 작업 기록 및 연관 이벤트 Reply를 페이지 단위로 조회합니다.

호출 전 준비 및 사용 단계

Issue 상세에서 Issue uuid를 가져옵니다. pageIndex는 기본값 1, pageSize는 기본값 10입니다. ordering에는 -createAt을 전달하여 생성 시간 기준 내림차순으로 정렬할 수 있으며, 생략하면 명시적 정렬을 지정하지 않습니다. content.data 배열과 최상위 pageInfo를 읽습니다. 레코드 type이 반드시 reply인 것은 아니므로 type에 따라 수동 콘텐츠와 시스템 작업을 구분하세요. 첨부 파일은 각 항목의 attachmentsList에 있습니다. 작업은 현재 API Key가 속한 워크스페이스를 사용합니다. 동일한 워크스페이스에서 리소스 식별자를 가져오세요.

라우트 파라미터

파라미터 이름 유형 필수 설명
issue_uuid string Y 현재 워크스페이스의 Issue UUID.
예: issue_example
가져오기 또는 입력 방법: Issue 목록의 content.data[].uuid 또는 Issue 생성 응답의 content.uuid에서 가져옵니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
ordering string 정렬 필드이며, 접두사 -는 내림차순, 접두사 없음은 오름차순입니다. Reply 레코드의 실제 필드만 사용하세요. 잘못된 필드는 내부 오류를 발생시킬 수 있습니다. 생략하면 명시적 정렬을 지정하지 않습니다.
null 허용: False
예: -createAt
가져오기 또는 입력 방법: createAt 또는 -createAt 사용을 권장합니다. 여러 필드는 쉼표로 구분합니다(예: -createAt,uuid).
pageIndex integer 페이지 번호, 기본값 1, 양의 정수를 사용합니다.
null 허용: False
예: 1
가져오기 또는 입력 방법: 첫 페이지는 1부터 시작하여 페이지마다 증가시킵니다.
pageSize integer 페이지당 항목 수, 기본값 10.
null 허용: False
예: 10
가져오기 또는 입력 방법: 필요에 따라 적절한 양의 정수를 선택합니다.

파라미터 추가 설명

존재하지 않거나 Reply가 없는 Issue는 빈 배열을 반환할 수 있으므로, 이 API로 Issue 존재 여부를 검증하지 마세요. 먼저 Issue 상세를 조회하여 대상을 확인하세요.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/issue/reply/issue_example/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode ordering=-createAt \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.data array<object> 현재 페이지의 Reply이며, 결과가 없으면 []입니다.
content.data[].id integer 또는 null 레코드 번호입니다. Issue/Reply 생성 응답은 영속화 전에 구성되는 경우 null일 수 있으므로, 리소스 작업에는 uuid를 사용하세요.
content.data[].uuid string 리소스 UUID.
content.data[].workspaceUUID string 소속 워크스페이스 UUID.
content.data[].status integer 레코드 상태이며 0은 정상, 3은 삭제됨입니다. Issue 비즈니스 상태 statusType과 구분하세요.
content.data[].creator string 생성 호출 주체이며 API Key 식별자, 계정 또는 시스템 주체일 수 있습니다.
content.data[].updator string 최근 업데이트 주체이며, 설정되지 않은 경우 빈 문자열입니다.
content.data[].createAt integer 생성 시간, Unix 초.
content.data[].updateAt integer 최근 업데이트 시간, Unix 초이며 업데이트되지 않은 경우 -1일 수 있습니다.
content.data[].deleteAt integer 삭제 시간, Unix 초이며 삭제되지 않은 경우 -1입니다.
content.data[].issueUUID string 소속 Issue UUID.
content.data[].content string 또는 null Reply 또는 작업 기록의 내용입니다.
content.data[].type string reply는 일반 Reply, change는 작업 기록, eventReply는 연관 이벤트 Reply, autoDiscoveryReply는 자동 발견 Reply입니다.
content.data[].extend object 확장 내용입니다. 요청 시 null이 아닌 객체 {}를 전달해야 합니다. 멤버, 채널 및 담당자 등의 구조는 파라미터 표를 참고하세요.
content.data[].extend.text string 길이 검사에 사용하는 일반 텍스트이며 최대 3000자입니다.
content.data[].extend.channels array<object> 설명에서 참조한 채널이며 uuid, name, type, exists를 포함합니다. 반환 시 exists는 현재 리소스 존재 여부에 따라 갱신됩니다.
content.data[].extend.channels[].uuid string 채널 UUID.
content.data[].extend.channels[].name string 또는 null 표시 이름.
content.data[].extend.channels[].type string 채널 참조 표시 #입니다.
content.data[].extend.channels[].exists boolean 반환 시 해당 채널이 존재하는지 여부입니다.
content.data[].extend.members array<object> 설명에서 @로 참조한 멤버이며 uuid, name, type, exists를 포함합니다.
content.data[].extend.members[].uuid string 멤버 계정 UUID.
content.data[].extend.members[].name string 또는 null 표시 이름.
content.data[].extend.members[].type string 멤버 참조 표시 @입니다.
content.data[].extend.members[].exists boolean 반환 시 해당 계정이 존재하는지 여부입니다.
content.data[].extend.extra object 서드파티 연동 표시 정보이며 API의 실제 인증 주체를 변경하지 않습니다.
content.data[].extend.extra.creator object 서드파티 생성자 표시 정보이며 name, email을 포함할 수 있습니다.
content.data[].extend.extra.creator.name string 생성자 표시 이름.
content.data[].extend.extra.creator.email string 생성자 표시 이메일.
content.data[].extend.extra.updator object 서드파티 업데이트한 사람의 표시 정보이며 name, email을 포함할 수 있습니다.
content.data[].extend.extra.updator.name string 업데이트한 사람의 표시 이름.
content.data[].extend.extra.updator.email string 업데이트한 사람의 표시 이메일.
content.data[].extend.extra.managerInfos object 담당자 이메일을 키로 하는 표시 정보 매핑이며 Issue에서만 사용합니다.
content.data[].extend.extra.managerInfos.邮箱.name string 해당 이메일 담당자의 표시 이름입니다.
content.data[].extend.其他字段 JSON 클라이언트에서 저장한 기타 확장 정보이며, 모두 비즈니스 동작을 트리거한다는 의미는 아닙니다.
content.data[].creatorInfo object 생성자 표시 정보이며, 서드파티 extend.extra.creator에 값이 있으면 일부 조회 API는 해당 표시 정보를 우선 사용합니다.
content.data[].creatorInfo.name string 표시 이름이며 생략될 수 있습니다.
content.data[].creatorInfo.email string 이메일이며 생략될 수 있습니다.
content.data[].creatorInfo.uuid string 계정 UUID이며 생략될 수 있습니다.
content.data[].updatorInfo object 업데이트한 사람의 표시 정보이며 빈 객체일 수 있습니다.
content.data[].updatorInfo.name string 표시 이름이며 생략될 수 있습니다.
content.data[].updatorInfo.email string 이메일이며 생략될 수 있습니다.
content.data[].updatorInfo.uuid string 계정 UUID이며 생략될 수 있습니다.
content.data[].attachmentsList array<object> 이 Reply에 연결된 첨부 파일입니다.
content.data[].attachmentsList[].uuid string 첨부 파일 UUID.
content.data[].attachmentsList[].fileName string 원본 파일 이름.
content.data[].attachmentsList[].fileSuffix string 접미사.
content.data[].is_modify boolean createAt과 updateAt이 다른지 여부로 계산한 표시입니다. 아직 업데이트되지 않아 updateAt=-1인 경우에도 true가 될 수 있으므로, 이 값만으로 수동 편집 여부를 판단해서는 안 됩니다.
content.data[].latest_modify_time integer updateAt에 직접 대응하며 Unix 초 단위입니다. 아직 업데이트되지 않은 경우 -1일 수 있습니다.
content.declaration object 또는 null 워크스페이스 공통 선언이며 content의 이 계층에만 추가됩니다.
pageInfo object 최상위 페이지 정보.
pageInfo.pageIndex integer 현재 페이지 번호.
pageInfo.pageSize integer 이 페이지의 항목 수 상한.
pageInfo.count integer 이 페이지의 실제 항목 수.
pageInfo.totalCount integer 조건에 맞는 전체 항목 수.
content.data[].creatorInfo.status integer 계정 레코드 상태이며 생략될 수 있습니다.
content.data[].creatorInfo.wsAccountStatus integer 현재 워크스페이스의 계정 상태이며 생략될 수 있습니다.
content.data[].creatorInfo.username string 로그인 이름이며 생략될 수 있습니다.
content.data[].creatorInfo.iconUrl string 계정 아바타 URL이며 생략될 수 있습니다.
content.data[].creatorInfo.mobile string 계정 휴대폰 번호이며 비어 있거나 생략될 수 있습니다.
content.data[].creatorInfo.countryCode string 휴대폰 번호 국가/지역 코드이며 생략될 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임이며 생략될 수 있습니다.
content.data[].updatorInfo.status integer 계정 레코드 상태이며 생략될 수 있습니다.
content.data[].updatorInfo.wsAccountStatus integer 현재 워크스페이스의 계정 상태이며 생략될 수 있습니다.
content.data[].updatorInfo.username string 로그인 이름이며 생략될 수 있습니다.
content.data[].updatorInfo.iconUrl string 계정 아바타 URL이며 생략될 수 있습니다.
content.data[].updatorInfo.mobile string 계정 휴대폰 번호이며 비어 있거나 생략될 수 있습니다.
content.data[].updatorInfo.countryCode string 휴대폰 번호 국가/지역 코드이며 생략될 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임이며 생략될 수 있습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 301,
        "uuid": "repim_example",
        "workspaceUUID": "wksp_example",
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785430800,
        "updateAt": -1,
        "deleteAt": -1,
        "issueUUID": "issue_example",
        "content": "데이터베이스 슬로우 쿼리를 확인했으며 최적화 중입니다.",
        "type": "reply",
        "extend": {},
        "creatorInfo": {},
        "updatorInfo": {},
        "attachmentsList": [],
        "is_modify": true,
        "latest_modify_time": -1
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요.
500 ft.InternalServerError 레벨 또는 설정 저장, 감사 또는 기타 내부 처리 실패 내부 오류 먼저 현재 레벨 또는 설정을 읽어 결과를 확인한 후 재시도 여부를 결정하세요. 계속 실패하면 traceId를 제공하세요.

문서 평가

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