Jump to

• Request
• Response

Create a Notification Template

post

/api/notification/Templates

Creates a new notification template.
The minimum required properties in the request body are:

• ProfileTypeID
• TemplateName

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object notificationTemplatesCreate

{
    "allOf":[
        {
            "$ref":"#/components/schemas/notificationTemplatesCreate"
        }
    ],
    "required":[
        "ProfileTypeID",
        "TemplateName"
    ]
}

Nested Schema : notificationTemplatesCreate

Type: object

Show Source

• EmailBody: string
  Email message body

  Example: Example Email Message Body
• EmailFrom: string
  Sender email address

  Example: [e-mail]
• EmailSubject: string
  Email subject

  Example: Example Email Subject
• ProfileTypeID: integer
  Profile Type ID

  Example: 1
• ProfileTypeName: string
  Profile Type Name

  Example: Syslog
• TemplateDescription: string
  Template Description

  Example: This is an example Template Description
• TemplateName: string
  The template name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Template1

{
    "properties":{
        "ProfileTypeID":{
            "description":"Profile Type ID",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Profile Type Name",
            "type":"string",
            "example":"Syslog"
        },
        "TemplateName":{
            "description":"The template name.\n <br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Template1"
        },
        "TemplateDescription":{
            "description":"Template Description",
            "type":"string",
            "example":"This is an example Template Description"
        },
        "EmailFrom":{
            "description":"Sender email address",
            "type":"string",
            "example":"[e-mail]"
        },
        "EmailSubject":{
            "description":"Email subject",
            "type":"string",
            "example":"Example Email Subject"
        },
        "EmailBody":{
            "description":"Email message body",
            "type":"string",
            "example":"Example Email Message Body"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/notificationTemplatesRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/notificationTemplatesRead"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object notificationTemplatesRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/notificationTemplatesRead"
    }
}

Nested Schema : notificationTemplatesRead

Type: object

Show Source

• EmailBody: string
  Email message body

  Example: Attached is a report from Unified Assurance.
• EmailFrom: string
  Sender email address

  Example: [e-mail]
• EmailSubject: string
  Email subject

  Example: Unified Assurance Report: 1234
• EnterpriseID: string
  Enterprise OID

  Example:
• ProfileTypeID: integer
  Profile Type ID

  Example: 1
• ProfileTypeName: string
  Profile Type Name

  Example: Syslog
• SNMPVersion: integer
  SNMP Version

  Example:
• Syslog: string
  Syslog log message template

  Example: $DATE_EPOCH|$MESSAGE|$DNS|$IP|$INSTANCE|$VALUE|$UTIL|$TYPE|$POLLER|$SAMPLERATE|$COMPARE|$STATUS|$METRICID|$STATE|$DEVICENAME
• TemplateDescription: string
  Template Description

  Example: This is an example Template Description
• TemplateID: integer
  ID of Notification Template

  Example: 1
• TemplateName: string
  Name of Notification Template

  Example: Template1
• Trap_OID0: string
  Trap OID 0

  Example:
• Trap_OID1: string
  Trap OID 1

  Example:
• Trap_OID2: string
  Trap OID 2

  Example:
• Trap_OID3: string
  Trap OID 3

  Example:
• Trap_OID4: string
  Trap OID 4

  Example:
• Trap_OID5: string
  Trap OID 5

  Example:
• Trap_OID6: string
  Trap OID 6

  Example:
• Trap_OID7: string
  Trap OID 7

  Example:
• Trap_OID8: string
  Trap OID 8

  Example:
• Trap_OID9: string
  Trap OID 9

  Example:
• Trap_Value0: string
  Trap Value 0

  Example:
• Trap_Value1: string
  Trap Value 1

  Example:
• Trap_Value2: string
  Trap Value 2

  Example:
• Trap_Value3: string
  Trap Value 3

  Example:
• Trap_Value4: string
  Trap Value 4

  Example:
• Trap_Value5: string
  Trap Value 5

  Example:
• Trap_Value6: string
  Trap Value 6

  Example:
• Trap_Value7: string
  Trap Value 7

  Example:
• Trap_Value8: string
  Trap Value 8

  Example:
• Trap_Value9: string
  Trap Value 9

  Example:

{
    "properties":{
        "TemplateID":{
            "description":"ID of Notification Template",
            "type":"integer",
            "example":1
        },
        "ProfileTypeID":{
            "description":"Profile Type ID",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Profile Type Name",
            "type":"string",
            "example":"Syslog"
        },
        "TemplateName":{
            "description":"Name of Notification Template",
            "type":"string",
            "example":"Template1"
        },
        "TemplateDescription":{
            "description":"Template Description",
            "type":"string",
            "example":"This is an example Template Description"
        },
        "EmailFrom":{
            "description":"Sender email address",
            "type":"string",
            "example":"[e-mail]",
            "nullable":true
        },
        "EmailSubject":{
            "description":"Email subject",
            "type":"string",
            "example":"Unified Assurance Report: 1234",
            "nullable":true
        },
        "EmailBody":{
            "description":"Email message body",
            "type":"string",
            "example":"Attached is a report from Unified Assurance.",
            "nullable":true
        },
        "Syslog":{
            "description":"Syslog log message template",
            "type":"string",
            "example":"$DATE_EPOCH|$MESSAGE|$DNS|$IP|$INSTANCE|$VALUE|$UTIL|$TYPE|$POLLER|$SAMPLERATE|$COMPARE|$STATUS|$METRICID|$STATE|$DEVICENAME",
            "nullable":true
        },
        "EnterpriseID":{
            "description":"Enterprise OID",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "SNMPVersion":{
            "description":"SNMP Version",
            "type":"integer",
            "example":"",
            "nullable":true
        },
        "Trap_OID0":{
            "description":"Trap OID 0",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value0":{
            "description":"Trap Value 0",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID1":{
            "description":"Trap OID 1",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value1":{
            "description":"Trap Value 1",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID2":{
            "description":"Trap OID 2",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value2":{
            "description":"Trap Value 2",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID3":{
            "description":"Trap OID 3",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value3":{
            "description":"Trap Value 3",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID4":{
            "description":"Trap OID 4",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value4":{
            "description":"Trap Value 4",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID5":{
            "description":"Trap OID 5",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value5":{
            "description":"Trap Value 5",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID6":{
            "description":"Trap OID 6",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value6":{
            "description":"Trap Value 6",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID7":{
            "description":"Trap OID 7",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value7":{
            "description":"Trap Value 7",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID8":{
            "description":"Trap OID 8",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value8":{
            "description":"Trap Value 8",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_OID9":{
            "description":"Trap OID 9",
            "type":"string",
            "example":"",
            "nullable":true
        },
        "Trap_Value9":{
            "description":"Trap Value 9",
            "type":"string",
            "example":"",
            "nullable":true
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top