Get Notification Templates
get
/api/notification/Templates
Gets the notification templates that match the specified parameters. If no parameters are specified, all notification templates 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 : notificationTemplatesRead
Type:
Show Source
object
-
EmailBody: string
Email message bodyExample:
oracle.doceng.json.BetterJsonNull@61f56074
-
EmailFrom: string
Sender email addressExample:
from@email.com
-
EmailSubject: string
Email subjectExample:
oracle.doceng.json.BetterJsonNull@3918a9f9
-
EnterpriseID: string
Enterprise OIDExample:
oracle.doceng.json.BetterJsonNull@4d45ec8c
-
ProfileTypeID: integer
Profile Type IDExample:
1
-
ProfileTypeName: string
Profile Type NameExample:
Syslog
-
SNMPVersion: integer
SNMP VersionExample:
oracle.doceng.json.BetterJsonNull@4fb0884d
-
Syslog: string
Syslog log message templateExample:
oracle.doceng.json.BetterJsonNull@13180cc9
-
TemplateDescription: string
Template DescriptionExample:
This is an example Template Description
-
TemplateID: integer
ID of Notification TemplateExample:
1
-
TemplateName: string
Name of Notification TemplateExample:
Template1
-
Trap_OID0: string
Trap OID 0Example:
oracle.doceng.json.BetterJsonNull@2740c1e
-
Trap_OID1: string
Trap OID 1Example:
oracle.doceng.json.BetterJsonNull@79a81557
-
Trap_OID2: string
Trap OID 2Example:
oracle.doceng.json.BetterJsonNull@67108db4
-
Trap_OID3: string
Trap OID 3Example:
oracle.doceng.json.BetterJsonNull@588931b9
-
Trap_OID4: string
Trap OID 4Example:
oracle.doceng.json.BetterJsonNull@24331ab6
-
Trap_OID5: string
Trap OID 5Example:
oracle.doceng.json.BetterJsonNull@7a8c01ef
-
Trap_OID6: string
Trap OID 6Example:
oracle.doceng.json.BetterJsonNull@73b68d98
-
Trap_OID7: string
Trap OID 7Example:
oracle.doceng.json.BetterJsonNull@11def039
-
Trap_OID8: string
Trap OID 8Example:
oracle.doceng.json.BetterJsonNull@1e5a8278
-
Trap_OID9: string
Trap OID 9Example:
oracle.doceng.json.BetterJsonNull@588d2e90
-
Trap_Value0: string
Trap Value 0Example:
oracle.doceng.json.BetterJsonNull@5e9af5d4
-
Trap_Value1: string
Trap Value 1Example:
oracle.doceng.json.BetterJsonNull@1199ac5
-
Trap_Value2: string
Trap Value 2Example:
oracle.doceng.json.BetterJsonNull@2b9ac1b4
-
Trap_Value3: string
Trap Value 3Example:
oracle.doceng.json.BetterJsonNull@17d28c1d
-
Trap_Value4: string
Trap Value 4Example:
oracle.doceng.json.BetterJsonNull@4041b733
-
Trap_Value5: string
Trap Value 5Example:
oracle.doceng.json.BetterJsonNull@579c15a7
-
Trap_Value6: string
Trap Value 6Example:
oracle.doceng.json.BetterJsonNull@331d645a
-
Trap_Value7: string
Trap Value 7Example:
oracle.doceng.json.BetterJsonNull@12f43d7a
-
Trap_Value8: string
Trap Value 8Example:
oracle.doceng.json.BetterJsonNull@611d6114
-
Trap_Value9: string
Trap Value 9Example:
oracle.doceng.json.BetterJsonNull@1db9572
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