用語集リストの照会
    • PDF

    用語集リストの照会

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    GET-

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    currentPageIntegerRequired現在のページ番号
    pageSizeIntegerRequiredページごとの用語集出力数
    • 最大値: 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}'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    dataArray-用語集リスト照会の詳細情報
    currentPageString-現在のページ番号
    totalPageInteger-総ページ番号
    currentGlossaryCountInteger-現在のページ内の用語集数
    totalGlossaryCountInteger-用語集の総数

    data

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

    フィールドタイプ必須の有無説明
    glossaryKeyString-用語集 ID
    glossaryNameString-用語集名
    wordCountInteger-用語集の総用語数
    descriptionString-用語集の詳細説明
    createdDateTimeInteger-用語集の作成日時(Timestamp)
    updatedDateTimeInteger-用語集の最終更新日時(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
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.