Get Scenario

Get Scenario

Retrieves notification scenarios

Request

URI

GET

https://{api_host}/notification/api/scenarios/{id}

COPY

Path Parameters

string

id

Required

Notification scenario ID

Query Parameters

boolean

expandBody

Optional

The 'body' field of each scenario will be retrieved.

Authentication

This operation uses the following authentication methods.

Responses

200

OK

Returns NotificationScenario of type(s) application/json

{
    "body": "string",
    "category": "string",
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "entitySchema": {
        "$data": "string",
        "$dynamicDefault": "string",
        "$ref": "string",
        "additionalProperties": false,
        "allOf": [
            "JsonSchemaImpl Object"
        ],
        "anyOf": [
            "JsonSchemaImpl Object"
        ],
        "const": {},
        "default": {},
        "description": "string",
        "encrypted": false,
        "enum": [
            {}
        ],
        "format": "string",
        "formatMaximum": "string",
        "formatMinimum": "string",
        "items": "ObjectOrListJsonSchemaImpl Object",
        "maxItems": 0,
        "maxLength": 0,
        "maxProperties": 0,
        "maximum": "number",
        "minItems": 0,
        "minLength": 0,
        "minProperties": 0,
        "minimum": "number",
        "not": "JsonSchemaImpl Object",
        "oneOf": [
            "JsonSchemaImpl Object"
        ],
        "pattern": "string",
        "patternProperties": {
            "patternProperties": "JsonSchemaImpl Object"
        },
        "properties": {
            "properties": "JsonSchemaImpl Object"
        },
        "readOnly": false,
        "required": [
            "string"
        ],
        "title": "string",
        "type": "string",
        "uniqueItems": false,
        "writeOnly": false
    },
    "id": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "subject": "string"
}

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

string

category

Optional

Constraints: maxLength: 1024

Notification scenario category

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

string

description

Optional

Constraints: maxLength: 2000

Notification scenario description

object

entitySchema

Optional

Schema describing a policy object of this type

string

id

Required

Notification scenario id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

string

name

Required

Constraints: maxLength: 1024

Notification scenario name

string

subject

Required

Constraints: maxLength: 998

Notification scenario subject

401

Unauthorized

Returns NotificationScenario of type(s) application/json

"NotificationScenario Object"

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

string

category

Optional

Constraints: maxLength: 1024

Notification scenario category

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

string

description

Optional

Constraints: maxLength: 2000

Notification scenario description

object

entitySchema

Optional

Schema describing a policy object of this type

string

id

Required

Notification scenario id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

string

name

Required

Constraints: maxLength: 1024

Notification scenario name

string

subject

Required

Constraints: maxLength: 998

Notification scenario subject

404

Not Found

Returns NotificationScenario of type(s) application/json

"NotificationScenario Object"

string

body

Optional

Constraints: maxLength: 30000

Notification scenario body

string

category

Optional

Constraints: maxLength: 1024

Notification scenario category

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

Created By

string

description

Optional

Constraints: maxLength: 2000

Notification scenario description

object

entitySchema

Optional

Schema describing a policy object of this type

string

id

Required

Notification scenario id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

string

name

Required

Constraints: maxLength: 1024

Notification scenario name

string

subject

Required

Constraints: maxLength: 998

Notification scenario subject

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/notification/api/scenarios/{id}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Notification Scenario Operations