1. REST API for Oracle B2C Service
  2. Tasks
  3. Standard Contents

Create a standard content

post

/services/rest/connect/v1.4/standardContents

Request

Body ()
The preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
Root Schema : standardContents
Type: object
The preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
Show Source
Nested Schema : namedIDs-standardContents-adminVisibleInterfaces
Type: object
The named ID that can be included in a list.
Show Source
Nested Schema : standardContents-attributes
Type: object
The list of attributes for the standard content object.
Show Source
Nested Schema : standardContents-contentValues
Type: object
The standard content value with a data type and a formatted data value.
Show Source
Nested Schema : standardContents-folder
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : standardContents-usage
Type: object
The usage information about the standard content.
Show Source
Nested Schema : namedIDs-standardContents-contentValues-contentType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : standardContents-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Back to Top

Response

Default Response

Body ()
Root Schema : standardContents
Type: object
The preformed text or HTML content that can be sent to customers when responding to incidents, appended to responses by a business rule, or sent by an agent during a chat session.
Show Source
Nested Schema : namedIDs-standardContents-adminVisibleInterfaces
Type: object
The named ID that can be included in a list.
Show Source
Nested Schema : standardContents-attributes
Type: object
The list of attributes for the standard content object.
Show Source
Nested Schema : standardContents-contentValues
Type: object
The standard content value with a data type and a formatted data value.
Show Source
Nested Schema : standardContents-folder
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : standardContents-usage
Type: object
The usage information about the standard content.
Show Source
Nested Schema : namedIDs-standardContents-contentValues-contentType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : standardContents-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Back to Top

Examples

Use POST with the following syntax to create a new standard content (standard text) object:

https://your_site_interface/services/rest/connect/version/standardContents

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/standardContents

Request body example

{
"name": "Return Address",
"usage":
    {
    "incidentText": true,
    "ruleText": true
    },
"contentValues": [
    {
    "contentType":
        {
        "id": 1
        },
    "value": "136 Enterprise Blvd.\nBozeman, MT 59718"
    }
    ]
}

Note:

The name and usage fields are required for standard contents.

Response body example

{
  "id": 4,
  "lookupName": "Return Address",
  "adminVisibleInterfaces": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4/
         adminVisibleInterfaces"
      }
    ]
  },
  "attributes": {
    "displayRightToLeft": false
  },
  "contentValues": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4/
         contentValues"
      }
    ]
  },
  "displayOrder": 4,
  "folder": null,
  "hotKey": null,
  "name": "Return Address",
  "usage": {
    "chatText": false,
    "chatURL": false,
    "incidentText": true,
    "ruleText": true
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/standardContents/4"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/standardContents",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top