用語リストの照会

Classic/VPC環境で利用できます。

用語集(Glossary)の用語リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/glossary/v1/{glossaryKey}/replacer

リクエストヘッダ

Papago Translation APIで共通して使用されるヘッダの詳細は、Papago Translationの共通ヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`glossaryKey`	String	Required	用語集 ID 用語集リストの照会を参照
`page`	Long	Optional	ページ番号 1~N
`count`	Long	Optional	ページごとの項目数

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://papago.apigw.ntruss.com/glossary/v1/{glossaryKey}/replacer?page=1&count=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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`replacerList`	Array	-	用語集の用語リスト
`paging`	Object	-	レスポンス結果のページング情報
`paging.totalPageCount`	Long	-	ページの総数
`paging.totalItemCount`	Long	-	総項目数
`paging.page`	Long	-	現在のページ番号
`paging.count`	Long	-	ページごとの項目数

`replacerList`

replacerListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Long	-	用語 ID
`glossaryKey`	String	-	用語集 ID
`source`	String	-	ソース言語コード <例> `ko`、`en`
`target`	String	-	ターゲット言語コード <例> `ko`、`en`
`triggerText`	String	-	原文テキスト
`replaceText`	String	-	翻訳テキスト
`createdDateTime`	String	-	作成日時 yyyy-MM-dd kk:mm:ss形式
`updatedDateTime`	String	-	更新日時 yyyy-MM-dd kk:mm:ss形式

レスポンスステータスコード

Papago Translation APIで共通して使用されるレスポンスステータスコードの詳細は、Papago Translationの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "replacerList": [
        {
            "id": 12345,
            "glossaryKey": "7f3c2a91-8b5e-4d7b-9e32-1c0f4e7e59ad",
            "source": "ko",
            "target": "en",
            "triggerText": "テスト用語",
            "replaceText": "Test Term",
            "createdDateTime": "2025-01-24 10:30:00",
            "updatedDateTime": "2025-01-24 10:30:00"
        }
    ],
    "paging": {
        "totalPageCount": 5,
        "totalItemCount": 100,
        "page": 1,
        "count": 20
    }
}