Jump to

• Request
• Response
• Examples

Get all channels

get

/crmRestApi/resources/11.13.18.05/channels

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ChannelEnabledFinder: Finds enabled channels.
    Finder Variables:
  • ChannelVOChannelShortNameAltKey: Finds a channel with the specified alternate key.
    Finder Variables:
    • ChannelShortName; string.
  • DefaultChannelByTypeFinder: Finds a channel with the specified finders.
    Finder Variables:
    • AccountName; string; The name of the channel account.
    • ChannelTypeCd; string; The type of the channel.
  • EnabledChannelByBUAndStripeAndTypeFinder: Finds enabled channels for an application stripe, business unit, and channel type combination.
    Finder Variables:
    • BUOrgId; string; The business unit to filter the search.
    • ChannelTypeCd; string; The channel type to filter the search.
    • StripeCd; string; The application stripe to filter the search.
  • PrimaryKey: Finds a channel with the specified primary key.
    Finder Variables:
    • ChannelId; integer; The unique identifier of the channel.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • APIId; string; The unique identifier of the channel API.
  • APIPassword; string; The password for the channel API.
  • APIVersion; string; The API version of the channel.
  • AccessToken; string; The access token used for the social channel.
  • AccountName; string; The name of the account associated with the channel.
  • AuthToken; string; The authorization token used for the social channel.
  • AuthenticationURL; string; The uniform resource locator of the channel authentication.
  • AuthorizationURL; string; The uniform resource locator of the channel authorization.
  • BUOrgId; integer; The unique identifier of the business unit associated with the channel.
  • BusinessUnitName; string; The name of the business unit associated with the channel.
  • ChannelId; integer; The unique identifier of the channel.
  • ChannelShortName; string; The short name of the channel.
  • ChannelTypeCd; string; The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
  • CreatedBy; string; The user who created the channel.
  • CreationDate; string; The date when the channel was created.
  • CustomerTypeCd; string; The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
  • DisplayName; string; The display name of the channel.
  • EnabledFlag; boolean; Indicates whether the channel is active. The default value is true.
  • EndPoint; string; The endpoint of the channel.
  • IncludeSenderEmailFlag; boolean; Indicates whether the sender's email address should be included in the outbound message.
  • IncludeSenderNameFlag; boolean; Indicates whether the sender's name should be included in the outbound message.
  • LastUpdateDate; string; The date when the channel was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the channel.
  • LastUpdatedBy; string; The user who last updated the channel.
  • MultipleMatchesActionCd; string; The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
  • NetworkTypeCd; string; The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
  • NoMatchActionCd; string; The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
  • OpenSrCount; integer; The number of service requests that are neither deleted nor closed.
  • OriginalSystemReference; string; The original system of reference for a channel that was imported.
  • Port; string; The port associated with the channel.
  • PrivatePToPAllowedFlag; boolean; Indicates whether the channel allows private messages. The default value is true.
  • PurposeCd; string; The purpose of the channel such as Support, Sales, Inquiry.
  • RefreshToken; string; The refresh token used for the social channel.
  • SourceCd; string; The source interface for the channel creation.
  • StripeCd; string; The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.
  • TokenAccessURL; string; The channel token access URL.
  • TokenRequestURL; string; The URL to pass a token request on the channel.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : channels

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/channels-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object channels-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/channels-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channels-item-response

Type: object

Show Source

• AccessToken: string
  Title: Access Token

  Maximum Length: 400

  The access token used for the social channel.
• AccountName: string
  Title: Account Name

  Maximum Length: 400

  The name of the account associated with the channel.
• APIId: string
  Title: API

  Maximum Length: 400

  The unique identifier of the channel API.
• APIPassword: string
  Title: API Password

  Maximum Length: 400

  The password for the channel API.
• APIVersion: string
  Title: API Version

  Maximum Length: 400

  The API version of the channel.
• AuthenticationURL: string
  Title: Authentication URL

  Maximum Length: 1000

  The uniform resource locator of the channel authentication.
• AuthorizationURL: string
  Title: Authorization URL

  Maximum Length: 1000

  The uniform resource locator of the channel authorization.
• AuthToken: string
  Title: Authorization Token

  Maximum Length: 400

  The authorization token used for the social channel.
• BUOrgId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit associated with the channel.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 255

  The name of the business unit associated with the channel.
