Get all ad hoc communiactions
get
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocCommunications
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:- PrimaryKey: Finds an ad hoc communication request with the specified log identifier. Finder Variables:
- LogId; integer; The unique identifier for the communication log.
- PrimaryKey: Finds an ad hoc communication request with the specified log identifier. 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 : publicSectorAdhocCommunications
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 : publicSectorAdhocCommunications-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the ad hoc communication.
-
BccAddress(optional):
string
The blind carbon copy to (Bcc:) address for the email of the ad hoc communication request.
-
Body(optional):
string
The body of the ad hoc communication request.
-
CcAddress(optional):
string
The carbon copy (Cc:) address for the email of the ad hoc communication request.
-
CreationDate(optional):
string(date-time)
The date and time when the ad hoc communication request was created.
-
EmailToAddress(optional):
string
The user IDs of the ad hoc email's primary recipients.
-
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
The sender address of the ad hoc communication request.
-
LastUpdateDate(optional):
string(date-time)
The date when the ad hoc communication request was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
Log(optional):
string
The communication ad hoc communication request error details.
-
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication ad hoc communication request. This ID is automatically generated by the application. -
MessageDeleteAllowed(optional):
boolean
Indicates that a user can delete this message from their notification list. The default value is false.
-
MimeType(optional):
string
The MIME type of the ad hoc notification message. The possible values are HTML and Text.
-
NotificationToAddress(optional):
string
The user IDs of the ad hoc notification's primary recipients.
-
ObjectVersionNumber(optional):
integer(int32)
The version of the communication request.
-
PayloadData(optional):
string
The data payload provided with the ad hoc communication request.
-
PreferredLanguage(optional):
string
The language used for the communication message.
-
Priority(optional):
string
The priority of the message for notification.
-
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 subidentifier 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. -
ResourceEndPoint(optional):
string
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc communication request.
-
RunEnd(optional):
string(date-time)
The date and time when the ad hoc communication was deleted.
-
RunStart(optional):
string(date-time)
The date and time when the ad hoc communication was created.
-
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the ad hoc communication request. -
Subject(optional):
string
The subject of the ad hoc communication request.
-
Visibility(optional):
string
The visibility option of the ad hoc Communication Request.
-
WebFormData(optional):
string
The web form details attached to the communication request.
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.