REST API for Unified Assurance Core

Update a Template by ID

put

/api/notification/Templates/{id}

Updates the properties of the notification template that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The notification template ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

EmailBody: string

Email message body

Example: Example Email Message Body
EmailFrom: string

Sender email address

Example: from@email.com
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

Template Name

Example: Template1

{
    "properties":{
        "ProfileTypeID":{
            "description":"Profile Type ID",
            "type":"integer",
            "example":1
        },
        "ProfileTypeName":{
            "description":"Profile Type Name",
            "type":"string",
            "example":"Syslog"
        },
        "TemplateName":{
            "description":"Template Name",
            "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":"from@email.com"
        },
        "EmailSubject":{
            "description":"Email subject",
            "type":"string",
            "example":"Example Email Subject"
        },
        "EmailBody":{
            "description":"Email message body",
            "type":"string",
            "example":"Example Email Message Body"
        }
    },
    "type":"object"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulUpdateOperation
object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "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 : SuccessfulUpdateOperation

Type: object

Show Source

message: string

The response message.

Example: Updated record
success: boolean

Whether the operation was a success (true) or a failure (false).

Example: true

{
    "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":"Updated 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: oracle.doceng.json.BetterJsonNull@61f56074
EmailFrom: string

Sender email address

Example: from@email.com
EmailSubject: string

Email subject

Example: oracle.doceng.json.BetterJsonNull@3918a9f9
EnterpriseID: string

Enterprise OID

Example: oracle.doceng.json.BetterJsonNull@4d45ec8c
ProfileTypeID: integer

Profile Type ID

Example: 1
ProfileTypeName: string

Profile Type Name

Example: Syslog
SNMPVersion: integer

SNMP Version

Example: oracle.doceng.json.BetterJsonNull@4fb0884d
Syslog: string

Syslog log message template

Example: oracle.doceng.json.BetterJsonNull@13180cc9
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: oracle.doceng.json.BetterJsonNull@2740c1e
Trap_OID1: string

Trap OID 1

Example: oracle.doceng.json.BetterJsonNull@79a81557
Trap_OID2: string

Trap OID 2

Example: oracle.doceng.json.BetterJsonNull@67108db4
Trap_OID3: string

Trap OID 3

Example: oracle.doceng.json.BetterJsonNull@588931b9
Trap_OID4: string

Trap OID 4

Example: oracle.doceng.json.BetterJsonNull@24331ab6
Trap_OID5: string

Trap OID 5

Example: oracle.doceng.json.BetterJsonNull@7a8c01ef
Trap_OID6: string

Trap OID 6

Example: oracle.doceng.json.BetterJsonNull@73b68d98
Trap_OID7: string

Trap OID 7

Example: oracle.doceng.json.BetterJsonNull@11def039
Trap_OID8: string

Trap OID 8

Example: oracle.doceng.json.BetterJsonNull@1e5a8278
Trap_OID9: string

Trap OID 9

Example: oracle.doceng.json.BetterJsonNull@588d2e90
Trap_Value0: string

Trap Value 0

Example: oracle.doceng.json.BetterJsonNull@5e9af5d4
Trap_Value1: string

Trap Value 1

Example: oracle.doceng.json.BetterJsonNull@1199ac5
Trap_Value2: string

Trap Value 2

Example: oracle.doceng.json.BetterJsonNull@2b9ac1b4
Trap_Value3: string

Trap Value 3

Example: oracle.doceng.json.BetterJsonNull@17d28c1d
Trap_Value4: string

Trap Value 4

Example: oracle.doceng.json.BetterJsonNull@4041b733
Trap_Value5: string

Trap Value 5

Example: oracle.doceng.json.BetterJsonNull@579c15a7
Trap_Value6: string

Trap Value 6

Example: oracle.doceng.json.BetterJsonNull@331d645a
Trap_Value7: string

Trap Value 7

Example: oracle.doceng.json.BetterJsonNull@12f43d7a
Trap_Value8: string

Trap Value 8

Example: oracle.doceng.json.BetterJsonNull@611d6114
Trap_Value9: string

Trap Value 9

Example: oracle.doceng.json.BetterJsonNull@1db9572

{
    "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":"from@email.com",
            "nullable":true
        },
        "EmailSubject":{
            "description":"Email subject",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "EmailBody":{
            "description":"Email message body",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Syslog":{
            "description":"Syslog log message template",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "EnterpriseID":{
            "description":"Enterprise OID",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "SNMPVersion":{
            "description":"SNMP Version",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "Trap_OID0":{
            "description":"Trap OID 0",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value0":{
            "description":"Trap Value 0",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID1":{
            "description":"Trap OID 1",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value1":{
            "description":"Trap Value 1",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID2":{
            "description":"Trap OID 2",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value2":{
            "description":"Trap Value 2",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID3":{
            "description":"Trap OID 3",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value3":{
            "description":"Trap Value 3",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID4":{
            "description":"Trap OID 4",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value4":{
            "description":"Trap Value 4",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID5":{
            "description":"Trap OID 5",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value5":{
            "description":"Trap Value 5",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID6":{
            "description":"Trap OID 6",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value6":{
            "description":"Trap Value 6",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID7":{
            "description":"Trap OID 7",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value7":{
            "description":"Trap Value 7",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID8":{
            "description":"Trap OID 8",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value8":{
            "description":"Trap Value 8",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_OID9":{
            "description":"Trap OID 9",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "Trap_Value9":{
            "description":"Trap Value 9",
            "type":"string",
            "example":null,
            "nullable":true
        }
    },
    "type":"object"
}

Default Response

Failed operation

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":{
                "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

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

Nested Schema : items

Type: object