Get Notification Profiles
get
/api/notification/Profiles
Gets the notification profiles that match the specified parameters. If no parameters are specified, all notification profiles are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
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