• ChannelId: integer (int64)
  Title: Channel

  Read Only: true

  The unique identifier of the channel.
• ChannelShortName: string
  Title: Channel Code

  Maximum Length: 450

  The short name of the channel.
• ChannelTypeCd: string
  Title: Channel Type

  Maximum Length: 30

  The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
• ChannelTypeCdLovSwitcher: string
  Read Only: true

  The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the channel.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the channel was created.
• CustomerTypeCd: string
  Title: Customer Type

  Maximum Length: 30

  The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.
• DeleteFlag: boolean
  Read Only: true

  Indicates if the channel has been deleted. The default value is false.
• DisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• EnabledFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the channel is active. The default value is true.
• EndPoint: string
  Title: Endpoint

  Maximum Length: 1000

  The endpoint of the channel.
• IncludeSenderEmailFlag: boolean
  Title: Include Sender Email

  Maximum Length: 1

  Default Value: false

  Indicates whether the sender's email address should be included in the outbound message.
• IncludeSenderNameFlag: boolean
  Title: Include Sender Name

  Maximum Length: 1

  Default Value: false

  Indicates whether the sender's name should be included in the outbound message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the channel was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the channel.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleMatchesActionCd: string
  Title: If Multiple Matches Found for Sender

  Maximum Length: 30

  The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.
• NetworkTypeCd: string
  Title: Network

  Maximum Length: 30

  The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
• NoMatchActionCd: string
  Title: If No Matches Found for Sender

  Maximum Length: 30

  The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.
• OpenSrCount: integer
  Read Only: true

  The number of service requests that are neither deleted nor closed.
• OriginalSystemReference: string
  Title: Original System

  Maximum Length: 255

  The original system of reference for a channel that was imported.
• Port: string
  Title: Port

  Maximum Length: 10

  The port associated with the channel.
• PrivatePToPAllowedFlag: boolean
  Title: Private Conversation Allowed

  Maximum Length: 1

  Default Value: true

  Indicates whether the channel allows private messages. The default value is true.
• PurposeCd: string
  Title: Purpose

  Maximum Length: 30

  The purpose of the channel such as Support, Sales, Inquiry.
• RefreshToken: string
  Title: Refresh Token

  Maximum Length: 400

  The refresh token used for the social channel.
• resourceMembers: array Channel Resources
  Title: Channel Resources

  The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.
• senderIdentificationPriorities: array Sender Identification Priorities
  Title: Sender Identification Priorities

  The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.
• SourceCd: string
  Title: Source Code

  Maximum Length: 30

  Default Value: ORA_SVC_ADMIN_UI

  The source interface for the channel creation.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.
• TokenAccessURL: string
  Title: Token Access URL

  Maximum Length: 1000

  The channel token access URL.
• TokenRequestURL: string
  Title: Token Request URL

  Maximum Length: 1000

  The URL to pass a token request on the channel.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the channel has been updated. The default value is false.

