The notification REST template object represents settings of particular REST API template.
References to notification:rest:template are object references.
The name part of the notification:rest:template object reference has the following components:
- The name of a template.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): content, name.
The action name.
Type
String.
Search
The field is not available for search.
Notes
The action_name cannot be updated.
action_name cannot be written.
The time stamp when a template was added.
Type
Timestamp.
Search
The field is not available for search.
Notes
The added_on cannot be updated.
added_on cannot be written.
The comment for this REST API template.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
The JSON formatted content of a template. The data passed by content creates parameters for a template.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The content is part of the base object.
The event type.
Type
Enum values array.
Search
The field is not available for search.
Notes
The event_type cannot be updated.
event_type cannot be written.
The name of a notification REST template.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
Notes
The name is part of the base object.
The outbound type for the template.
Type
String.
Search
The field is available for search via
Notes
The outbound_type cannot be updated.
outbound_type cannot be written.
The notification REST template parameters.
Type
A/An Notification REST template parameter struct array.
Search
The field is not available for search.
Notes
The parameters cannot be updated.
parameters cannot be written.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| action_name | String | N | Y | N | N/A |
| added_on | Timestamp | N | Y | N | N/A |
| comment | String | N | N | N | N/A |
| content | String | N | N | Y | N/A |
| event_type | [Enum] | N | Y | N | N/A |
| name | String | N | N | Y | : = ~ |
| outbound_type | String | N | Y | N | = |
| parameters | [struct] | N | Y | N | N/A |
| template_type | String | N | Y | N | N/A |
| vendor_identifier | String | N | Y | N | N/A |
