Notification

What can you do with Notification?


Properties

Property Details
id
"id": 841
Type: Number
This is the unique numeric identifier for the Notification
notificationTypeId
"notificationTypeId": 232
Type: Number
Unique identifier for the associated NotificationType object.
notificationStateTypeId
"notificationStateTypeId": 194
Type: Number
Unique identifier for the associated NotificationStateType object.
detail
"detail": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
userId
"userId": 557
Type: Number
Unique identifier for the associated User object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • notificationTypeId
  • notificationStateTypeId
  • detail
  • created
  • userId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Notification/{id:int}
Delete an instance of the Notification object.
DELETEapi/v1/Notification/{id:int}/History
Delete a History object from the Notification.
{id:int}Unique identifier for the Notification object.
GETapi/v1/Notification
Retrieve all of the Notification objects.
GETapi/v1/Notification/Metadata
Retrieve all of the meta data details of the Notification object.
GETapi/v1/Notification/Metadata/{option}
Retrieve all the meta data details of the Notification object based on provided options.
{option}Metadata options for the Notification object.
GETapi/v1/Notification/Paged
Retreive all of the Notification objects in a paged fashion.
GETapi/v1/Notification/{id:int}
Retrieve an instance of the Notification object by it's ID.
{id:int}Unique identifier for the Notification object.
POSTapi/v1/Notification
Create a new instance of the Notification object.
PUTapi/v1/Notification/{id:int}
Update an existing instance of the Notification object.