List Notifications

post/notification.list

Retrieves all notifications. A filter can be applied.

See the App Notifications article for more details.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
integer
oldValues
object or null
operationType
string
startRow
integer
textMatchStyle
string
object
_constructor
string
operator
string
Array of objects
Array
fieldName
string
operator
string
value
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects (Notification)
Array
typedId
string
lastUpdateDate
string <date-time>
dueDate
string <date-time>
isRead
boolean
source
string <= 255 characters
title
string <= 255 characters
message
string <= 4096 characters
version
integer
actionLabel
string or null <= 255 characters
actionType
string <= 255 characters
Possible values: "UNKNOWN" "LINK" "DOWNLOAD" "INFO_MESSAGE" "MESSAGE_LINK" "CTX_LINK"
createdBy
integer
topic
string <= 255 characters
Possible values: "VALIDATION" "CALCULATION" "DATA_DOWNLOAD" "MESSAGE" "GROOVY"
action
string or null <= 2000 characters
recipientID
integer
validUntil
string <date-time> <= 255 characters
status
string <= 255 characters
Possible values: "UNKNOWN" "INFO" "WARNING" "ERROR" "SUCCESS"
createDate
string <date-time>
lastUpdateBy
integer
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "topic",
        • "operator": "equals",
        • "value": "GROOVY"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-f75d74cdc-pg5qh",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 1,
        • "typedId": "937.NTF",
        • "title": "test",
        • "message": "message of the Notification.",
        • "source": "2147493512",
        • "topic": "GROOVY",
        • "status": "WARNING",
        • "actionType": "INFO_MESSAGE",
        • "actionLabel": null,
        • "action": null,
        • "recipientID": 2147490696,
        • "dueDate": "2023-02-26T10:02:00",
        • "validUntil": "2023-01-30T10:02:00",
        • "createDate": "2023-01-27T10:02:59",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2023-01-27T10:03:15",
        • "lastUpdateBy": 2147490696,
        • "isRead": true
        },
      • {
        • "version": 1,
        • "typedId": "936.NTF",
        • "title": "test",
        • "message": "message of the Notification.",
        • "source": "2147493512",
        • "topic": "GROOVY",
        • "status": "WARNING",
        • "actionType": "INFO_MESSAGE",
        • "actionLabel": null,
        • "action": null,
        • "recipientID": 2147490696,
        • "dueDate": "2023-02-26T10:02:00",
        • "validUntil": "2023-01-30T10:02:00",
        • "createDate": "2023-01-27T10:02:59",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2023-01-27T14:11:11",
        • "lastUpdateBy": 2147490696,
        • "isRead": true
        }
      ],
    • "endRow": 300,
    • "totalRows": 2,
    • "status": 0
    }
}