The Response Elements object describes characteristics of an API response.
Attributes
Section titled “Attributes”code
- Type:
integer_t - Requirement: recommended
The numeric response sent to a request.
error
- Type:
string_t - Requirement: recommended
Error Code
error_message
- Type:
string_t - Requirement: recommended
Error Message
message
- Type:
string_t - Requirement: recommended
The description of the event/finding, as defined by the source.
containers
- Type:
container - Requirement: optional
When working with containerized applications, the set of containers which write to the standard the output of a particular logging driver. For example, this may be the set of containers involved in handling api requests and responses for a containerized application.
data
- Type:
json_t - Requirement: optional
The additional data that is associated with the api response.
flags
- Type:
string_t - Requirement: optional
The communication flags that are associated with the api response.