Jump to

• Request
• Response
• Examples

Email - Generate Transaction Email

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/_action_process_email_print

Use this endpoint to retrieve the objects required to send a transaction email.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-EmailPrintRequest

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• criteria: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• delta: boolean
  Title: Delta

  The boolean parameter to request a delta response for data as well as state in the context of current criteria.
• langAttributeValue: integer
  Title: Language Attribute Value

  Language attribute value for the print document
• languagePreference: string
  Title: Language Attribute Value

  Language attribute value for the print document
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.

{
    "type":"object",
    "properties":{
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "delta":{
            "type":"boolean",
            "description":"The boolean parameter to request a delta response for data as well as state in the context of current criteria.",
            "title":"Delta"
        },
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "languagePreference":{
            "type":"string",
            "description":"Language attribute value for the print document",
            "title":"Language Attribute Value"
        },
        "langAttributeValue":{
            "type":"integer",
            "description":"Language attribute value for the print document",
            "title":"Language Attribute Value"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        }
    }
}

Nested Schema : Query Definition

Type: object

Title: Query Definition

Captures the query definition for the current resource request.

Show Source

• actions: array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs: array childDefs
• expand: array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomains: array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• fields: array fields
  Array of field names that you wanted returned in a request.
• state: boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

Nested Schema : actions

Type: array

Array of actions names, whose state is requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : childDefs

Type: array

Show Source

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

Nested Schema : expand

Type: array

Array of child resource names that you want to expand so that the contents return with the parent in the same request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : expandedDomains

Type: array

Array of field names, whose expanded domains are requested in the state object response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

Nested Schema : fields

Type: array

Array of field names that you wanted returned in a request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : Child query criteria.

Type: object

Title: Child query criteria.

Captures the query criteria for the child resource.

Show Source

• name: string
  Rest alias name of the child resource this query belongs to.
• queryDef: object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive: boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-EmailPrintResponse

Type: object

Show Source

• attachments: array Attachments available
  Title: Attachments available

  List of attachments available for email action.
• availableAttachmentsForMerge: array Attachments available for merge.
  Title: Attachments available for merge.

  List of attachments available to merge for an email or print action.
• bccEmail: string
  Title: Bcc Email

  The bcc email address(es)
• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• ccEmail: string
  Title: Cc Email

  The cc email address(es)
• comments: string
  Title: Comments

  The comments to be sent in the email body
• fromEmail: string
  Title: From Email

  The sender's email address
• fromName: string
  Title: From Name

  The sender's name
• generatedProposalAttachmentForMerge: array Attachments Selected by Default.
  Title: Attachments Selected by Default.

  Default selected attachment for an email or print action.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• subject: string
  Title: Subject

  The email subject line
• toEmail: string
  Title: To Email

  The recipient's email address(es)
• toName: string
  Title: To Name

  The recipient's name
• warnings: object warnings
  Title: warnings

  warning messages
• xslViews: array XslViews
  Title: XslViews

  Captures the array of XslViews available in Process Action

{
    "type":"object",
    "properties":{
        "comments":{
            "type":"string",
            "description":"The comments to be sent in the email body",
            "title":"Comments"
        },
        "attachments":{
            "$ref":"#/definitions/attachments"
        },
        "ccEmail":{
            "type":"string",
            "description":"The cc email address(es)",
            "title":"Cc Email"
        },
        "availableAttachmentsForMerge":{
            "$ref":"#/definitions/availableAttachmentsForMerge"
        },
        "subject":{
            "type":"string",
            "description":"The email subject line",
            "title":"Subject"
        },
        "warnings":{
            "$ref":"#/definitions/warnings"
        },
        "fromEmail":{
            "type":"string",
            "description":"The sender's email address",
            "title":"From Email"
        },
        "xslViews":{
            "$ref":"#/definitions/xslViews"
        },
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "bccEmail":{
            "type":"string",
            "description":"The bcc email address(es)",
            "title":"Bcc Email"
        },
        "generatedProposalAttachmentForMerge":{
            "$ref":"#/definitions/generatedProposalAttachmentForMerge"
        },
        "toName":{
            "type":"string",
            "description":"The recipient's name",
            "title":"To Name"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.",
            "title":"Cache Instance Id"
        },
        "fromName":{
            "type":"string",
            "description":"The sender's name",
            "title":"From Name"
        },
        "toEmail":{
            "type":"string",
            "description":"The recipient's email address(es)",
            "title":"To Email"
        }
    }
}

