List alerts

GET 
/Alert

List alerts

Request

Query Parameters

pageOptions.page int32

Possible values: >= 1 and <= 2147483647

The 1-based page number for paginated results.

pageOptions.count int32

Possible values: >= 1 and <= 50

The number of items to return per page (1–50).

pageOptions.sortByProperty string

The property name to sort results by.

pageOptions.sortByAscending boolean

When true, sorts results in ascending order; descending otherwise.

pageOptions.searchValues object

Key-value pairs used to filter results.

pageOptions.findCodeToIncludeInPage string

A specific code to locate; the page containing it will be returned.

pageOptions.searchHistoricData boolean

When true, includes soft-deleted or historical records in the results.

startDate date-time

Filters alerts created on or after this date and time.

endDate date-time

Filters alerts created on or before this date and time.

Responses

200

Successfully retrieved alerts.

application/json

Schema

Schema

page int32required

The current page number in the paginated result set.

count int32required

The number of items returned on this page.

hasNextPage booleanrequired

Indicates whether additional pages of results are available after the current page.

hasPreviousPage booleanrequired

Indicates whether pages of results exist before the current page.

totalCount int32required

The total number of items across all pages.

totalPages int32required

The total number of pages available.

items object[]nullable
The collection of items returned for the current page.
Array [
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
createdAt date-timenullablerequired
The date and time when this record was created.
updatedAt date-timenullablerequired
The date and time when this record was last updated.
id int32required
The unique identifier of this record.
alertType int32required
Possible values: [0, 1, 2]
The type classification of the alert.
transactionCode stringnullablerequired
The code of the transaction that triggered this alert.
customerCode stringnullablerequired
The unique code identifying the customer.
description stringnullablerequired
A textual description providing additional details.
alertName stringnullablerequired
The display name of the alert.
priority int32required
Possible values: [0, 1, 2, 3]
The priority level assigned to the alert or action.
status int32required
Possible values: [0, 1, 2, 3, 4, 5]
The current status of this entity.
userGroupCode stringnullablerequired
The code of the user group assigned to handle this alert.
totalStepsCount int32required
The total number of workflow steps associated with this alert.
completedStepsCount int32required
The number of workflow steps that have been completed.
stepCompletion stringnullablerequired
A textual representation of step completion progress (e.g., '2/5').
comments object[]nullable
The list of comments associated with this record.
Array [
id int32required
The unique identifier of this record.
text stringnullablerequired
The text content.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
createdAt date-timenullablerequired
The date and time when this record was created.
]
]

Example (from schema)

{
  "page": 0,
  "count": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "totalCount": 0,
  "totalPages": 0,
  "items": [
    {
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "id": 0,
      "alertType": 0,
      "transactionCode": "string",
      "customerCode": "string",
      "description": "string",
      "alertName": "string",
      "priority": 0,
      "status": 0,
      "userGroupCode": "string",
      "totalStepsCount": 0,
      "completedStepsCount": 0,
      "stepCompletion": "string",
      "comments": [
        {
          "id": 0,
          "text": "string",
          "createdBy": "string",
          "createdAt": "2024-07-29T15:51:28.071Z"
        }
      ]
    }
  ]
}

400

Invalid query parameters.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized access.

404

Not Found

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

Internal server error occurred while processing the request.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...