List Portfolio Event Rules

Request

Get all notification eventRules for the given portfolioId. Notification event rules allow you to control which events you wish to monitor for the companies contained within the given portfolio.

Security

bearerToken

Path

portfolioIdnumberrequired

The unique identifier for the portfolio that you wish to retrieve notification event rules for, obtained from /portfolios.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

Array [

isActiveboolean

Shows whether the notification event rule has been enabled for the given portfolio.

Example:0

ruleCodenumber

The unique identifier for the notification event rule.

Example:101

ruleCountryCodestring

The ISO/Alpha 2 format country code for the notification event rule. "XX" is used for global rules that apply to companies from all countries.

Example:"XX"

ruleTypenumber

The unique identifier of the ruleType for the notification event rule.

Example:4

ruleTypeNamestring

A short description of the ruleType for the notification event rule.

Example:"Rating band change - 3 input"

namestring

The name for the notification event rule.

Example:"International Rating | Reduce by {0} Band(s) OR Less than Band {1}"

param0string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:"1"

param1string

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:"A"

param2boolean

Some notification event rules may include input parameters used to tailor the notifications generated to your preference.

Example:true

]

Response

[
  {
    "isActive": 0,
    "ruleCode": 101,
    "ruleCountryCode": "XX",
    "ruleType": 4,
    "ruleTypeName": "Rating band change - 3 input",
    "name": "International Rating | Reduce by {0} Band(s) OR Less than Band {1}",
    "param0": "1",
    "param1": "A",
    "param2": true
  }
]