{
    "type":"object",
    "properties":{
        "APIId":{
            "title":"API",
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "APIPassword":{
            "title":"API Password",
            "maxLength":400,
            "type":"string",
            "description":"The password for the channel API.",
            "nullable":true,
            "x-queryable":true
        },
        "APIVersion":{
            "title":"API Version",
            "maxLength":400,
            "type":"string",
            "description":"The API version of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessToken":{
            "title":"Access Token",
            "maxLength":400,
            "type":"string",
            "description":"The access token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the account associated with the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "AuthToken":{
            "title":"Authorization Token",
            "maxLength":400,
            "type":"string",
            "description":"The authorization token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthenticationURL":{
            "title":"Authentication URL",
            "maxLength":1000,
            "type":"string",
            "description":"The uniform resource locator of the channel authentication.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationURL":{
            "title":"Authorization URL",
            "maxLength":1000,
            "type":"string",
            "description":"The uniform resource locator of the channel authorization.",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the channel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the business unit associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Code",
            "maxLength":450,
            "type":"string",
            "description":"The short name of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelTypeCdLovSwitcher":{
            "type":"string",
            "description":"The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerTypeCd":{
            "title":"Customer Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of customers expected to send a message to the channel, such as Consumer, Business, or Both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the channel has been deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the channel is active. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPoint":{
            "title":"Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"The endpoint of the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeSenderEmailFlag":{
            "title":"Include Sender Email",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sender's email address should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IncludeSenderNameFlag":{
            "title":"Include Sender Name",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the sender's name should be included in the outbound message.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MultipleMatchesActionCd":{
            "title":"If Multiple Matches Found for Sender",
            "maxLength":30,
            "type":"string",
            "description":"The action the application should take if multiple matches are found for the message sender, such as Select None or Select First Match.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NoMatchActionCd":{
            "title":"If No Matches Found for Sender",
            "maxLength":30,
            "type":"string",
            "description":"The action the application should take if no matches are found for the message sender, such as Nothing or Create Contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OpenSrCount":{
            "type":"integer",
            "description":"The number of service requests that are neither deleted nor closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The original system of reference for a channel that was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "Port":{
            "title":"Port",
            "maxLength":10,
            "type":"string",
            "description":"The port associated with the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivatePToPAllowedFlag":{
            "title":"Private Conversation Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the channel allows private messages. The default value is true.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurposeCd":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"The purpose of the channel such as Support, Sales, Inquiry.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RefreshToken":{
            "title":"Refresh Token",
            "maxLength":400,
            "type":"string",
            "description":"The refresh token used for the social channel.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCd":{
            "title":"Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The source interface for the channel creation.",
            "nullable":false,
            "default":"ORA_SVC_ADMIN_UI",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TokenAccessURL":{
            "title":"Token Access URL",
            "maxLength":1000,
            "type":"string",
            "description":"The channel token access URL.",
            "nullable":true,
            "x-queryable":true
        },
        "TokenRequestURL":{
            "title":"Token Request URL",
            "maxLength":1000,
            "type":"string",
            "description":"The URL to pass a token request on the channel.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the channel has been updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "resourceMembers":{
            "title":"Channel Resources",
            "type":"array",
            "description":"The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.",
            "items":{
                "$ref":"#/components/schemas/channels-resourceMembers-item-response"
            }
        },
        "senderIdentificationPriorities":{
            "title":"Sender Identification Priorities",
            "type":"array",
            "description":"The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.",
            "items":{
                "$ref":"#/components/schemas/channels-senderIdentificationPriorities-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Channel Resources

Type: array

Title: Channel Resources

The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.

Show Source

• Array of: object channels-resourceMembers-item-response

{
    "title":"Channel Resources",
    "type":"array",
    "description":"The channel resources is used to view, create, update, and delete the list of employees or partners, such as service representatives or service managers, who are associated with a service channel. If a resource is associated with a channel, then they can communicate with the customer using that channel.",
    "items":{
        "$ref":"#/components/schemas/channels-resourceMembers-item-response"
    }
}

Nested Schema : Sender Identification Priorities

Type: array

Title: Sender Identification Priorities

The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.

Show Source

• Array of: object channels-senderIdentificationPriorities-item-response

{
    "title":"Sender Identification Priorities",
    "type":"array",
    "description":"The sender identification priorities resource is used to view, create, update, and delete identification priorities for channels.The sender identification priority is used to resolve a conflict if multiple party identifiers are found for a sender of a message.",
    "items":{
        "$ref":"#/components/schemas/channels-senderIdentificationPriorities-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : channels-resourceMembers-item-response

Type: object

Show Source

• AccountCredentials: string
  Title: Account Credentials

  Maximum Length: 400

  The account credentials of the channel resource.
• AccountToken: string
  Title: Account Token

  Maximum Length: 400

  The account token associated with the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• ChannelResourceId: integer (int64)
  Title: Channel Resource ID

  The unique identifier of the resource associated with the channel.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the channel resource.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the channel resource was added.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the resource associated with the channel.
• FormattedPhoneNumber: string
  Read Only: true

  The phone number of the resource associated with the channel.
• LastUpdateDate: string (date-time)
  Title: Last Update

  Read Only: true

  The user who last updated the channel resource.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The login of the user who last updated the channel resource.
• LastUpdateLogin: string
  Title: Update Login

  Read Only: true

  Maximum Length: 32

  The date when the channel resource was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party of the resource associated with the channel.
• PartyIdFK: integer (int64)
  Read Only: true

  The foreign key identifier of the party of the resource associated with the channel.
• PartyName: string
  Maximum Length: 360

  The name of the party of the resource associated with the channel.

{
    "type":"object",
    "properties":{
        "AccountCredentials":{
            "title":"Account Credentials",
            "maxLength":400,
            "type":"string",
            "description":"The account credentials of the channel resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountToken":{
            "title":"Account Token",
            "maxLength":400,
            "type":"string",
            "description":"The account token associated with the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelResourceId":{
            "title":"Channel Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the channel resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the channel resource was added.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource associated with the channel.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the resource associated with the channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update",
            "type":"string",
            "description":"The user who last updated the channel resource.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The date when the channel resource was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the channel resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyIdFK":{
            "type":"integer",
            "description":"The foreign key identifier of the party of the resource associated with the channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the party of the resource associated with the channel.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : channels-senderIdentificationPriorities-item-response

Type: object

Show Source

• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated with the sender priority sequeuce.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The type of sender of a message such as Business Contact, Consumer, or Employee.
• PrioritySequence: integer (int64)
  Title: Priority Sequence

  The priority sequence of the sender type.
• PrioritySequenceId: integer (int64)
  Title: Priority Sequence ID

  The unique identifier of the sender priority sequence.

{
    "type":"object",
    "properties":{
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the sender priority sequeuce.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sender of a message such as Business Contact, Consumer, or Employee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrioritySequence":{
            "title":"Priority Sequence",
            "type":"integer",
            "description":"The priority sequence of the sender type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrioritySequenceId":{
            "title":"Priority Sequence ID",
            "type":"integer",
            "description":"The unique identifier of the sender priority sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

Use GET with the following URI syntax to get details of all channels:

Example of Request URI

The following shows an example of the request URL.

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/channels/ HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200: OK
Date: Mon, 12 Jan 2017 12:37:04 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following shows an example of the response body in JSON format.

{
{
"items": [
  {
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"NetworkTypeCd": null,
"AccountName": "Web",
"DisplayName": "Web (Seeded)",
"PrivatePToPAllowedFlag": true,
"OriginalSystemReference": null,
"EnabledFlag": true,
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2015-07-09T10:14:09-07:00",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"LastUpdateDate": "2016-09-19T10:28:43-07:00",
"LastUpdateLogin": "-1",
"EndPoint": null,
"Port": null,
"APIVersion": null,
"APIId": null,
"APIPassword": null,
"AuthenticationURL": null,
"AuthorizationURL": null,
"TokenRequestURL": null,
"TokenAccessURL": null,
"AccessToken": null,
"RefreshToken": null,
"AuthToken": null,
"OpenSrCount": 1,
"ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd",
"StripeCd": "ORA_SVC_CRM",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1",
"name": "channels",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1",
"name": "channels",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/lov/YesNoLOV",
"name": "YesNoLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/lov/NetworkTypeCdLOV",
"name": "NetworkTypeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/lov/StripeCdLOV",
"name": "StripeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/lov/ChannelTypeCdLOV",
"name": "ChannelTypeCdLOV",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/1/child/resourceMembers",
"name": "resourceMembers",
"kind": "collection"
}
],
},
  {
"ChannelId": 2,
"ChannelTypeCd": "ORA_SVC_EMAIL",
"NetworkTypeCd": null,
"AccountName": "E-Mail",
"DisplayName": "E-Mail (Seeded)",
"PrivatePToPAllowedFlag": true,
"OriginalSystemReference": null,
"EnabledFlag": true,
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2015-07-09T10:14:09-07:00",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"LastUpdateDate": "2016-09-19T10:28:43-07:00",
"LastUpdateLogin": "-1",
"EndPoint": null,
"Port": null,
"APIVersion": null,
"APIId": null,
"APIPassword": null,
"AuthenticationURL": null,
"AuthorizationURL": null,
"TokenRequestURL": null,
"TokenAccessURL": null,
"AccessToken": null,
"RefreshToken": null,
"AuthToken": null,
"OpenSrCount": 1,
"ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd",
"StripeCd": "ORA_SVC_CRM",
"links": [
  {
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2",
"name": "channels",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
  {
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2",
"name": "channels",
"kind": "item"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2/lov/YesNoLOV",
"name": "YesNoLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2/lov/NetworkTypeCdLOV",
"name": "NetworkTypeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2/lov/StripeCdLOV",
"name": "StripeCdLOV",
"kind": "collection"
},
  {
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2/lov/ChannelTypeCdLOV",
"name": "ChannelTypeCdLOV",
"kind": "collection"
},
  {
"rel": "child",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/2/child/resourceMembers",
"name": "resourceMembers",
"kind": "collection"
}
],
},
  . . .
}
}

Back to Top