Response Elements

response

The Response Elements object describes characteristics of an API response.

Contents

Attributes

Caption Name Type Is Array Default Description
Response Code code Integer The numeric response sent to a request.
Containers containers Container 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 data JSON The additional data that is associated with the api response.
Error Code error String Error Code
Error Message error_message String Error Message
Flags flags String The list of communication flags, normalized to the captions of the flag_ids values. In the case of 'Other', they are defined by the event source.
Message message String The description of the event/finding, as defined by the source.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

References

Referenced By

Context

Response Elements

JSON

            
{
  "caption": "Response Elements",
  "description": "The Response Elements object describes characteristics of an API response.",
  "extends": "object",
  "name": "response",
  "attributes": {
    "code": {
      "requirement": "recommended",
      "caption": "Response Code",
      "description": "The numeric response sent to a request.",
      "type": "integer_t"
    },
    "containers": {
      "requirement": "optional",
      "caption": "Containers",
      "description": "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.",
      "is_array": true,
      "type": "container"
    },
    "data": {
      "description": "The additional data that is associated with the api response.",
      "requirement": "optional",
      "caption": "Data",
      "type": "json_t"
    },
    "error": {
      "requirement": "recommended",
      "caption": "Error Code",
      "description": "Error Code",
      "type": "string_t"
    },
    "error_message": {
      "requirement": "recommended",
      "caption": "Error Message",
      "description": "Error Message",
      "type": "string_t"
    },
    "flags": {
      "requirement": "optional",
      "caption": "Flags",
      "description": "The list of communication flags, normalized to the captions of the flag_ids values. In the case of 'Other', they are defined by the event source.",
      "is_array": true,
      "type": "string_t"
    },
    "message": {
      "requirement": "recommended",
      "caption": "Message",
      "description": "The description of the event/finding, as defined by the source.",
      "type": "string_t"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    },
    "unmapped": {
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    }
  }
}