Jump to

• Request
• Response
• Examples

Get All RTE Templates

get

/rest/v19/commerceAttrRichTextTemplates

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.

Request

Supported Media Types

• application/json

Query Parameters

• 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.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : commerceAttrRichTextTemplates-collection

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/commerceAttrRichTextTemplates"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Commerce Attribute RT Templates
  Title: Commerce Attribute RT Templates

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

Nested 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 returns the list of accounts by submitting a GET request to the REST resource using cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://site.oracle.com/rest/v19commerceAttrRichTextTemplates?q={$and:[{'processVarName':'oraclecpqo'},{'documentVarName':'transaction'},{'attributeVarName':'coverLetter_t'}]}&fields=name,id&orderby=name

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://site.oracle.com/commerceAttrRichTextTemplates"
    }
  ],
  "items": [{
      "name": "Templ",
      "id": 3022555768,
      "links": [{
          "rel": "self",
          "href": "https://site.oracle.com/commerceAttrRichTextTemplates/3022555768"
        }
      ]
    }, {
      "name": "Temp2",
      "id": 3022555858,
      "links": [{
          "rel": "self",
          "href": "https://site.oracle.com/commerceAttrRichTextTemplates/3022555858"
        }
      ]
    }
  ]
}

Back to Top