문서 목록 조회
Last updated
Last updated
모두싸인에서 문서 목록을 조회합니다.
조회할 문서 상태 필터링
전체 : 전체 문서를 조회합니다 (기본값)
관련 리소스 생성 중 : 생성중인 서명 문서만을 조회합니다.
관련 리소스 생성 실패 : 생성 실패한 서명 문서만을 조회합니다.
서명/열람 진행중 : 서명문서 생성이 성공되었고 서명 진행중인 문서만을 조회합니다.
서명/열람 취소 또는 거절 : 서명문서 생성이 성공하였으나 서명 또는 열람요청이 거절된 문서만을 조회합니다.
서명 완료 : 서명 완료가 된 문서만을 조회합니다.
작성 중 : 임시로 작성중 상태인 문서만을 조회합니다.
문서 제목 검색어 : 특정 단어가 포함된 제목의 문서만을 조회합니다. (선택)
문서 생성일 기준일 설정 : 문서 생성일 기준으로 검색하실 수 있습니다. (선택)
문서 생성일 기준점 설정 : 문서 생성일 기준일 설정시에만 동작합니다.
문서 생성일 기준 이후 : 생성일 기준 이후의 모든 문서를 조회합니다.
문서 생성일 기준 이전 : 생성일 기준 이전의 모든 문서를 조회합니다.
문서 요청일 기준일 설정 : 문서 요청일 기준으로 검색하실 수 있습니다. (선택)
문서 요청일 기준점 설정 : 문서 요청일 기준일 설정시에만 동작합니다.
문서 요청일 기준 이후 : 요청일 기준 이후의 모든 문서를 조회합니다.
문서 요청일 기준 이전 : 요청일 기준 이전의 모든 문서를 조회합니다.
마지막 활동일 기준일 설정 : 문서의 마지막 활동일 기준으로 검색하실 수 있습니다. (선택)
마지막 활동일 기준점 설정 : 문서의 마지막 활동일 설정시에만 동작합니다.
마지막 활동일 기준 이후 : 마지막 활동일 기준 이후의 모든 문서를 조회합니다.
마지막 활동일 기준 이전 : 마지막 활동일 기준 이전의 모든 문서를 조회합니다.
메타데이터 필터 : 메타데이터가 포함된 문서 기준으로 조회 가능하며 JSON 형태로 입력하셔야 합니다. (선택)
정렬대상 선택 : 데이터 조회시 정렬대상을 선택합니다.
문서 생성일 (기본값)
마지막 활동일
문서 제목
정렬순서 선택 : 정렬 대상에 대한 정렬 순서를 선택합니다.
내림차순 (기본값)
오름차순
| 데이터 값 | 데이터 내용 |
|---|---|
id | 문서 ID |
title | 문서 제목 |
status | 문서 상태 - DRAFT : 작성 중 - SCHEDULED : 전송 예약 중 - ON_GOING : 서명/열람 진행중 - ON_PROCESSING : 문서 처리 중 - PROCESSING_FAILED : 문서 처리 실패 - ABORTED : 서명 / 열람 중단 - COMPLETED : 모든 서명/열람 완료 |
requester_name | 문서 요청자 이름 |
requester_email | 문서 요청자 이메일 |
participants_[N]_id | 참여자 ID |
participants_[N]_type | 참여자 타입 |
participants_[N]_name | 참여자 이름 |
participants_[N]_signingOrder | 참여자의 참여 순서 |
participants_[N]_signingDue_valid | 참여자의 참여 가능 여부 |
participants_[N]_signingDue_datetime | 참여자의 참여 유효일 |
participants_[N]_signingMethod_type | 참여자의 참여 수단 종류 - EMAIL : 이메일 - KAKAO : 카카오톡 - SECURE_LINK : 보안 링크 - IN_PERSON : 대면 |
participants_[N]_signingMethod_value | 참여 수단 값 |
participants_[N]_locale | 참여자가 사용할 언어 |
currentSigningOrder | 서명 참여 순서 |
accessibleByParticipant | 문서 중단시 요청자 외의 참여자들의 문서 파일 접근 가능 여부 |
abort_type | 문서 중단 사유 - REJECTION : 거절됨 - SIGNING_CANCELLATION : 참여 취소됨 - REQUEST_CANCELLATION : 요청 취소됨 |
abort_message | 문서 중단 사유 |
abort_abortedAt | 문서 중단 시점 |
abort_participantId | 문서 거절 또는 참여 취소한 참여자 ID |
labels_[N]_id | 라벨 ID |
labels_[N]_name | 라벨 이름 |
file_downloadUrl | 문서 PDF 다운로드 링크 - 조회시간 기준 10분 이내 유효 |
auditTrail_downloadUrl | 감사추적인증서 파일 다운로드 링크 - 조회시간 기준 10분 이내 유효 |
signings_[N]_participantId | 서명/열람 완료된 참여자 ID |
signings_[N]_signedAt | 서명/열람 시간 |
조회 가능 데이터에서 [N] 으로 표기된 항목은 조회되는 수만큼 필드가 추가됩니다.
ex) 총 2명의 참여자 정보가 있는 필드는 participants_1_id, participants_2_id 로 나눠집니다.
