Get a communication error log
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs/{publicSectorCommunicationErrorLogsUniqID}
Request
Path Parameters
-
publicSectorCommunicationErrorLogsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LogId, ErrorId, LogMessageId and LogRecipientId ---for the Communication Error Logs resource and used to uniquely identify an instance of Communication Error Logs. The client should not generate the hash key value. Instead, the client should query on the Communication Error Logs collection resource with a filter on the primary key values in order to navigate to a specific instance of Communication Error Logs.
For example: publicSectorCommunicationErrorLogs?q=LogId=<value1>;ErrorId=<value2>;LogMessageId=<value3>;LogRecipientId=<value4>
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 : publicSectorCommunicationErrorLogs-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The unique identifier of the agency associated with the communication error log. -
Body: string
(byte)
Read Only:
true
The communication message body text. -
ChannelType: string
Read Only:
true
Maximum Length:80
The communication channel type. The possible values are Email, Notification, Alert, and Text. -
Channeltypecode: string
Read Only:
true
Maximum Length:30
The communication channel type code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the communication error log. -
CreatedByName: string
Read Only:
true
The name of the user who created the communication error log. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the communication error log was created. -
DeletedFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the communciation event is still in use or deleted. The default value is N for no. -
DeliveryType: string
Read Only:
true
Maximum Length:80
The communication message delivery type. The possible values are To, Cc, and Bcc. -
ErrorId: integer
(int64)
Title:
Error ID
Read Only:true
The communciation error log identifier. This is automatically generated by the system. -
ErrorSource: string
Title:
Error Source
Read Only:true
Maximum Length:30
The communciation error log source information. -
ErrorSourceId: integer
(int64)
Title:
Error Source ID
Read Only:true
The communciation error log source identifier. -
ErrorText: string
Title:
Error Text
Read Only:true
The communication error details. -
EventCode: string
Read Only:
true
Maximum Length:32
The status of the communciation log. -
EventId: integer
(int64)
Read Only:
true
The name for the communication event. -
EventName: string
Read Only:
true
Maximum Length:500
The unique identifier for the communication event. -
FromAddress: string
Read Only:
true
Maximum Length:256
The sender address of the communication message. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the communication error log was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the communication error log. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogId: integer
(int64)
Read Only:
true
The unique identifier of the communication request log associated with the communication error. This ID is generated automatically by the application. -
LogMessageId: integer
(int64)
Read Only:
true
The unique identifier for the communication log message associated with the communication error log. This is automatically generated by the application. -
LogRecipientId: integer
(int64)
Title:
Log Recipient ID
Read Only:true
The recipients of the communication message. -
MessageStatus: string
Read Only:
true
Maximum Length:80
The status of the communication message. -
MimeType: string
Read Only:
true
Maximum Length:80
The MIME type of the communication message. The possible values are HTML and Text. -
RecipientStatus: string
Read Only:
true
Maximum Length:80
The status field to indicate whether the recipient successfully received the communication message or not. -
RecordFifthKeyName: string
Title:
Record Fifth Key Name
Read Only:true
Maximum Length:32
The fifth key name of the transaction application.. -
RecordFifthKeyValue: string
Title:
Record Fifth Key Value
Read Only:true
Maximum Length:100
The fifth key value of the transaction application. -
RecordFirstKeyName: string
Title:
Record First Key Name
Read Only:true
Maximum Length:32
The first key name of the transaction application. -
RecordFirstKeyValue: string
Title:
Record First Key Value
Read Only:true
Maximum Length:100
The first key value of the transaction application. -
RecordFourthKeyName: string
Title:
Record Fourth Key Name
Read Only:true
Maximum Length:32
The fourth key name of the transaction application. -
RecordFourthKeyValue: string
Title:
Record Fourth Key Value
Read Only:true
Maximum Length:100
The fourth key value of the transaction application. -
RecordIdentifier: string
Title:
Record Identifier
Read Only:true
Maximum Length:100
The communication request secondary identifier passed through the communication request. -
RecordSecondKeyName: string
Title:
Record Second Key Name
Read Only:true
Maximum Length:32
The second key name of the transaction application. -
RecordSecondKeyValue: string
Title:
Record Second Key Value
Read Only:true
Maximum Length:100
The second key value of the transaction application. -
RecordThirdKeyName: string
Title:
Record Third Key Name
Read Only:true
Maximum Length:32
The third key name of the transaction application. -
RecordThirdKeyValue: string
Title:
Record Third Key Value
Read Only:true
Maximum Length:100
The third key value of the transaction application. -
ResourceId: integer
(int64)
Read Only:
true
The identifier of the resource. -
SentOn: string
(date-time)
Read Only:
true
The date when the communication message was sent. -
SentTo: string
Read Only:
true
Maximum Length:256
The recipient who received the communication message. -
ShortMessage: string
Read Only:
true
Maximum Length:4000
The short text of the communication message. -
Status: string
Read Only:
true
Maximum Length:30
The fifth key name of the related communication resource. -
Subject: string
Read Only:
true
Maximum Length:1000
The subject of the communication message. -
TemplateCode: string
Read Only:
true
Maximum Length:32
The unique identifier for the communication template associated with the communication message. -
TemplateName: string
Read Only:
true
Maximum Length:100
The name for the communication template associated with the communication message. -
TotalErrorRecipients: integer
(int64)
Read Only:
true
The total number of recipients who did not successfully receive the communication message. -
TotalSuccessRecipients: integer
(int64)
Read Only:
true
The total number of recipients who successfully received the communication message. -
UmsMsgId: string
Read Only:
true
Maximum Length:150
The unique identifier generated by UMS for email messages. -
UpdatedByName: string
Read Only:
true
The name of the user who last udpated the communication error log. -
Visibility: string
Read Only:
true
Maximum Length:80
The visibility option of the communication message.
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.