Get a communication details log
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails/{publicSectorCommunicationRecordDetailsUniqID}
Request
Path Parameters
-
publicSectorCommunicationRecordDetailsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LogId and LogMessageId ---for the Communication Record Details resource and used to uniquely identify an instance of Communication Record Details. The client should not generate the hash key value. Instead, the client should query on the Communication Record Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Communication Record Details.
For example: publicSectorCommunicationRecordDetails?q=LogId=<value1>;LogMessageId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCommunicationRecordDetails-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication request log. -
BccEmailAddress(optional):
string
Title:
Bcc Email Address
The blind copied recipient addresses for email communications. -
Body(optional):
string
Title:
Body
The communication message body text. -
CcEmailAddress(optional):
string
Title:
Cc Email Address
The copied recipient addresses for email communications. -
ChannelType(optional):
string
Title:
Channel Type
Maximum Length:30
The communication message channel type. -
ChannelTypeMeaning(optional):
string
Title:
Channel Type
Maximum Length:80
The communication channel type. The possible values are Email, Notification, and Alert. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication message. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication message was created. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
Title:
From Address
Maximum Length:256
The sender of the communication message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last updated the communication message. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date that the communication message was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication request log. This is automatically generated by the application. -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier for the communication log message. This is automatically generated by the application. -
MessageDeleteAllowed(optional):
string
Maximum Length:
1
Indicates whether users are allowed to delete the message. -
MessageLanguage(optional):
string
Title:
Message Language
Maximum Length:4
The language used for the communication message. -
MessageSeq(optional):
integer(int64)
Title:
Message Sequence
The communication message sequence number. -
MimeType(optional):
string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
MimeTypeMeaning(optional):
string
Title:
MIME Type
Maximum Length:80
The MIME type of communication message. The possible values are HTML and Text. -
ObjectVersionNumber(optional):
integer(int32)
The message revision number.
-
PhoneNumber(optional):
string
Title:
To Phone Number
The recipient phone number for text communications. -
Priority(optional):
string
Title:
Priority
Maximum Length:1
The priority of the notification. -
Recipient(optional):
string
Title:
Sent To
The recipients of the communication message. -
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier(optional):
string
Title:
Record Sub Identifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ShortMessage(optional):
string
Title:
Short Message
Maximum Length:500
The short text message body. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the communication message. -
StatusMeaning(optional):
string
Title:
Status
Maximum Length:80
The status of the communication message. -
Subject(optional):
string
Title:
Subject
Maximum Length:1000
The subject of the communication message. -
TemplateId(optional):
integer(int64)
Title:
Template ID
The unique identifier of the template associated with the communication. -
ToEmailAddress(optional):
string
Title:
To Email Address
The primary recipient addresses for email communications. -
UmsMsgId(optional):
string
Title:
UMS Message ID
Maximum Length:150
The unique identifier generated by UMS for email messages. -
UserId(optional):
string
Title:
To User ID
The recipient user ID for notifications. -
Visibility(optional):
string
Title:
Visibility
Maximum Length:30
The visibility option of the communication log. -
VisibilityMeaning(optional):
string
Title:
Visibility
Maximum Length:80
The visibility option of the communication message. -
WebForms(optional):
array Web Forms
Title:
Web Forms
The communication record details resource is used to view communication details triggered through email, notification, and alert channels.
Nested Schema : Web Forms
Type:
array
Title:
Web Forms
The communication record details resource is used to view communication details triggered through email, notification, and alert channels.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorCommunicationRecordDetails-WebForms-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier for the agency associated with the web form. -
AnswerDate(optional):
string(date)
The date and time answer of the web form message.
-
AnswerNumber(optional):
number
The numeric answer of the web form message.
-
AnswerText(optional):
string
Maximum Length:
1000
The text answer of the web form message. -
AnswerType(optional):
string
Title:
Answer Type
Maximum Length:15
The answer type of the web form message. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the web form message. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The creation date of the web form message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the web form message was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the web form message. -
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier of the log associated with the web form message. -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier for the communication message. -
Question(optional):
string
Title:
Question Text
Maximum Length:1000
The question text of the web form message. -
WebformId(optional):
integer(int64)
Title:
Web Form ID
The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.