getTemplateExportRequestList
    • PDF

    getTemplateExportRequestList

    • PDF

    Article summary

    Available in Classic and VPC

    Get a list of requests to create a backup file of your email templates.

    Request

    The following describes the request format for the endpoint. The request format is as follows:

    MethodURI
    GET/template/export

    Request headers

    For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

    Request query parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    sizeIntegerOptionalNumber of records per page
    • 10 (default)
    pageIntegerOptionalPage index to view
    • 0 or greater
    sortStringOptionalSort by
    • createUtc (default)| sid | statusCode
      • createUtc: request creation date and time
      • sid: request SID
      • statusCode: request status
    • property (,asc|desc) format
      • asc (default)
    • Multiple sort criteria can be set

    Request example

    The following is a sample request.

    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}'
    

    Response

    The following describes the response format.

    Response body

    The following describes the response body.

    FieldTypeRequiredDescription
    contentList<TemplateExportRequestResponse>OptionalDetails for the request history list
    totalElementsIntegerRequiredTotal number of records
    lastBooleanRequiredIt indicates whether this is the last page
    totalPagesIntegerRequiredTotal number of pages
    sizeIntegerRequiredNumber of records per page
    numberIntegerRequiredIndex of the current page
    • 0 or greater
    sortList<Sort>RequiredSort by
    firstBooleanRequiredIt indicates whether this is the first page
    numberOfElementsIntegerRequiredNumber of records in the current page

    Response status codes

    The following describes the response status codes.

    HTTP status codeCodeDescription
    200-Request succeeded
    400-Authentication failed, invalid request
    40077101Error in login information
    40077102Request error
    40077103Requested resource does not exist
    40377201No permissions to the requested resource
    40377202Call from a user who hasn't subscribed to the email service
    40577001Unsupported method type
    41577002Unsupported media type
    500-Server error
    50077301Default project does not exist
    50077302External system API integration error
    50077303Other internal server error

    Response example

    The following is a sample response.

    {
      "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
    }
    

    Was this article helpful?

    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.