RTE Template REST APIs

Get a List of Templates for an RTE Attribute
Description	This REST API endpoint with the Commerce process variable name, document variable name, and RTE variable name query parameters can be used to retrieve a user-specific list of templates for the specified RTE attribute.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates?q={$and:[{'processVarName':'yourProcessVarName'},{'documentVarName':'yourMainDocumentVarName'},{'attributeVarName':'RTEattributeVarName'}}
Endpoint Parameters	q	The following query parameters are required to retrieve a user-specific list of templates. Replace the italisized text with the applicable variable names from your site. {'processVarName':'yourProcessVarName'} {'documentVarName':'yourMainDocumentVarName'} {'attributeVarName':'yourRTEattributeVarName'} This endpoint supports query specifications that follow Oracle CPQ query and pagination parameters syntax. Query specifications follow a subset of MongoDB syntax and can be used to organize or narrow return data. For more information, see Manage Collections.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains the list of templates for the queried RTE attribute.

URI Endpoint Sample

Sample Response Body

Get an RTE Template
Description	Use this endpoint to retrieve the content of a user's saved RTE Template for the specified template Id.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates/{id}
Endpoint Parameters	id	The RTE template Id
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains the contents of the specified RTE template.

URI Endpoint Sample

Sample Response Body

Create an RTE Template
Description	Use this endpoint to create an RTE Template for the specified RTE attribute. The Commerce process variable name, document variable name, RTE attribute variable name, and content are specified in the request body.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	processVarName	The variable name of the parent Commerce process.
	documentVarName	The variable name of the parent main or sub-document.
	attributeVarName	The variable name of the parent RTE attribute.
	name	Name of the RTE template.
	content	Rich Text snippet.
Response Body Parameters	The response contains information and contents for the created RTE template.

URI Endpoint Sample

Request Sample

Response Sample

{ "name": "MyNewTemplate", "id": 3022555768, "processVarName": "oraclecpqo", "documentVarName": "transaction", "attributeVarName": "coverLetter_t", "content": "this is a <span style=\"font-size: 18pt;\">RTE</span> entry\n<div><strong><em>Ill </em></strong>try <span style=\"color: #00ff00;\">to</span> create a <span style=\"color: #ff0000;\">template</span></div>\n<div>and now I'm modifiing it \n<div> </div>\n</div>" "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates/3022555768" } ] }

Delete an RTE Template
Description	Use this endpoint to delete the specified RTE Template.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates/{Id}
Endpoint Parameters	Id	The RTE template Id
HTTP Method	DELETE
Request Body Parameters	None
Response Body Parameters	None
Success Response HTTP 200 OK	Success Response HTTP 200 OK

URI Endpoint Sample

https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates/3022555768

Rename an RTE Template
Description	Use this endpoint to rename the specified RTE Template. The new template name is specified in the request body.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates/{Id}
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	name	The new name of the RTE template.
Response Body Parameters	The response contains information and contents for the renamed RTE template.

URI Endpoint Sample

Request Sample

Response Sample

{ "name": "MyNewTemplateRenamed", "id": 3022555768, "processVarName": "oraclecpqo", "documentVarName": "transaction", "attributeVarName": "coverLetter_t", "content": "this is a <span style=\"font-size: 18pt;\">RTE</span> entry\n<div><strong><em>Ill </em></strong>try <span style=\"color: #00ff00;\">to</span> create a <span style=\"color: #ff0000;\">template</span></div>\n<div>and now I'm modifiing it \n<div> </div>\n</div>" "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates/3022555768" } ] }

Create, Rename, or Delete Multiple RTE Templates
Description	Use this endpoint to rename or delete multiple RTE templates. The desired action and the applicable information are specified in the request body. For rename requests, the new name and template Id are required. For delete requests, the template Id is required.
URI Endpoint	/rest/v17/commerceAttrRichTextTemplates/actions/synchronize
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	_client_driven_action	When "true", this boolean paramenter directs the executor to look for individual _sync_action in the documents items _sync_action parameter.
	documents	A collection of templates to be created, deleted, or renamed; each entry can be accompanied by _sync_action property with possible values [create|update|delete] to denote the desired operation.
Response Body Parameters	The response contains information and contents for the renamed RTE template.

URI Endpoint Sample

Request Sample

Response Sample

{ "documents": { "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates" } ], "items": [{ "_sync_status": "updated", "attributeVarName": "coverLetter_t", "processVarName": "oraclecpqo", "documentVarName": "transaction", "name": "sync5_1", "dateModified": "2021-06-30T17:22:00.954Z", "id": 3022596693, "dateAdded": "2021-06-29T01:30:32.000Z", "content": "synce1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates/3022596693" } ] }, { "_sync_status": "created", "attributeVarName": "functionDefaultRTE", "processVarName": "transaction_bmClone_2", "documentVarName": "quote", "name": "sync11", "dateModified": "2021-06-30T17:22:11.262Z", "id": 3022597224, "dateAdded": "2021-06-30T17:22:11.262Z", "content": "sync111", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/commerceAttrRichTextTemplates/3022597224" } ] } ] } }