Jump to

• Request
• Response
• Examples

Update RTE Templates

post

/rest/v19/commerceAttrRichTextTemplates/actions/synchronize

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.

Request

Supported Media Types

• application/json

Body ()

Root Schema : commerceAttrRichTextTemplates-synchronizeCollectionRequest

Type: object

Show Source

• _client_driven_action: boolean
  Title: Client Driven Action

  Directs executor to look for individual _sync_action hints in array entries of documents.items parameter; _sync_action hint has a form of additional property and can have following values: create, update, or delete
• documents: object commerceAttrRichTextTemplates-collection

{
    "type":"object",
    "properties":{
        "_client_driven_action":{
            "type":"boolean",
            "description":"Directs executor to look for individual _sync_action hints in array entries of documents.items parameter; _sync_action hint has a form of additional property and can have following values: create, update, or delete",
            "title":"Client Driven Action"
        },
        "documents":{
            "description":"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 disambiguous desired operation",
            "title":"Documents",
            "$ref":"#/definitions/commerceAttrRichTextTemplates-collection"
        }
    }
}

Nested 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

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : commerceAttrRichTextTemplates-synchronizeCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to srename or delete multiple RTE templates 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" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceAttrRichTextTemplates/actions/synchronizeTemplates

Request Body Sample

{
  "_client_driven_action": true,
  "documents": {
    "items": [{
        "name": "sync5_1",
        "id": 3022596693,
        "_sync_action": "update"
      }, {
        "id": 3022596694,
        "_sync_action": "delete"
      }, {
        "processVarName": "oraclecpqo",
        "documentVarName": "transaction",
        "attributeVarName": "coverLetter_t",
        "name": "sync11",
        "content": "sync111",
        "_sync_action": "create"
      }
    ]
  }
}

Response Body Sample

{
  "documents": {
    "hasMore": false,
    "links": [{
        "rel": "self",
        "href": "https://sitename.oracle.com/rest/v19/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/v19/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/v19/commerceAttrRichTextTemplates/3022597224"
          }
        ]
      }
    ]
  }
}

Back to Top