REST API for Oracle B2C Service

Get multiple channel types

get

/services/rest/connect/v1.4/channelTypes

Request

Supported Media Types

application/x-www-form-urlencoded

Query Parameters

fields: string

The list of attributes that should be returned in the response. The syntax contains a comma delimited string of attributes.
For example: ?fields=attribute1,attribute2
limit: integer

The requested page size, which limits the number of records returned in the response.
For example: ?limit=100
offset: integer

The starting position of the record. For example, if you set an offset of 8, the request will skip the first eight records, and include the records from the ninth record in the response. The default value is 0, which means that the records will be returned from the first record.
For example: ?offset=8
orderBy: string

The list of attributes used to determine the order in which the records are returned. The syntax contains a comma delimited string of attributes, with each attribute optionally followed by 'asc' or 'desc'. Specify 'asc' for ascending order and 'desc' for descending order. The default value is 'asc'.
For example: ?orderBy=field1:asc,field2:desc
q: string

The query parameter that allows searching by providing ROQL 'where' clause filtering.
For example: ?q=id>2 and id<10< div>
totalResults: boolean

Indicates whether the count for the total number of records returned should be shown. The default value is false.
If you set the value of totalResults as true, the response will include the count of records retrieved by the request.
Example response:"totalResults": 27

Response

Supported Media Types

application/json;type=collection

Default Response

Root Schema : channelTypes-collection

Type: object

Collection of channelTypes

Show Source

createdTime: string

The date and time when the channel type was created. This attribute is read-only.
id: integer

Minimum Value: 1

Maximum Value: 9223372036854776000

The unique identifier of the channel type.
lookupName: string

Maximum Length: 255

The name used to look up the channel type.
updatedTime: string

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

{
    "type":"object",
    "properties":{
        "createdTime":{
            "$ref":"#/definitions/channelTypes/properties/createdTime"
        },
        "updatedTime":{
            "$ref":"#/definitions/channelTypes/properties/updatedTime"
        },
        "id":{
            "$ref":"#/definitions/channelTypes/properties/id"
        },
        "lookupName":{
            "$ref":"#/definitions/channelTypes/properties/lookupName"
        }
    },
    "description":"Collection of channelTypes"
}

Examples

Use GET with the following syntax to list all channel types:

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

Request URI example

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

Response body example

{
  "items": [
    {
      "id": 1,
      "lookupName": "CSS Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/1"
        }
      ]
    },
    {
      "id": 2,
      "lookupName": "MA Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/2"
        }
      ]
    },
    {
      "id": 3,
      "lookupName": "Phone",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/3"
        }
      ]
    },
    {
      "id": 4,
      "lookupName": "Fax",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/4"
        }
      ]
    },
    {
      "id": 5,
      "lookupName": "Post",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/5"
        }
      ]
    },
    {
      "id": 6,
      "lookupName": "CSS Web",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/6"
        }
      ]
    },
    {
      "id": 7,
      "lookupName": "MA Web",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/7"
        }
      ]
    },
    {
      "id": 8,
      "lookupName": "Chat",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/8"
        }
      ]
    },
    {
      "id": 9,
      "lookupName": "Email",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
        }
      ]
    },
    {
      "id": 10,
      "lookupName": "Community",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/10"
        }
      ]
    },
    {
      "id": 11,
      "lookupName": "Twitter",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/11"
        }
      ]
    },
    {
      "id": 12,
      "lookupName": "YouTube",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/12"
        }
      ]
    },
    {
      "id": 13,
      "lookupName": "RSS",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/13"
        }
      ]
    },
    {
      "id": 14,
      "lookupName": "Facebook",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/14"
        }
      ]
    },
    {
      "id": 16,
      "lookupName": "SRM Engage",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/16"
        }
      ]
    }
  ],
  "hasMore": false,
  "links": [
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/channelTypes",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes"
    }
  ]
}