Get a communication history
get
/fscmRestApi/resources/11.13.18.05/communicationHistories/{CommHistoryId}
Request
Path Parameters
-
CommHistoryId(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 -
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(required):
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(required):
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 : communicationHistories-item-response
Type:
Show Source
object
-
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:50
The name of a category, such as Enrollment or Billing. -
CommHistoryId: integer
(int64)
Title:
Communication History ID
Read Only:true
Identifies the instance in which an individual communication was sent to a recipient. -
CommSetupId: integer
(int64)
Title:
Communication Setup ID
Read Only:true
The unique identifier for a communication setup. -
CommunicationChannelCode: string
Title:
Channel Code
Read Only:true
Maximum Length:30
The code identifier for the channel through which a communication was sent, such as the code for email channel. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL. -
CommunicationChannelMeaning: string
Title:
Channel
Read Only:true
Maximum Length:80
The channel through which a communication was sent to a recipient, such as email. A list of accepted values is defined in the lookup type ORA_HEY_COMM_CHANNEL. -
CommunicationCode: string
Title:
Communication Code
Read Only:true
Maximum Length:30
The unique code for a communication. -
CommunicationDate: string
(date-time)
Title:
Communication Date
Read Only:true
The date on which a communication was sent to a recipient. -
CommunicationMessageText: string
Title:
Communication Message Text
Read Only:true
The text of the message sent to the communication recipient. -
CommunicationName: string
Title:
Communication Name
Read Only:true
Maximum Length:50
The name of the communication that was sent to a recipient. -
CommunicationStatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
The code identifier for the status of a sent communication, such as the code for delivered or undelivered status. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS. -
CommunicationStatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The status of a sent communication, such as opened or undelivered. A list of accepted values is defined in the lookup type ORA_HEY_COMM_STATUS. -
CommunicationSubjectText: string
Title:
Communication Subject Text
Read Only:true
Maximum Length:240
The text of the subject line of a communication sent to a recipient. -
CommunicationType: string
Title:
Communication Type
Read Only:true
Maximum Length:80
The lookup meaning of the communication type code. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE. -
CommunicationTypeCode: string
Title:
Communication Type Code
Read Only:true
Maximum Length:30
The code for the type of communication, such as an event-based communication. A list of accepted values is defined in the lookup type ORA_HEY_COMMUNICATION_TYPE. -
ConsumerResourceId: integer
(int64)
Title:
Consumer Resource ID
The unique identifier for the communication recipient whose action needs to be recorded. -
EmailBcc: string
Title:
Bcc
Read Only:true
The email addresses of those who were blind carbon copied on an email communication. -
EmailCc: string
Title:
Cc
Read Only:true
The email addresses of those who were carbon copied on an email communication. -
EmailFrom: string
Title:
Email From
Read Only:true
Maximum Length:64
The sender email address of the email communication. -
EmailReplyTo: string
Title:
Reply To
Maximum Length:320
Email address of the reply to entered in the communication. -
EmailResendFlag: boolean
Title:
Resend Indicator
Maximum Length:1
Indicates whether the communication is to be resent. The acceptable values are Y, N, true, or false. -
EmailTo: string
Title:
To
Read Only:true
Maximum Length:320
The email address of the communication recipient. -
EventName: string
Title:
Event Name
Read Only:true
Maximum Length:50
The name of an event that triggers a communication. -
EventType: string
Title:
Event Type
Read Only:true
Maximum Length:80
The lookup meaning of the event type code. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE. -
EventTypeCode: string
Title:
Event Type Code
Read Only:true
Maximum Length:30
The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageResponseCode: string
Title:
Message Response
Maximum Length:30
The action taken by the user to respond to an actionable communication. Examples of values are ORA_HEY_COMM_ACTION_ACCEPT and ORA_HEY_COMM_ACTION_DENY. A list of accepted values is defined in the lookup type ORA_HEY_COMM_ACTION_TYPE. -
MessageResponseDate: string
(date-time)
Title:
Message Response Date
The date on which the recipient responded to the actionable email. -
ParentCommHistoryId: integer
(int64)
Title:
Parent History ID
The unique identifier of the initial communication instance that was sent to the recipient. -
RecipientId: integer
(int64)
Title:
Recipient ID
Read Only:true
The unique identifier for the communication recipient. -
RecipientName: string
Title:
Recipient Name
Read Only:true
The preferred name of a communication recipient. -
ResendCount: integer
(int32)
Title:
Resend Count
Read Only:true
The number of times the communication was resent. -
ResendDate: string
(date-time)
Title:
Resend Date
Read Only:true
The date on which a communication was last resent to a recipient. -
ResponseToken: string
Title:
Response Token
Maximum Length:64
The response token which would be provided by consumer to identify a specific user. -
TrackingMessageText: string
(byte)
Title:
Tracking Message Text
The tracking message of the messaging server about delivery of the communication.
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.