Nested Schema : Attachments available

Type: array

Title: Attachments available

List of attachments available for email action.

Show Source

• Array of: object Attachment properties
  Title: Attachment properties

  Captures the id and name of the attachment

{
    "title":"Attachments available",
    "type":"array",
    "description":"List of attachments available for email action.",
    "items":{
        "$ref":"#/definitions/attachmentDef"
    }
}

Nested Schema : Attachments available for merge.

Type: array

Title: Attachments available for merge.

List of attachments available to merge for an email or print action.

Show Source

• Array of: object Attachment properties
  Title: Attachment properties

  Captures the id and name of the attachment

{
    "title":"Attachments available for merge.",
    "type":"array",
    "description":"List of attachments available to merge for an email or print action.",
    "items":{
        "$ref":"#/definitions/attachmentDef"
    }
}

Nested Schema : Attachments Selected by Default.

Type: array

Title: Attachments Selected by Default.

Default selected attachment for an email or print action.

Show Source

• Array of: object Attachment properties
  Title: Attachment properties

  Captures the id and name of the attachment

{
    "title":"Attachments Selected by Default.",
    "type":"array",
    "description":"Default selected attachment for an email or print action.",
    "items":{
        "$ref":"#/definitions/attachmentDef"
    }
}

Nested Schema : warnings

Type: object

Title: warnings

warning messages

Show Source

• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.

{
    "type":"object",
    "properties":{
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"warning message."
            }
        }
    },
    "title":"warnings",
    "description":"warning messages"
}

Nested Schema : XslViews

Type: array

Title: XslViews

Captures the array of XslViews available in Process Action

Show Source

• Array of: object XslViewDef
  Title: XslViewDef

  Captures the XslView available in Process Action

{
    "title":"XslViews",
    "type":"array",
    "description":"Captures the array of XslViews available in Process Action",
    "items":{
        "$ref":"#/definitions/xslViewDef"
    }
}

Nested Schema : Attachment properties

Type: object

Title: Attachment properties

Captures the id and name of the attachment

Show Source

• id: integer
  ID for the attachment.
• name: string
  Name for the attachment.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the attachment."
        },
        "name":{
            "type":"string",
            "description":"Name for the attachment."
        }
    },
    "title":"Attachment properties",
    "description":"Captures the id and name of the attachment"
}

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  warning message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"warning message."
    }
}

Nested Schema : XslViewDef

Type: object

Title: XslViewDef

Captures the XslView available in Process Action

Show Source

• id: integer
  ID for the attachment.
• isMergeAttachmentSupported: string
  Is Merge Attachment supported for given XslView
• name: string
  Name for the attachment.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the attachment."
        },
        "name":{
            "type":"string",
            "description":"Name for the attachment."
        },
        "isMergeAttachmentSupported":{
            "type":"string",
            "description":"Is Merge Attachment supported for given XslView"
        }
    },
    "title":"XslViewDef",
    "description":"Captures the XslView available in Process Action"
}

Back to Top

Examples

The following example shows how to retrieve the objects required to send a transaction email by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/commerceDocumentsOraclecpqoTransaction/18498612/actions/_action_process_email_print

Response Body Sample

{
  "comments": "",
  "attachments": null,
  "ccEmail": "",
  "availableAttachmentsForMerge": [{
      "id": 3023140360,
      "name": "Attachment 1.pdf (Transaction - attachment 1)"
    }
  ],
  "subject": "",
  "warnings": {},
  "fromEmail": "[e-mail]",
  "xslViews": [{
      "id": 3023140083,
      "name": "english tempalte pdf output(Printer Friendly/History)",
      "isMergeAttachmentSupported": true
    }, {
      "id": 3023140134,
      "name": "English Document DOCX Ouput(Printer Friendly/History)",
      "isMergeAttachmentSupported": false
    }
  ],
  "revisionId": "46,0",
  "bccEmail": "",
  "generatedProposalAttachmentForMerge": [{
      "id": -2,
      "name": "GENERATED PROPOSAL"
    }
  ],
  "toName": null,
  "fromName": null,
  "toEmail": ""
}

Back to Top