Get an ad hoc alert
get
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
Request
Path Parameters
-
LogId: integer
A logical identifier for the ad hoc alert. This ID is automatically generated by the application.
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 : publicSectorAdhocAlerts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the ad hoc alert. -
Alertbody(optional):
string
Title:
Body
Maximum Length:1000
The message body of the ad hoc alert. -
AlertEnd(optional):
string(date-time)
Title:
Alert End Date
The date and time when the ad hoc alert is no longer active. -
AlertStart(optional):
string(date-time)
Title:
Alert Start Date
The date and time when the ad hoc alert becomes active. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments entered by staff while creating the ad hoc alert. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the ad hoc alert. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the ad hoc alert was created. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the ad hoc alert is available to be used. The default value is N. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the ad hoc alert was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who updated the ad hoc alert most recently. -
links(optional):
array Items
Title:
Items
Link Relations -
LogId(optional):
integer(int64)
Title:
Log ID
A logical identifier for the ad hoc alert. This ID is automatically generated by the application. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The unique identifier of the ad hoc alert. -
Status(optional):
string
Title:
Status
Maximum Length:30
Status of the ad hoc alert. -
Subject(optional):
string
Title:
Subject
The summary of the ad hoc alert message body. -
ToAddress(optional):
string
Title:
Sent To
Maximum Length:1000
The type of the recipient for the ad hoc alert. Possibe values are Registred Users, Anonymous Users, and Specified Users.
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.