Jump to

• Request
• Response
• Examples

Create an RTE Template

post

/rest/v19/commerceAttrRichTextTemplates

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.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Commerce Attribute RT Templates

Type: object

Title: Commerce Attribute RT Templates

Show Source

• attributeVarName: string
  Title: Attribute Variable Name

  Variable Name of owner Attribute
• content: string
  Title: Contente

  Actual Reach Text snippet
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• documentVarName: string
  Title: Document Variable Name

  Variable Name of owner Document
• id: integer
  Title: Id

  Primary Key of the resource
• isLegacy: boolean
  Title: Is Legacy

  Whether the template is legacy
• name: string
  Title: Name

  Name of the Template
• processVarName: string
  Title: Process Variable Name

  Variable Name of owner Process

{
    "type":"object",
    "properties":{
        "attributeVarName":{
            "type":"string",
            "description":"Variable Name of owner Attribute",
            "title":"Attribute Variable Name"
        },
        "content":{
            "type":"string",
            "description":"Actual Reach Text snippet",
            "title":"Contente"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "documentVarName":{
            "type":"string",
            "description":"Variable Name of owner Document",
            "title":"Document Variable Name"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "isLegacy":{
            "type":"boolean",
            "description":"Whether the template is legacy",
            "title":"Is Legacy"
        },
        "name":{
            "type":"string",
            "description":"Name of the Template",
            "title":"Name"
        },
        "processVarName":{
            "type":"string",
            "description":"Variable Name of owner Process",
            "title":"Process Variable Name"
        }
    },
    "title":"Commerce Attribute RT Templates"
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Commerce Attribute RT Templates

Type: object

Title: Commerce Attribute RT Templates

Show Source

• attributeVarName: string
  Title: Attribute Variable Name

  Variable Name of owner Attribute
• bsId: integer
  Title: BS Id

  the transaction id
• content: string
  Title: Contente

  Actual Reach Text snippet
• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• docNum: integer
  Title: Document Number

  the document Number
• documentVarName: string
  Title: Document Variable Name

  Variable Name of owner Document
• id: integer
  Title: Id

  Primary Key of the resource
• isLegacy: boolean
  Title: Is Legacy

  Whether the template is legacy
• name: string
  Title: Name

  Name of the Template
• processVarName: string
  Title: Process Variable Name

  Variable Name of owner Process

{
    "type":"object",
    "properties":{
        "attributeVarName":{
            "type":"string",
            "description":"Variable Name of owner Attribute",
            "title":"Attribute Variable Name"
        },
        "bsId":{
            "type":"integer",
            "description":"the transaction id",
            "title":"BS Id"
        },
        "content":{
            "type":"string",
            "description":"Actual Reach Text snippet",
            "title":"Contente"
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "docNum":{
            "type":"integer",
            "description":"the document Number",
            "title":"Document Number"
        },
        "documentVarName":{
            "type":"string",
            "description":"Variable Name of owner Document",
            "title":"Document Variable Name"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the resource",
            "title":"Id"
        },
        "isLegacy":{
            "type":"boolean",
            "description":"Whether the template is legacy",
            "title":"Is Legacy"
        },
        "name":{
            "type":"string",
            "description":"Name of the Template",
            "title":"Name"
        },
        "processVarName":{
            "type":"string",
            "description":"Variable Name of owner Process",
            "title":"Process Variable Name"
        }
    },
    "title":"Commerce Attribute RT Templates"
}

Back to Top

Examples

The following example shows how to operation creates a new user by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/commerceAttrRichTextTemplates

Request Body Sample

{
  "processVarName": "oraclecpqo",
  "documentVarName": "transaction",
  "attributeVarName": "coverLetter_t",
  "name": "MyNewTemplate",
  "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>"
}

Response Body 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/v19/commerceAttrRichTextTemplates/3022555768"
    }
  ]
}

Back to Top