getTemplateExportRequestList
- 印刷する
- PDF
getTemplateExportRequestList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
メールテンプレートのバックアップファイルの作成をリクエストした履歴リストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /template/export |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
size | Integer | Optional | ページごとのレコード数
|
page | Integer | Optional | 照会対象のページインデックス
|
sort | String | Optional | ソート基準
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
content | List<TemplateExportRequestResponse> | Optional | リクエスト内訳リストの詳細 |
totalElements | Integer | Required | 総レコード数 |
last | Boolean | Required | 最後のページであるか否か |
totalPages | Integer | Required | 総ページ数 |
size | Integer | Required | ページごとのレコード数 |
number | Integer | Required | 現在ページのインデックス
|
sort | List<Sort> | Required | ソート基準 |
first | Boolean | Required | 最初のページなのか否か |
numberOfElements | Integer | Required | 現在ページのレコード数 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
HTTPステータスコード | コード | 説明 |
---|---|---|
200 | - | リクエスト成功 |
400 | - | 認証失敗、無効なリクエスト |
400 | 77101 | ログイン情報エラー |
400 | 77102 | リクエストエラー |
400 | 77103 | リクエストしたリソースが存在しない |
403 | 77201 | リクエストしたリソースに対する権限がない |
403 | 77202 | メールサービスの使用を申し込んでいないユーザーが呼び出した場合 |
405 | 77001 | サポートしないメソッドタイプ |
415 | 77002 | サポートしないメディアタイプ |
500 | - | サーバエラー |
500 | 77301 | 基本プロジェクトが存在しない |
500 | 77302 | 外部システム API連携エラー |
500 | 77303 | その他の内部サーバエラー |
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"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
}
この記事は役に立ちましたか?