REST API for Oracle B2C Service

Create a variable

post

/services/rest/connect/v1.4/variables

Request

A shortcut defined for a larger string that can be inserted in the body of an answer or inserted inline during a chat session. When the variable is inserted in the body of the answer or in a chat response, it is replaced with the value specified in the variable.

Root Schema : variables

Type: object

Show Source

createdTime(optional): string

The date and time when the variable was created. This attribute is read-only.
displayOrder(optional): integer

Minimum Value: 1

Maximum Value: 2147483647

The position of the variable in the variable list.
folder(optional): object variables-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.
id(optional): integer

Minimum Value: 1

Maximum Value: 9.223372036854776E18

The unique identifier of the variable.
interfaceValues(optional): object variables-interfaceValues

The interface-specific value of a variable.
lookupName(optional): string

Maximum Length: 255

The name used to look up the variable.
name(optional): string

Maximum Length: 40

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

The name of the variable.
searchIndexable(optional): boolean

Indicates whether the text is indexed for searching the customer portal. The default value is false.
updatedTime(optional): string

The date and time when the variable was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"A shortcut defined for a larger string that can be inserted in the body of an answer or inserted inline during a chat session. When the variable is inserted in the body of the answer or in a chat response, it is replaced with the value specified in the variable.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the variable was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "description":"The name of the variable.",
            "maxLength":40
        },
        "interfaceValues":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of values, one for each supported interface.",
            "$ref":"#/definitions/variables-interfaceValues"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the variable.",
            "maxLength":255
        },
        "searchIndexable":{
            "type":"boolean",
            "description":"Indicates whether the text is indexed for searching the customer portal. The default value is false."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the variable was created. This attribute is read-only."
        },
        "folder":{
            "type":[
                "object",
                "null"
            ],
            "description":"The list of all parent folders in the hierarchy from the root to the immediate parent. This attribute is read-only.",
            "$ref":"#/definitions/variables-folder"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the variable.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The position of the variable in the variable list.",
            "maximum":2147483647
        }
    }
}

Nested Schema : variables-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 variables-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/variables-folder-parents"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : variables-interfaceValues

Type: object

The interface-specific value of a variable.

Show Source

interface(optional): object interface

The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
value(optional): string

Maximum Length: 1333

The description of the interface.

{
    "type":"object",
    "description":"The interface-specific value of a variable.",
    "properties":{
        "interface":{
            "type":"object",
            "description":"The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "value":{
            "type":"string",
            "description":"The description of the interface.",
            "maxLength":1333
        }
    }
}

Nested Schema : variables-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
        }
    }
}

Nested Schema : interface

Type: object

The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.

Response

Default Response

Root Schema : variables

Type: object

Show Source

createdTime(optional): string

The date and time when the variable was created. This attribute is read-only.
displayOrder(optional): integer

Minimum Value: 1

Maximum Value: 2147483647

The position of the variable in the variable list.
folder(optional): object variables-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.
id(optional): integer

Minimum Value: 1

Maximum Value: 9.223372036854776E18

The unique identifier of the variable.
interfaceValues(optional): object variables-interfaceValues

The interface-specific value of a variable.
lookupName(optional): string

Maximum Length: 255

The name used to look up the variable.
name(optional): string

Maximum Length: 40

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

The name of the variable.
searchIndexable(optional): boolean

Indicates whether the text is indexed for searching the customer portal. The default value is false.
updatedTime(optional): string

The date and time when the variable was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"A shortcut defined for a larger string that can be inserted in the body of an answer or inserted inline during a chat session. When the variable is inserted in the body of the answer or in a chat response, it is replaced with the value specified in the variable.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the variable was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "description":"The name of the variable.",
            "maxLength":40
        },
        "interfaceValues":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of values, one for each supported interface.",
            "$ref":"#/definitions/variables-interfaceValues"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the variable.",
            "maxLength":255
        },
        "searchIndexable":{
            "type":"boolean",
            "description":"Indicates whether the text is indexed for searching the customer portal. The default value is false."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the variable was created. This attribute is read-only."
        },
        "folder":{
            "type":[
                "object",
                "null"
            ],
            "description":"The list of all parent folders in the hierarchy from the root to the immediate parent. This attribute is read-only.",
            "$ref":"#/definitions/variables-folder"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the variable.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The position of the variable in the variable list.",
            "maximum":2147483647
        }
    }
}

Nested Schema : variables-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 variables-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/variables-folder-parents"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : variables-interfaceValues

Type: object

The interface-specific value of a variable.

Show Source

interface(optional): object interface

The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
value(optional): string

Maximum Length: 1333

The description of the interface.

{
    "type":"object",
    "description":"The interface-specific value of a variable.",
    "properties":{
        "interface":{
            "type":"object",
            "description":"The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "value":{
            "type":"string",
            "description":"The description of the interface.",
            "maxLength":1333
        }
    }
}

Nested Schema : variables-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
        }
    }
}

Nested Schema : interface

Type: object

Examples

Use POST with the following syntax to create a new variable:

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

Note:

While creating variable objects using the APIs, ensure that the number of variable objects multiplied by the number of interfaces on your site does not exceed the maximum limit 80000.

Request URI example

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

Request body example

{
"name": "Product",
"interfaceValues": [
    {
    "interface":
        {
        "id": 1
        },
    "value": "Oracle Service Cloud"
    }
    ]
}

Note:

The name field is required for variables.

Response body example

{
  "id": 6,
  "lookupName": "Product",
  "displayOrder": 3,
  "folder": null,
  "interfaceValues": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/6/interfaceValues"
      }
    ]
  },
  "name": "Product",
  "searchIndexable": false,
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/6"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/6"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/variables",
      "mediaType": "application/schema+json"
    }
  ]
}