Get all channel communications records for an SR
get
/crmRestApi/resources/11.13.18.05/hrHelpDeskRequests/{SrId}/child/channelCommunication
Request
Path Parameters
-
SrId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
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:- PrimaryKey :Finds a service request channel communication record with the specified primary key.
Finder Variables:- ViaId :The unique identifier of the service request channel communication record.
- PrimaryKey :Finds a service request channel communication record with the specified primary key.
-
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:- ChannelAccountName; string; The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support.
- ChannelDisplayName; string; The display name of the channel.
- ChannelId; integer; The unique identifier of the channel.
- ChannelShortName; string; The public unique identifier of the channel.
- ChannelTypeCd; string; The code indicating the channel type. For example, email or phone. A list of accepted values are defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
- CollabId; string; The unique identifier of the collaboration network user in the corresponding network, such as Slack Id.
- CollabName; string; The user name of the external user on the collaboration network.
- CollabResourceId; integer; The unique identifier of the collaboration network user that the internal users are communicating with.
- ContactPointId; integer; The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address.
- CreatedBy; string; The user who created the communication channel.
- CreationDate; string; The date and time when the communication channel was created.
- InboundObjectId; integer; The unique identifier of the inbound object that resulted in the creation of the service request.
- LastUpdateDate; string; The date and time when the communication channel was last updated.
- LastUpdateLogin; string; The session login associated to the user who last updated the communication channel.
- LastUpdatedBy; string; The user who last updated the communication channel.
- 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.
- ObjectId; integer; The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication.
- ObjectTypeCd; string; The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
- PartyId; integer; The unique party identifier of the person who's being communicated with.
- PartyName; string; The party name of the person who's being communicated with.
- PartyNumber; string; The public unique identifier of the contact associated with the service request communication.
- PartyViaEndPoint; string; The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party.
- PostIdentifier; string; The unique identifier of the social media post record that was used to create the service request or the service request message.
- ResourceId; integer; The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
- ResourceTypeCd; string; The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
- RoutingCd; string; The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient.
- ViaId; integer; The unique identifier of the service request channel communication record.
-
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:
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 : hrHelpDeskRequests-channelCommunication
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hrHelpDeskRequests-channelCommunication-item-response
Type:
Show Source
object
-
ChannelAccountName: string
Title:
Account Name
Read Only:true
Maximum Length:400
The account name associated with the channel. For example, for email the account name would be the inbound mailbox for support. -
ChannelDisplayName: string
Title:
Display Name
Maximum Length:400
The display name of the channel. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel. -
ChannelShortName: string
Title:
Channel Short Name
Maximum Length:450
The public unique identifier of the channel. -
ChannelTypeCd: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The code indicating the channel type. For example, email or phone. A list of accepted values are defined in the lookup ORA_SVC_CHANNEL_TYPE_CD. -
CollabId: string
Title:
Collaboration ID
Read Only:true
Maximum Length:255
The unique identifier of the collaboration network user in the corresponding network, such as Slack Id. -
CollabName: string
Title:
Resource Name
Read Only:true
Maximum Length:400
The user name of the external user on the collaboration network. -
CollabResourceId: integer
(int64)
Title:
Collaboration Resource Identifier
The unique identifier of the collaboration network user that the internal users are communicating with. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
The unique identifier of the contact point record of the contact who's being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication channel. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the communication channel was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the channel communication has been deleted. -
InboundObjectId: integer
(int64)
Title:
Inbound Message Object Identifier
The unique identifier of the inbound object that resulted in the creation of the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the communication channel was last updated. -
LastUpdatedBy: string
Title:
Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication channel. -
LastUpdateLogin: string
Title:
Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the communication channel. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetworkTypeCd: string
Title:
Network
Read Only:true
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. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the object. Depending on the object type, indicates the service request Id or the service request message Id associated with the channel communication. -
ObjectTypeCd: string
Title:
Object Type
Read Only:true
Maximum Length:30
Default Value:SVC_SERVICE_REQUESTS
The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD. -
PartyId: integer
(int64)
Title:
Party ID
The unique party identifier of the person who's being communicated with. -
PartyName: string
Title:
Party Name
Read Only:true
Maximum Length:360
The party name of the person who's being communicated with. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The public unique identifier of the contact associated with the service request communication. -
PartyViaEndPoint: string
Title:
Party Endpoint
Maximum Length:1000
The endpoint used to communicate with the customer contact. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to a party. -
PersonId: integer
(int64)
Title:
Person ID
The unique person ID of the contact. -
PostIdentifier: string
Title:
Post Identifier
Maximum Length:1000
The unique identifier of the social media post record that was used to create the service request or the service request message. -
ResourceId: integer
(int64)
Title:
Resource ID
Read Only:true
The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with. -
ResourceTypeCd: string
Title:
Resource Type
Read Only:true
Maximum Length:30
The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD. -
RoutingCd: string
Title:
Routing Code
Maximum Length:30
The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the channel communication has been updated. -
ViaId: integer
(int64)
Title:
ID
Read Only:true
The unique identifier of the service request channel communication record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.