Get a notification
get
/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}
Request
Path Parameters
-
publicSectorNotificationsUniqID(required): string
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorNotifications-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
Default Value:1
The unique identifier of the agency associated with the notification. -
AttachRowCount: string
Read Only:
true
The count of attachments for the communication. -
Body: string
(byte)
Title:
Body
Read Only:true
The notification message body text. -
ChannelType: string
Title:
Channel Type
Read Only:true
Maximum Length:30
The channel type of the communication message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the notification was created. -
FromAddress: string
Title:
From Address
Read Only:true
Maximum Length:256
The sender of the notification message. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date that the notification was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogMessageId: integer
(int64)
Title:
Log Message ID
Read Only:true
The unique identifier of the log message. This ID is generated automatically by the application. -
LogRecipientId: integer
(int64)
Title:
Log Recipient ID
Read Only:true
The unique identifier of the log recipient. This ID is generated automatically by the application. -
MessageDeleteAllowed: boolean
Read Only:
true
Maximum Length:1
Indicates whether the notification can be deleted from a user's notification list. -
MessageSeq: integer
(int64)
Title:
Message Sequence
Read Only:true
The message sequence number. -
MimeType: string
Title:
MIME Type
Read Only:true
Maximum Length:30
The MIME type of communication message. The possible values are HTML and Text. -
Priority: string
Title:
Priority
Read Only:true
Maximum Length:1
The priority of the notification. -
SentOn: string
(date-time)
Title:
Sent On
Read Only:true
The date and time of the notification. -
SentTo: string
Title:
Sent To
Read Only:true
Maximum Length:1500
The user ID of the notification recipient. -
Status: string
Title:
Status
Maximum Length:30
The status of the communication message. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The status of the notification message. -
Subject: string
Title:
Subject
Read Only:true
Maximum Length:1000
The subject of the notification message. -
TemplateId: integer
(int64)
Title:
Template ID
Read Only:true
The unique identifier of the communication template associated with the notification. -
Visibility: string
Title:
Visibility
Read Only:true
Maximum Length:30
The visibility option of the notification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.