Rule Alert Settings

PATCH /api/rulealert/{id}

Update a RuleAlert record

cURL

curl --request PATCH \
  --url http://localhost/api/api/rulealert/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alert_priority_level": "<string>",
  "created_by": 123,
  "modified_by": 123
}
'

200

{
  "id": 123,
  "rule_title": "<string>",
  "alert_priority_level": "<string>",
  "created_by": 123,
  "modified_by": 123
}

The following API can be used to set the alert priority level for a given rule number. Cases that are created for a certain rule number will be using the pre-set alert priority level. Do note that the alert priority level can either be set to Low, Medium, High or Unrated.

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

id · integer · required

A unique integer value identifying this rule details.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

alert_priority_level · string

Maximum string length: 255

created_by · integer | null

modified_by · integer | null

Response

200 - application/json

id · integer · required · read-only

rule_title · string · required · read-only

alert_priority_level · string

Maximum string length: 255

created_by · integer | null

modified_by · integer | null