Get a communication alert
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationAlerts/{publicSectorCommunicationAlertsUniqID}
Request
Path Parameters
-
publicSectorCommunicationAlertsUniqID: integer
This is the hash key of the attributes which make up the composite key--- eventCode and templateCode ---for the Communication Alerts resource and used to uniquely identify an instance of Communication Alerts. The client should not generate the hash key value. Instead, the client should query on the Communication Alerts collection resource with a filter on the primary key values in order to navigate to a specific instance of Communication Alerts.
For example: publicSectorCommunicationAlerts?q=eventCode=<value1>;templateCode=<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 : publicSectorCommunicationAlerts-item
Type:
Show Source
object
-
alertBody(optional):
string
Title:
Body
Maximum Length:255
The body text of the alert. -
alertEndDate(optional):
string
Title:
Alert End Date
The alert end date and time. -
alertStartDate(optional):
string
Title:
Alert Start Date
The alert start date and time. -
eventCode(optional):
string
Title:
Event Code
The unique identifier for the communication event. -
links(optional):
array Items
Title:
Items
Link Relations -
templateCode(optional):
string
Title:
Template Code
The unique identifier for the communication template. -
userId(optional):
string
Title:
To User ID
The user ID of the alert recipient. -
visibility(optional):
string
Title:
Visibility
The visibility option for the alert.
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.