Get alert

GET 
/Alert/:alertId

Get alert

Request

Path Parameters

alertId int32required

The id of the alert

Responses

200

The alert record was found.

application/json

Schema

Schema

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)

{
  "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"
    }
  ]
}

401

Unauthorized access.

404

The alert was 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.

Loading...