Jump to

• Request
• Response
• Examples

Get a standard content

get

/services/rest/connect/v1.4/standardContents/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the standard content object.

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

• adminVisibleInterfaces(optional): object namedIDs-standardContents-adminVisibleInterfaces
  The named ID that can be included in a list.
• attributes(optional): object standardContents-attributes
  The list of attributes for the standard content object.
• comment(optional): [ "string", "null" ]
  Maximum Length: 1048576

  The comments associated with the standard content object.
• contentValues(optional): object standardContents-contentValues
  The standard content value with a data type and a formatted data value.
• createdTime(optional): string
  The date and time when the standard content was created. This attribute is read-only.
• displayOrder(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position of the standard content relative to other standard content objects with the same parent.
• folder(optional): object standardContents-folder
  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.
• hotKey(optional): [ "string", "null" ]
  Maximum Length: 10

  Pattern: ^[^ ^|]*$

  The assigned shortcut key for inserting the standard content.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the standard content object.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the standard content object.
• name(optional): string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The name of the standard content object.
• updatedTime(optional): string
  The date and time when the standard content was last updated. This attribute is read-only.
• usage(optional): object standardContents-usage
  The usage information about the standard content.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The comments associated with the standard content object.",
            "maxLength":1048576
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the standard content was last updated. This attribute is read-only."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the standard content was created. This attribute is read-only."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name of the standard content object.",
            "maxLength":40
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the standard content object.",
            "maxLength":255
        },
        "hotKey":{
            "pattern":"^[^\n^|]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The assigned shortcut key for inserting the standard content.",
            "maxLength":10
        },
        "contentValues":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of the preformed content with entries for each content type.",
            "$ref":"#/definitions/standardContents-contentValues"
        },
        "usage":{
            "type":"object",
            "description":"A list of Boolean values indicating the instances for which the standard content can be used.",
            "$ref":"#/definitions/standardContents-usage"
        },
        "attributes":{
            "type":"object",
            "description":"The list of attributes for StandardContent object.",
            "$ref":"#/definitions/standardContents-attributes"
        },
        "folder":{
            "type":[
                "object",
                "null"
            ],
            "description":"The folder of standard content objects in which the standard content is located.",
            "$ref":"#/definitions/standardContents-folder"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the standard content object.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The display position of the standard content relative to other standard content objects with the same parent.",
            "maximum":2147483647
        },
        "adminVisibleInterfaces":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of interfaces on which the category is available for administration use.",
            "$ref":"#/definitions/namedIDs-standardContents-adminVisibleInterfaces"
        }
    }
}

Nested Schema : namedIDs-standardContents-adminVisibleInterfaces

Type: object

The named ID that can be included in a list.

Show Source

• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the object. This is the key for the list entry.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the object.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the object. This is the key for the list entry.",
            "maximum":9.223372036854776E18
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the object.",
            "maxLength":255
        }
    }
}

Nested Schema : standardContents-attributes

Type: object

The list of attributes for the standard content object.

Show Source

• displayRightToLeft(optional): boolean
  Indicates whether the content presentation is from right to left. The default value is false.

{
    "type":"object",
    "description":"The list of attributes for the standard content object.",
    "properties":{
        "displayRightToLeft":{
            "type":"boolean",
            "description":"Indicates whether the content presentation is from right to left. The default value is false."
        }
    }
}

Nested Schema : standardContents-contentValues

Type: object

The standard content value with a data type and a formatted data value.

Show Source

• contentType(optional): object namedIDs-standardContents-contentValues-contentType
  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.
• value(optional): [ "string", "null" ]
  Maximum Length: 1048576

  The formatted data for the associated content type.

{
    "type":"object",
    "description":"The standard content value with a data type and a formatted data value.",
    "properties":{
        "contentType":{
            "type":"object",
            "description":"The content type of the data.",
            "$ref":"#/definitions/namedIDs-standardContents-contentValues-contentType"
        },
        "value":{
            "type":[
                "string",
                "null"
            ],
            "description":"The formatted data for the associated content type.",
            "maxLength":1048576
        }
    }
}

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

• id(optional): integer
  Minimum Value: 1

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object
• parents(optional): object standardContents-folder-parents
  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.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "parents":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"List of the parents of the entry, in order from root to immediate parent",
            "$ref":"#/definitions/standardContents-folder-parents"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : standardContents-usage

Type: object

The usage information about the standard content.

Show Source

• chatText(optional): boolean
  Indicates whether the content is used in a chat session. The default value is false.
• chatURL(optional): boolean
  Indicates whether the content is used in the URL of a chat session. The default value is false.
• incidentText(optional): boolean
  Indicates whether the content is used in an incident. The default value is false.
• ruleText(optional): boolean
  Indicates whether the content is used in a rule. The default value is false.

{
    "type":"object",
    "description":"The usage information about the standard content.",
    "properties":{
        "chatURL":{
            "type":"boolean",
            "description":"Indicates whether the content is used in the URL of a chat session. The default value is false."
        },
        "incidentText":{
            "type":"boolean",
            "description":"Indicates whether the content is used in an incident. The default value is false."
        },
        "chatText":{
            "type":"boolean",
            "description":"Indicates whether the content is used in a chat session. The default value is false."
        },
        "ruleText":{
            "type":"boolean",
            "description":"Indicates whether the content is used in a rule. The default value is false."
        }
    }
}

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

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

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

• id(optional): integer
  Minimum Value: 1

  ID value. Read-only
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"ID value.  Read-only"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve a specific standard content (standard text) object:

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

Request URI example

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

Response body example

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

Back to Top