getTemplateExportRequestList
    • PDF

    getTemplateExportRequestList

    • PDF

    記事の要約

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

    メールテンプレートのバックアップファイルの作成をリクエストした履歴リストを照会します。

    リクエスト

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

    メソッドURI
    GET/template/export

    リクエストヘッダ

    Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

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

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

    フィールドタイプ必須の有無説明
    sizeIntegerOptionalページごとのレコード数
    • 10 (デフォルト)
    pageIntegerOptional照会対象のページインデックス
    • 0以上
    sortStringOptionalソート基準
    • createUtc (デフォルト) | sid | statusCode
      • createUtc: リクエスト作成日時
      • sid: リクエスト SID
      • statusCode: リクエスト状態
    • property(,asc|desc)形式
      • asc (デフォルト)
    • 複数のソート基準を設定可能

    リクエスト例

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

    curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/template/export
    ?size=5
    &page=0'
    --header 'x-ncp-apigw-timestamp: {Timestamp}'
    --header 'x-ncp-iam-access-key: {Access Key}'
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    contentList<TemplateExportRequestResponse>Optionalリクエスト内訳リストの詳細
    totalElementsIntegerRequired総レコード数
    lastBooleanRequired最後のページであるか否か
    totalPagesIntegerRequired総ページ数
    sizeIntegerRequiredページごとのレコード数
    numberIntegerRequired現在ページのインデックス
    • 0以上
    sortList<Sort>Requiredソート基準
    firstBooleanRequired最初のページなのか否か
    numberOfElementsIntegerRequired現在ページのレコード数

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

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコード説明
    200-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

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

    {
      "content": [
        {
          "sid": 1,
          "projectSid": 270294,
          "requestUtc": {
            "utc": 1576655804261,
            "formattedDate": "2019-12-18",
            "formattedDateTime": "2019-12-18 16:56:44 261"
          },
          "completeUtc": {
            "utc": 1578383178834,
            "formattedDate": "2020-01-07",
            "formattedDateTime": "2020-01-07 16:46:18 834"
          },
          "elapsedTime": "479:49:34.573",
          "statusCode": {
            "label": "Expire",
            "code": "E"
          },
          "downloadUrl": "http://localhost:7070/v1/email/templates/export/1"
        },
        {
          "sid": 11,
          "projectSid": 270294,
          "requestUtc": {
            "utc": 1589369165996,
            "formattedDate": "2020-05-13",
            "formattedDateTime": "2020-05-13 20:26:05 996"
          },
          "completeUtc": {
            "utc": 1589369224517,
            "formattedDate": "2020-05-13",
            "formattedDateTime": "2020-05-13 20:27:04 517"
          },
          "elapsedTime": "00:00:58.521",
          "statusCode": {
            "label": "Complete",
            "code": "C"
          },
          "downloadUrl": "http://localhost:7070/v1/email/templates/export/11"
        }
      ],
      "totalElements": 2,
      "last": true,
      "totalPages": 1,
      "size": 5,
      "number": 0,
      "sort": [
        {
          "direction": "DESC",
          "property": "createUtc",
          "ignoreCase": false,
          "nullHandling": "NATIVE",
          "ascending": false,
          "descending": true
        }
      ],
      "first": true,
      "numberOfElements": 2
    }
    

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

    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.