# 문서 목록 조회

## UI 소개

{% tabs %}
{% tab title="자동화" %}

<figure><img src="https://1362923181-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5PH5ktGI0BWG6g9fvtcn%2Fuploads%2FfeNPMyZxDdCsIdif5QgR%2FScreenshot%200006-12-30%20at%203.04.02%E2%80%AFPM.png?alt=media&#x26;token=d7bee5fe-59e3-4d9f-ab09-645d1faf42a4" alt=""><figcaption></figcaption></figure>
{% endtab %}

{% tab title="데이터플로우" %}

<figure><img src="https://1362923181-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5PH5ktGI0BWG6g9fvtcn%2Fuploads%2FFBKtL79kCyJJYjh3HQvA%2FScreenshot%200006-12-30%20at%203.04.30%E2%80%AFPM.png?alt=media&#x26;token=76f5e875-9696-4b95-afa7-647d15cc548a" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

<table><thead><tr><th width="137" align="center">항목명</th><th width="292" align="center">항목소개</th><th align="center">비고</th></tr></thead><tbody><tr><td align="center">문서 상태<br>선택</td><td align="center">선택한 상태와 일치한 문서를 조회</td><td align="center"><p></p><ul><li>전체 : 전체 문서를 조회 (기본값)</li><li>관련 리소스 생성 중 : 생성중인 서명 문서만을 조회</li><li>관련 리소스 생성 실패 : 생성 실패한 서명 문서만을 조회</li><li>서명/열람 진행중 : 서명문서 생성이 성공되었고 서명 진행중인 문서만을 조회</li><li>서명/열람 취소 또는 거절 : 서명문서 생성이 성공하였으나 서명 또는 열람요청이 거절된 문서만을 조회</li><li>서명 완료 : 서명 완료가 된 문서만을 조회</li><li>작성 중 : 임시로 작성중 상태인 문서만을 조회</li></ul></td></tr><tr><td align="center">문서 제목 <br>검색어</td><td align="center">특정 단어가 포함된 제목의 문서만을 조회(선택)</td><td align="center"></td></tr><tr><td align="center">문서 생성일 기준일 설정</td><td align="center">문서 생성일 기준으로 검색 (선택) </td><td align="center"></td></tr><tr><td align="center">문서 생성일 기준점 설정</td><td align="center">문서 생성일 기준일 설정시에만 동작</td><td align="center"><ul><li>문서 생성일 기준 이후</li><li>문서 생성일 기준 이전</li></ul></td></tr><tr><td align="center">문서 요청일 기준일 설정</td><td align="center">문서 요청일 기준으로 검색 (선택) </td><td align="center"></td></tr><tr><td align="center">문서 요청일 기준점 설정</td><td align="center">문서 요청일 기준일 설정시에만 동작</td><td align="center"><ul><li>문서 요청일 기준 이전</li><li>문서 요청일 기준 이전</li></ul></td></tr><tr><td align="center">마지막 활동일 기준일 설정</td><td align="center">문서의 마지막 활동일 기준으로 검색(선택) </td><td align="center"></td></tr><tr><td align="center">마지막 활동일 기준점 설정</td><td align="center">문서의 마지막 활동일 설정시에만 동작</td><td align="center"><ul><li>마지막 활동일 기준 이후</li><li>마지막 활동일 기준 이전</li></ul></td></tr><tr><td align="center">메타데이터 필터</td><td align="center">메타데이터가 포함된 문서 기준으로 조회 (선택) </td><td align="center">JSON 형태로 입력</td></tr><tr><td align="center">정렬대상 선택</td><td align="center">데이터 조회시 정렬대상을 선택</td><td align="center"><ul><li>문서 생성일 (기본값) </li><li>마지막 활동일</li><li>문서 제목</li></ul></td></tr><tr><td align="center">정렬순서 선택</td><td align="center">정렬 대상에 대한 정렬 순서를 선택</td><td align="center"><ul><li>내림차순 (기본값) </li><li>오름차순 </li></ul></td></tr></tbody></table>

## 실행 결과&#x20;

<table><thead><tr><th width="342">데이터 값</th><th>데이터 내용</th></tr></thead><tbody><tr><td>id </td><td>문서 ID</td></tr><tr><td>title</td><td>문서 제목</td></tr><tr><td>status</td><td><p>문서 상태<br> - DRAFT : 작성 중<br> - SCHEDULED : 전송 예약 중<br> - ON_GOING : 서명/열람 진행중 </p><p> - ON_PROCESSING : 문서 처리 중 </p><p> - PROCESSING_FAILED : 문서 처리 실패</p><p> - ABORTED : 서명 / 열람 중단 </p><p> - COMPLETED : 모든 서명/열람 완료 </p></td></tr><tr><td>requester_name</td><td>문서 요청자 이름</td></tr><tr><td>requester_email</td><td>문서 요청자 이메일</td></tr><tr><td>participants_[N]_id</td><td>참여자 ID</td></tr><tr><td>participants_[N]_type</td><td>참여자 타입</td></tr><tr><td>participants_[N]_name</td><td>참여자 이름</td></tr><tr><td>participants_[N]_signingOrder</td><td>참여자의 참여 순서</td></tr><tr><td>participants_[N]_signingDue_valid</td><td>참여자의 참여 가능 여부</td></tr><tr><td>participants_[N]_signingDue_datetime</td><td>참여자의 참여 유효일</td></tr><tr><td>participants_[N]_signingMethod_type</td><td><p>참여자의 참여 수단 종류 </p><p>  - EMAIL : 이메일 <br>  - KAKAO : 카카오톡 </p><p>  - SECURE_LINK : 보안 링크 </p><p>  - IN_PERSON : 대면 </p></td></tr><tr><td>participants_[N]_signingMethod_value</td><td>참여 수단 값</td></tr><tr><td>participants_[N]_locale</td><td>참여자가 사용할 언어</td></tr><tr><td>currentSigningOrder</td><td>서명 참여 순서</td></tr><tr><td>accessibleByParticipant</td><td>문서 중단시 요청자 외의 참여자들의 문서 파일 접근 가능 여부</td></tr><tr><td>abort_type</td><td><p>문서 중단 사유 </p><p> - REJECTION : 거절됨 </p><p> - SIGNING_CANCELLATION : 참여 취소됨 </p><p> - REQUEST_CANCELLATION : 요청 취소됨</p></td></tr><tr><td>abort_message</td><td>문서 중단 사유</td></tr><tr><td>abort_abortedAt</td><td>문서 중단 시점</td></tr><tr><td>abort_participantId</td><td>문서 거절 또는 참여 취소한 참여자 ID</td></tr><tr><td>labels_[N]_id</td><td>라벨 ID</td></tr><tr><td>labels_[N]_name</td><td>라벨 이름</td></tr><tr><td>file_downloadUrl</td><td>문서 PDF 다운로드 링크<br>  - 조회시간 기준 10분 이내 유효</td></tr><tr><td>auditTrail_downloadUrl</td><td><p>감사추적인증서 파일 다운로드 링크</p><p> - 조회시간 기준 10분 이내 유효</p></td></tr><tr><td>signings_[N]_participantId</td><td>서명/열람 완료된 참여자 ID</td></tr><tr><td>signings_[N]_signedAt</td><td>서명/열람 시간</td></tr></tbody></table>

{% hint style="info" %}
조회 가능 데이터에서 \[N] 으로 표기된 항목은 조회되는 수만큼 필드가 추가됩니다.&#x20;

ex) 총 2명의 참여자 정보가 있는 필드는 participants\_1\_id, participants\_2\_id 로 나눠집니다.&#x20;
{% endhint %}