Update a notification
patch
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorNotificationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- LogMessageId and LogRecipientId ---for the Notifications resource and used to uniquely identify an instance of Notifications. The client should not generate the hash key value. Instead, the client should query on the Notifications collection resource with a filter on the primary key values in order to navigate to a specific instance of Notifications.
For example: publicSectorNotifications?q=LogMessageId=<value1>;LogRecipientId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorNotifications-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the notification. -
Body(optional):
string
Title:
Body
The notification message body text. -
ChannelType(optional):
string
Title:
Channel Type
Maximum Length:30
The channel type of the communication message. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the notification. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the notification was created. -
FromAddress(optional):
string
Title:
From Address
Maximum Length:256
The sender of the notification message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the notification was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the notification. -
links(optional):
array Items
Title:
Items
Link Relations -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier of the log message. This ID is generated automatically by the application. -
LogRecipientId(optional):
integer(int64)
Title:
Log Recipient ID
The unique identifier of the log recipient. This ID is generated automatically by the application. -
MessageDeleteAllowed(optional):
boolean
Indicates whether the notification can be deleted from a user's notification list.
-
MessageSeq(optional):
integer(int64)
Title:
Message Sequence
The message sequence number. -
MimeType(optional):
string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
Priority(optional):
string
Title:
Priority
Maximum Length:1
The priority of the notification. -
SentOn(optional):
string(date-time)
Title:
Sent On
The date and time of the notification. -
SentTo(optional):
string
Title:
Sent To
Maximum Length:1500
The user ID of the notification recipient. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the communication message. -
StatusMeaning(optional):
string
Title:
Status
Maximum Length:80
The status of the notification message. -
Subject(optional):
string
Title:
Subject
Maximum Length:1000
The subject of the notification message. -
TemplateId(optional):
integer(int64)
Title:
Template ID
The unique identifier of the communication template associated with the notification. -
Visibility(optional):
string
Title:
Visibility
Maximum Length:30
The visibility option of the notification.
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 : publicSectorNotifications-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the notification. -
Body(optional):
string
Title:
Body
The notification message body text. -
ChannelType(optional):
string
Title:
Channel Type
Maximum Length:30
The channel type of the communication message. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the notification. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the notification was created. -
FromAddress(optional):
string
Title:
From Address
Maximum Length:256
The sender of the notification message. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the notification was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the notification. -
links(optional):
array Items
Title:
Items
Link Relations -
LogMessageId(optional):
integer(int64)
Title:
Log Message ID
The unique identifier of the log message. This ID is generated automatically by the application. -
LogRecipientId(optional):
integer(int64)
Title:
Log Recipient ID
The unique identifier of the log recipient. This ID is generated automatically by the application. -
MessageDeleteAllowed(optional):
boolean
Indicates whether the notification can be deleted from a user's notification list.
-
MessageSeq(optional):
integer(int64)
Title:
Message Sequence
The message sequence number. -
MimeType(optional):
string
Title:
MIME Type
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
Priority(optional):
string
Title:
Priority
Maximum Length:1
The priority of the notification. -
SentOn(optional):
string(date-time)
Title:
Sent On
The date and time of the notification. -
SentTo(optional):
string
Title:
Sent To
Maximum Length:1500
The user ID of the notification recipient. -
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the communication message. -
StatusMeaning(optional):
string
Title:
Status
Maximum Length:80
The status of the notification message. -
Subject(optional):
string
Title:
Subject
Maximum Length:1000
The subject of the notification message. -
TemplateId(optional):
integer(int64)
Title:
Template ID
The unique identifier of the communication template associated with the notification. -
Visibility(optional):
string
Title:
Visibility
Maximum Length:30
The visibility option of the notification.
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.