リクエスト

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

メソッド	URI
GET	-

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`currentPage`	Integer	Required	現在のページ番号
`pageSize`	Integer	Required	ページごとの用語集出力数最大値: 30

リクエスト例

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

curl --location --request GET 'https://papago.apigw.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	-	用語集 ID
`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
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Papago Translation