Content Comparison

GET notification_sets/meta

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns meta data information for Notification Set configuration.

Resource URL

http://{host}/api/2.0/notification_sets/meta/.format

Example Request

GET

http://44.235.52.211/api/2.0/notification_sets/meta/.json

Code Block

language	json

{
    "EventSeverities": {
        "1": "Critical",
        "2": "Major",
        "3": "Minor",
        "4": "Warning",
        "5": "Notice",
        "6": "Info",
        "7": "Keep Alive"
    },
    "NotificationAgentTypes": {
        "2": {
            "title": "display",
            "max_per_set": "1"
        },
        "4": {
            "title": "snmp",
            "max_per_set": "3"
        },
        "5": {
            "title": "email",
            "max_per_set": "3"
        },
        "12": {
            "title": "syslog",
            "max_per_set": "3"
        },
        "15": {
            "title": "file",
            "max_per_set": "3"
        },
        "21": {
            "title": "errorDisplay",
            "max_per_set": "3"
        },
        "22": {
            "title": "audioAlarm",
            "max_per_set": "3"
        }
    }
}

GET notification_sets

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of Notification Sets configurations.

Resource URL

http://{host}/api/2.0/notification_sets/.format

Example Request

GET

http://44.235.52.211/api/2.0/notification_sets/.json

Code Block

language	json

[
    {
        "NotificationSet": {
            "id": 1,
            "title": "Default",
            "modified": "1612414794578",
            "created": "1611142282208"
        }
    },
    {
        "NotificationSet": {
            "id": 2,
            "title": "System Events",
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    }
]

GET notification_sets/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a detailed single specific Notification Set configuration data.

Resource URL

http://{host}/api/2.0/notification_sets/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Notification Set to be viewed.

Example Request

GET

http://44.235.52.211/api/2.0/notification_sets/1/.json

Code Block

language	json

{
    "NotificationSet": {
        "id": 1,
        "title": "Default",
        "modified": "1612414794578",
        "created": "1611142282208",
        "NotificationSetEntry": [
            {
                "id": 5,
                "notification_agent_type_id": 2,
                "notification_agent_id": 1,
                "event_severity_id": 1
            },
            {
                "id": 9,
                "notification_agent_type_id": 4,
                "notification_agent_id": 1,
                "event_severity_id": 1
            },
            {
                "id": 14,
                "notification_agent_type_id": 5,
                "notification_agent_id": 1,
                "event_severity_id": 1
            }
        ]
    }
}

POST notification_sets

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new Notification Set.

Resource URL

http://{host}/api/2.0/notification_sets/.format

Example Request

POST

http://44.235.52.211/api/2.0/notification_sets/.json

Body

Code Block

language	json

{"NotificationSet": {
        "id": "",
        "title": "New Notification Set"
}}

Response

Code Block

language	json

{
    "NotificationSet": {
        "id": 5,
        "title": "New Notification Set",
        "modified": "1619516920875",
        "created": "1619516920875",
        "NotificationSetEntry": []
    }
}

POST notification_sets/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Duplicates a specific Notification Set into a new one, preserving all data except for title.

Resource URL

http://{host}/api/2.0/notification_sets/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Notification Set to be copied.

Example Request

POST

http://44.235.52.211/api/2.0/notification_sets/1/.json

Code Block

language	json

{
    "NotificationSet": {
        "id": 6,
        "title": "Default_2",
        "modified": "1619517136622",
        "created": "1619517136609",
        "NotificationSetEntry": [
            {
                "id": 15,
                "notification_agent_type_id": 2,
                "notification_agent_id": 1,
                "event_severity_id": 1
            },
            {
                "id": 16,
                "notification_agent_type_id": 4,
                "notification_agent_id": 1,
                "event_severity_id": 1
            },
            {
                "id": 17,
                "notification_agent_type_id": 5,
                "notification_agent_id": 1,
                "event_severity_id": 1
            }
        ]
    }
}

PUT notification_sets/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates a single specific Notification Set.

Resource URL

http://{host}/api/2.0/notification_sets/{id}/.format

Parameters

Parameter	Data Type	Description
1 (required)	integer	The ID of the desired Notification Set to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/notification_sets/6/.json

Body

Code Block

language	json

{
    "NotificationSet": {
        "id": 6,
        "title": "EDIT_Set",
        "NotificationSetEntry": [
            {
                "id": 15,
                "notification_agent_type_id": 2,
                "notification_agent_id": 1,
                "event_severity_id": 1
            }
        ]
    }
}

Response

Code Block

language	json

{
    "NotificationSet": {
        "id": 4,
        "title": "EDIT_Set",
        "modified": "1620723183393",
        "created": "1611142282208",
        "NotificationSetEntry": [
            {
                "id": 15,
                "notification_agent_type_id": 2,
                "notification_agent_id": 1,
                "event_severity_id": 1
            }
        ]
    }
}

DELETE notification_sets/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes a single specific Notification Set.

Resource URL

http://{host}/api/2.0/notification_sets/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired Notification Set to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/notification_sets/6/.json

Code Block

language	json

{
    "success": true
}

Version	Old Version 1	New Version 2
Changes made by	Ramya Raman (Unlicensed)	Ramya Raman (Unlicensed)
Saved on	May 11, 2021	May 16, 2021

Versions Compared

Key

GET notification_sets/meta

Resource Information

Resource URL

Example Request

GET notification_sets

Resource Information

Resource URL

Example Request

GET notification_sets/{id}

Resource Information

Resource URL

Parameters

Example Request

POST notification_sets

Resource Information

Resource URL

Example Request

POST notification_sets/{id}

Resource Information

Resource URL

Parameters

Example Request

PUT notification_sets/{id}

Resource Information

Resource URL

Parameters

Example Request

DELETE notification_sets/{id}

Resource Information

Resource URL

Parameters

Example Request