용어집 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

용어집(Glossary) 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	-

요청 헤더

Papago Translation API에서 공통으로 사용하는 헤더에 대한 정보는 Papago Translation 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`currentPage`	Integer	Required	현재 페이지 번호
`pageSize`	Integer	Required	페이지당 용어집 출력 개수 최대 값: 30

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://papago.apigw.gov-ntruss.com/glossary/v1/
?currentPage=1
&pageSize=20' \
--header 'x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}' \
--header 'x-ncp-iam-access-key: {x-ncp-iam-access-key}' \
--header 'x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`data`	Array	-	용어집 목록 조회 상세 정보
`currentPage`	String	-	현재 페이지 번호
`totalPage`	Integer	-	전체 페이지 개수
`currentGlossaryCount`	Integer	-	현재 페이지 내 용어집 개수
`totalGlossaryCount`	Integer	-	전체 용어집 개수

`data`

data에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`glossaryKey`	String	-	용어집 아이디
`glossaryName`	String	-	용어집 이름
`wordCount`	Integer	-	용어집 내 총 용어 수
`description`	String	-	용어집 상세 설명
`createdDateTime`	Integer	-	용어집 생성 일시(Timestamp)
`updatedDateTime`	Integer	-	용어집 최종 업데이트 일시(Timestamp)

응답 상태 코드

Papago Translation API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Papago Translation 공통 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "data": [
        {
            "glossaryKey": "{glossaryKey}",
            "glossaryName": "GlossaryTest1",
            "wordCount": 6,
            "description": "GlossaryTest1 용어집 설명입니다.",
            "createdDateTime": 1724209126000,
            "updatedDateTime": 1724216780000
        }
    ],
    "currentPage": 1,
    "totalPage": 1,
    "currentGlossaryCount": 1,
    "totalGlossaryCount": 1
}