Get Generated Email Documents List
get
/rest/v16/emailGenerator
This operation retrieves all Email Designer Templates
Request
Query Parameters
-
expand: string
Return the child resource in addition to just links to the child resource. The value is a comma deliminated string and each token is a child resource name.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Email Generators
Type:
object
Title:
Show Source
Email Generators
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Email Generator
Title:
Email Generator
Nested Schema : Email Generator
Type:
object
Title:
Show Source
Email Generator
-
id:
integer
Title:
id
The generated Email document identifier -
languageCode:
integer
The language integer value to specify the template language. To identify integer values, refer to the Supported Languages section in the CPQ Administration Online Help > Language Support topic.
-
links:
string
Title:
Links
Link to generated Email document. -
processVarname:
string
Title:
Process Varname
The Commerce Process variable name -
templateName:
string
Title:
Template Name
The Email Designer template name -
transactionId:
integer
Title:
Transaction ID
Commerce Transaction Id. However, this property will not have any data in the response.
Examples
The following example shows how to access all email generators 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
Response Body Sample
The following example shows the contents of the response body in JSON format
{ "items": [{ "id": "5606997", "languageCode": null, "transactionId": null, "processVarname": null, "templateName": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator/5606997" }] }, { "id": "5606999", "languageCode": null, "transactionId": null, "processVarname": null, "templateName": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator/5606999" }] }, { "id": "5607001", "languageCode": null, "transactionId": null, "processVarname": null, "templateName": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator/5607001" }] }, { "id": "5607028", "languageCode": null, "transactionId": null, "processVarname": null, "templateName": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator/5607028" }] }, { "id": "5607106", "languageCode": null, "transactionId": null, "processVarname": null, "templateName": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator/5607106" }] }], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/emailGenerator" }] }