search
API Reference싸인투게더

템플릿 목록 조회

circle-info

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

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

hashtag
템플릿 이름, 폴더 이름으로 조회하여 페이징 처리된 결과값을 리턴

GET /rest/api/templates

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

hashtag
Headers

Name
Type
Description

apikey*

String

발급된 api key

hashtag
Query Parameters

Name
Type
Description

search

전달가능한 파라미터

✔️템플릿 이름 (name) ✔️폴더 이름 (folderName) Example : sample=name:계약+folerName:기본 (+ 구분자는 url 인코딩 필요)

searchAll

boolean

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

기본값 : false

removeDuplicates

boolean

중복된 값 제거 기본값 : false

hashtag
Response Example

{
    "pagination": {
        "page": 1,
        "pageSize": 10,
        "totalCount": 50,
        "totalPages": 5
    },
    "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": "기본"
        },
        ...
    ]
}

Previous템플릿 목록 조회 (전체)Next문서

Last updated