Get a channel
get
/crmRestApi/resources/11.13.18.05/channels/{ChannelId}
Request
Path Parameters
-
ChannelId(required): integer(int64)
The unique identifier of the channel.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : channels-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : channels-resourceMembers-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channels-senderIdentificationPriorities-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessUnitLOV
-
The list of values containing the unique identifiers of the business units.
The following properties are defined on the LOV link relation:- Source Attribute: BUOrgId; Target Attribute: BusinessUnitId
- Display Attribute: Name
- ChannelTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_TYPE_CD
The list of values indicating the channel type.
The following properties are defined on the LOV link relation:- Source Attribute: ChannelTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CustomerTypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CUSTOMER_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: CustomerTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MultipleMatchesActionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_MULT_MATCHES_ACTION_CD
The following properties are defined on the LOV link relation:- Source Attribute: MultipleMatchesActionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- NetworkTypeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE
The list of values indicating the social network type.
The following properties are defined on the LOV link relation:- Source Attribute: NetworkTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- NoMatchActionCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_NO_MATCH_ACTION_CD
The following properties are defined on the LOV link relation:- Source Attribute: NoMatchActionCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PurposeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_PURPOSE
The following properties are defined on the LOV link relation:- Source Attribute: PurposeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SOURCE_CD
The following properties are defined on the LOV link relation:- Source Attribute: SourceCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StripeCdLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
The list of values to indicate the application stripe.
The following properties are defined on the LOV link relation:- Source Attribute: StripeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- YesNoLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values indicating whether a channel is active.
The following properties are defined on the LOV link relation:- Source Attribute: IncludeSenderEmailFlag; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- resourceMembers
-
Parameters:
- ChannelId:
$request.path.ChannelId
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. - ChannelId:
- senderIdentificationPriorities
-
Operation: /crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPrioritiesParameters:
- ChannelId:
$request.path.ChannelId
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. - ChannelId:
Examples
Use GET with the following URI syntax to get details of a specific channel:
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/300100095223514
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/channels/300100095223514 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 13:30: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.
{ "ChannelId": 300100095223514, "ChannelTypeCd": "ORA_SVC_SOCIAL", "NetworkTypeCd": null, "AccountName": "REST-03181052", "DisplayName": "REST-03181052", "PrivatePToPAllowedFlag": true, "OriginalSystemReference": null, "EnabledFlag": true, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-01-12T02:18:13-08:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2017-01-12T02:18:13-08:00", "LastUpdateLogin": null, "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": null, "ChannelTypeCdLovSwitcher": "LOV_ChannelTypeCd", "StripeCd": "ORA_SVC_CRM", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514", "name": "channels", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514", "name": "channels", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/YesNoLOV", "name": "YesNoLOV", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/NetworkTypeCdLOV", "name": "NetworkTypeCdLOV", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/StripeCdLOV", "name": "StripeCdLOV", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/lov/ChannelTypeCdLOV", "name": "ChannelTypeCdLOV", "kind": "collection" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/channels/300100095223514/child/resourceMembers", "name": "resourceMembers", "kind": "collection" } ], }