REST API Services for Oracle CPQ

Get Generated Email Document

get

/rest/v16/emailGenerator/{id}

This operation retrieves the generated html email document for a given Transaction.

Request

Path Parameters

id(required): integer

The generated Email document Id

Response

Supported Media Types

application/json

Default Response

Root Schema : Email Document

Type: object

Title: Email Document

Show Source

body: string

Title: Email Body

Body of the email which contatins the generated email document
subject: string

Title: Email Subject

Subject of the email

{
    "type":"object",
    "title":"Email Document",
    "properties":{
        "body":{
            "type":"string",
            "description":"Body of the email which contatins the generated email document",
            "title":"Email Body"
        },
        "subject":{
            "type":"string",
            "description":"Subject of the email",
            "title":"Email Subject"
        }
    }
}

Examples

The following example shows how to access an email generator by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/emailGenerator/5607028

Example of Response Body

The following example shows the contents of the response body in JSON format, including the Email Designer email:

 {
   "subject": "Pending Approval Notification for Quote  2018-1213 ",
   "body": "<html xmlns:PrintUtil=\"com.bm.xchange.services.templateengine.utils.TePrintUtil\" 
   xmlns:axf=\"https://www.antennahouse.com/names/XSL/Extensions\" 
   xmlns:HeadingUtil=\"com.bm.xchange.services.templateengine.headingstyle.TeHeadingStyleUtil\" 
   xmlns:xhtml=\"https://www.w3.org/1999/xhtml\" 
   xmlns:DateUtil=\"com.bm.xchange.util.DateUtil\" 
   xmlns:version=\"1.0\" xmlns:fo=\"https://www.w3.org/1999/XSL/Format\">\n
   <body style=\"font-family:Helvetica; font-size:12pt; color:#000000; text-align:left;
   line-height:100%; font-weight:normal; font-style:normal; text-decoration:none;\">\n
   <div style=\"margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px;\">\n
   <div>Super User has submitted quote 2015-1213 for your review.</div>\n\n
   <div> </div>\n\n<div>Please respond to this email with the word 
   <strong><span style=\"color: #008000;\">Approve </span></strong>or 
   <strong><span style=\"color: #ff0000;\">Reject</span> </strong>in the first line.</div>\n\n
   <div>Add any comments you may have on the second line.</div>\n\n
   <div> </div>\n\n
   <div>Requester's Comment:</div>\n\n
   <div>  </div>\n\n
   <div> </div>\n\n
   <div>\n<span style=\"text-decoration: underline;\"><strong>Quote Information:</strong></span>\n
   </div>\n\n
   <div>  Total Quote Margin: $15,060.00  </div>\n\n
   <div>  Total Quote Margin: 78.62 </div>\n\n
   <div>  Total Quote Discount: $0.00 </div>\n\n
   <div>  Total Contract Value: $19,155.00 
   </div>\n\n
   <div> </div>\n\n
   <div>Alternatively you can use the link below to review the transaction.</div>\n\n
   <div>Direct Link:  https://sitename.oracle.com/commerce/buyside/document.jsp?formaction=performAction&document_id=4653823&action_id=4654396&version_id=5095445&bs_id=5531903 </div>\n</div>\n</body>\n</html>\n"
}