Get All Scenario Configs

Get All Scenario Configs

Retrieves all notification scenario configurations of an organization

Request
URI
GET
https://{api_host}/notification/api/scenario-configs
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional
Constraints: default: 'notificationScenario.category', 'notificationScenario.name',ASC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageNotificationScenarioConfig of type(s) application/json 
{
    "content": [
        {
            "body": "string",
            "enabled": false,
            "scenarioCategory": "string",
            "scenarioDescription": "string",
            "scenarioId": "string",
            "scenarioName": "string",
            "subject": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ],
    "totalElements": 0,
    "totalPages": 0
}
array of object
content
Optional

The notification scenario configuration to be created or updated

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


401

Unauthorized

Returns PageNotificationScenarioConfig of type(s) application/json 
"PageNotificationScenarioConfig Object"
array of object
content
Optional

The notification scenario configuration to be created or updated

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


403

Forbidden

Returns PageNotificationScenarioConfig of type(s) application/json 
"PageNotificationScenarioConfig Object"
array of object
content
Optional

The notification scenario configuration to be created or updated

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/notification/api/scenario-configs
On This Page
Notification Scenario Configuration Operations
GET
Get All Scenario Configs
PATCH
Patch Config
POST
Create Or Update
DELETE
Delete
GET
Get Scenario Config
POST
Preview Notification Config
POST
Send Test Notification