Get all communication error logs
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs
Request
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 -
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:- simpleSearchFinder: Finds a communication error log with the specified keyword. Finder Variables:
- numVal; integer; The number value that is used to find a communication error log, such as message ID.
- value; string; The keyword used to find a communication error log.
- PrimaryKey: Finds a communication error log that matches the specified primary key criteria. Finder Variables:
- ErrorId; integer; The unique error identifier for identifying a communication error log row.
- LogId; integer; The unique log identifier for identifying a communication error log row.
- LogMessageId; integer; The unique log message identifier for identifying a communication error log row.
- LogRecipientId; integer; The unique log recipient identifier for identifying a communication error log row.
- simpleSearchFinder: Finds a communication error log with the specified keyword. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCommunicationErrorLogs
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCommunicationErrorLogs-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the communication error log.
-
Body(optional):
string
The communication message body text.
-
ChannelType(optional):
string
Maximum Length:
80
The communication channel type. The possible values are Email, Notification, Alert, and Text. -
Channeltypecode(optional):
string
Maximum Length:
30
The communication channel type code. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the communication error log. -
CreatedByName(optional):
string
The name of the user who created the communication error log.
-
CreationDate(optional):
string(date-time)
The date and time when the communication error log was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the communciation event is still in use or deleted. The default value is N for no. -
DeliveryType(optional):
string
Maximum Length:
80
The communication message delivery type. The possible values are To, Cc, and Bcc. -
ErrorId(optional):
integer(int64)
Title:
Error ID
The communciation error log identifier. This is automatically generated by the system. -
ErrorSource(optional):
string
Title:
Error Source
Maximum Length:30
The communciation error log source information. -
ErrorSourceId(optional):
integer(int64)
Title:
Error Source ID
The communciation error log source identifier. -
ErrorText(optional):
string
Title:
Error Text
The communication error details. -
EventCode(optional):
string
Maximum Length:
32
The status of the communciation log. -
EventId(optional):
integer(int64)
The name for the communication event.
-
EventName(optional):
string
Maximum Length:
500
The unique identifier for the communication event. -
FromAddress(optional):
string
Maximum Length:
256
The sender address of the communication message. -
LastUpdateDate(optional):
string(date-time)
The date when the communication error log was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the communication error log. -
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
The unique identifier of the communication request log associated with the communication error. This ID is generated automatically by the application.
-
LogMessageId(optional):
integer(int64)
The unique identifier for the communication log message associated with the communication error log. This is automatically generated by the application.
-
LogRecipientId(optional):
integer(int64)
Title:
Log Recipient ID
The recipients of the communication message. -
MessageStatus(optional):
string
Maximum Length:
80
The status of the communication message. -
MimeType(optional):
string
Maximum Length:
80
The MIME type of the communication message. The possible values are HTML and Text. -
RecipientStatus(optional):
string
Maximum Length:
80
The status field to indicate whether the recipient successfully received the communication message or not. -
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the transaction application.. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the transaction application. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the transaction application. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the transaction application. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the transaction application. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the transaction application. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request secondary identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the transaction application. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the transaction application. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the transaction application. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the transaction application. -
ResourceId(optional):
integer(int64)
The identifier of the resource.
-
SentOn(optional):
string(date-time)
The date when the communication message was sent.
-
SentTo(optional):
string
Maximum Length:
256
The recipient who received the communication message. -
ShortMessage(optional):
string
Maximum Length:
4000
The short text of the communication message. -
Status(optional):
string
Maximum Length:
30
The fifth key name of the related communication resource. -
Subject(optional):
string
Maximum Length:
1000
The subject of the communication message. -
TemplateCode(optional):
string
Maximum Length:
32
The unique identifier for the communication template associated with the communication message. -
TemplateName(optional):
string
Maximum Length:
100
The name for the communication template associated with the communication message. -
TotalErrorRecipients(optional):
integer(int64)
The total number of recipients who did not successfully receive the communication message.
-
TotalSuccessRecipients(optional):
integer(int64)
The total number of recipients who successfully received the communication message.
-
UmsMsgId(optional):
string
Maximum Length:
150
The unique identifier generated by UMS for email messages. -
UpdatedByName(optional):
string
The name of the user who last udpated the communication error log.
-
Visibility(optional):
string
Maximum Length:
80
The visibility option of the communication message.
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.