Create an ad hoc alert
post
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request 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.
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.