Update a Notification Profile by ID
put
/api/notification/Profiles/{id}
Updates the properties of the specified notification profile.
Request
Path Parameters
-
id(required): integer(int32)
The notification profile ID.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BackupEmailPass: string
Backup Email Password. If not defined, the Backup value will be the same as the corresponding Primary value.Example:
abcxyz123@$
-
BackupEmailPort: integer
Backup Email Port. If not defined, the Backup value will be the same as the corresponding Primary value.Example:
25
-
BackupEmailServer: string
Backup Email Server. If not defined, the Backup value will be the same as the corresponding Primary value.Example:
backup.server.com
-
BackupEmailTypeID: integer
Backup Email Type ID. If not defined, the Backup value will be the same as the corresponding Primary value.Example:
1
-
BackupEmailUser: string
Backup Email User. If not defined, the Backup value will be the same as the corresponding Primary value.Example:
backup@email.com
-
ConnectionSecurity: integer
Email Connection Security Flag. If ProfileTypeID is 1 (Email), ConnectionSecurity is required. Allowed Values: - 0 => Plaintext/None - 1 => SSL (Secure on Connect) - 2 => TLS (Negotiated)Example:
0
-
PrimaryEmailPass: string
Primary Email Password. If ProfileTypeID is 1 (Email), PrimaryEmailPass is required.Example:
xyzABC123@
-
PrimaryEmailPort: integer
Primary Email Port. If ProfileTypeID is 1 (Email), PrimaryEmailPort is required.Example:
25
-
PrimaryEmailServer: string
Primary Email Server. If ProfileTypeID is 1 (Email), PrimaryEmailServer is required.Example:
primary.server.com
-
PrimaryEmailTypeID: integer
Primary Email Type ID. If ProfileTypeID is 1 (Email), PrimaryEmailTypeID is required.Example:
1
-
PrimaryEmailUser: string
Primary Email User. If ProfileTypeID is 1 (Email), PrimaryEmailUser is required.Example:
primary@email.com
-
ProfileDescription: string
Profile DescriptionExample:
This is the Generic Unified Assurance Profile for Email
-
ProfileName: string
Profile NameExample:
Generic Email
-
ProfileTypeID: integer
Profile Type ID Allowed values: - 1 => Email - 2 => Syslog - 3 => TrapExample:
1
-
ProfileTypeName: string
Profile Type Name Allowed values: - Email - Syslog - TrapExample:
Email
-
SSLVerify: boolean
Email SSL Verification indicator. If ProfileTypeID is 1 (Email), SSLVerify is required.Example:
1
-
Timeout: integer
Email Connection Timeout. If ProfileTypeID is 1 (Email), Timeout is required.Example:
30
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : notificationProfilesRead
Type:
Show Source
object
-
BackupEmailPass: string
Password for the Backup Email Server userExample:
abcxyz123@$
-
BackupEmailPort: integer
Backup Email Server portExample:
25
-
BackupEmailServer: string
FQDN of Backup Email ServerExample:
backup.server.com
-
BackupEmailTypeID: integer
Backup Email Type IDExample:
1
-
BackupEmailUser: string
User for the Backup Email ServerExample:
backup@email.com
-
ConnectionSecurity: integer
Email Connection Security Flag Allowed Values: - 0 => Plaintext/None - 1 => SSL (Secure on Connect) - 2 => TLS (Negotiated)Example:
0
-
PrimaryEmailPass: string
Password for the Primary Email Server userExample:
xyzABC123@
-
PrimaryEmailPort: integer
Primary Email Server portExample:
25
-
PrimaryEmailServer: string
FQDN of Primary Email ServerExample:
primary.server.com
-
PrimaryEmailTypeID: integer
Primary Email Type IDExample:
1
-
PrimaryEmailUser: string
User for the Primary Email ServerExample:
primary@email.com
-
ProfileDescription: string
Profile DescriptionExample:
This is the Generic Unified Assurance Profile for Email
-
ProfileID: integer
Profile IDExample:
1
-
ProfileName: string
Name for the Notification Profile.Example:
Generic Email
-
ProfileTypeID: integer
ID of Notification Profile Type. Possible values: - 1 => Email - 2 => Syslog - 3 => SNMP TrapExample:
1
-
ProfileTypeName: string
Name of Notification Profile Type.Example:
Email
-
SSLVerify: boolean
Flag to indicate whether SSL certificate authentication is neededExample:
1
-
SyslogPort: integer
Syslog server portExample:
80
-
SyslogServers: string
FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.Example:
oracle.doceng.json.BetterJsonNull@7e8a0192
-
Timeout: integer
Timeout (in seconds) for Email server connectionExample:
30
-
TrapPort: integer
Trap Servers portExample:
oracle.doceng.json.BetterJsonNull@2591f310
-
TrapServers: string
FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.Example:
oracle.doceng.json.BetterJsonNull@25325236
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object