search
API Reference싸인투게더

문서 목록 조회

circle-info

apikey 정보를 이용하는 사용자가 생성한 document 목록을 조회합니다.

document가 포함된 폴더 정보를 포함하기 때문에 중복 데이터가 있을 수 있습니다. search 파라미터에 문서 이름, 폴더 이름, 문서 진행 상태, 원본 템플릿 아이디를라파미터로 전달할 수 있습니다. 페이징을 지원하며 페이지 크기, 원하는 페이지를 파라미터로 전달할 수 있습니다. 옵션에 따라서 해당 그룹에 속한 document 전체를 조회할 수도 있습니다. 파라미터에 따라 중복이 제거된 결과를 받을 수도 있습니다.

hashtag
진행상태, 폴더이름, 문서이름으로 조회하여 페이징 처리된 결과값을 리턴

GET rest/api/documents

hashtag
Headers

Name
Type
Description

apikey*

String

발급된 api key

hashtag
Query Parameters

Name
Type
Description

search

String

전달가능한 파라미터

✔️템플릿 이름 (name) ✔️폴더 이름 (folderName)

✔️문서 진행상태 (status) 기본값: completed - wating : 상대 서명 대기중

- waitForMe : 내서명 대기중

- complate : 문서 완료

- refused : 거절 (참여자)

- canceled : 취소(생성자)

- expired : 서명일 만료 ✔️원본 템플릿ID (templateId)

searchAll

boolean

그룹 내 모든 일반 템플릿에서 조회

기본값 : false

removeDuplicates

boolean

중복된 값 제거 기본값 : false

hashtag
Response Example

{
    "pagination": {
        "page": 1,
        "pageSize": 10,
        "totalCount": 100,
        "totalPages": 10
    },
    "data": [
        {
            "id": 1,
            "name": "샘플 계약 001",
            "creator": "김함께",
            "modifier": "박수정",
            "createDate": "2024-01-01T00:00:00",
            "modifyDate": "2024-01-01T15:00:00",
            "contractorCnt": 1,
            "referenceCnt": 0,
            "folderId": 2,
            "folderName": "기본",
            "status": "Completed",
            "contractor": "김서명",
            "tagData": "#샘플#예제"
        },
        ...
    ]
}

Previous문서Next문서 상세 조회

Last updated