Class: Response

The Response Elements object describes characteristics of an API response.

 classDiagram
    class Response
    click Response href "../Response/"
      Object <|-- Response
        click Object href "../Object/"

      Response : code

      Response : containers





        Response --> "*" Container : containers
        click Container href "../Container/"



      Response : data

      Response : error

      Response : error_message

      Response : flags

      Response : message

Inheritance

OcsfObject
- Object
  - Response

Slots

Name	Cardinality and Range	Description	Inheritance
code	0..1 recommended Integer	The numeric response sent to a request	direct
containers	* Container	When working with containerized applications, the set of containers which wri...	direct
data	0..1 String	The additional data that is associated with the api response	direct
error	0..1 recommended String	Error Code	direct
error_message	0..1 recommended String	Error Message	direct
flags	* String	The communication flags that are associated with the api response	direct
message	0..1 recommended String	The description of the event/finding, as defined by the source	direct

Usages

used by	used in	type	used
Api	response	range	Response
RdpActivity	response	range	Response
SmbActivity	response	range	Response

In Subsets

objects_subset

Aliases

Response Elements

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/ocsf

Mappings

Mapping Type	Mapped Value
self	ocsf:Response
native	ocsf:Response

LinkML Source

Direct

name: Response
description: The Response Elements object describes characteristics of an API response.
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Response Elements
is_a: Object
slots:
- code
- containers
- data
- error
- error_message
- flags
- message
slot_usage:
  code:
    name: code
    recommended: true
  data:
    name: data
    description: The additional data that is associated with the api response.
  error:
    name: error
    recommended: true
  error_message:
    name: error_message
    recommended: true
  flags:
    name: flags
    description: The communication flags that are associated with the api response.
  message:
    name: message
    recommended: true

Induced

name: Response
description: The Response Elements object describes characteristics of an API response.
in_subset:
- objects_subset
from_schema: https://w3id.org/lmodel/ocsf
aliases:
- Response Elements
is_a: Object
slot_usage:
  code:
    name: code
    recommended: true
  data:
    name: data
    description: The additional data that is associated with the api response.
  error:
    name: error
    recommended: true
  error_message:
    name: error_message
    recommended: true
  flags:
    name: flags
    description: The communication flags that are associated with the api response.
  message:
    name: message
    recommended: true
attributes:
  code:
    name: code
    description: The numeric response sent to a request.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Response Code
    rank: 1000
    alias: code
    owner: Response
    domain_of:
    - Response
    - EndpointConnection
    - HttpResponse
    - LoadBalancer
    range: integer
    recommended: true
  containers:
    name: 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.'
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Containers
    rank: 1000
    alias: containers
    owner: Response
    domain_of:
    - Request
    - Response
    range: Container
    multivalued: true
  data:
    name: data
    description: The additional data that is associated with the api response.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Data
    rank: 1000
    alias: data
    owner: Response
    domain_of:
    - Request
    - Response
    - TlsExtension
    - Resource
    - ApplicationObject
    - Edge
    - Enrichment
    - Evidences
    - ManagedEntity
    - Node
    - Policy
    - QueryInfo
    - WebResource
    - RegValue
    range: string
  error:
    name: error
    description: Error Code
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Error Code
    rank: 1000
    alias: error
    owner: Response
    domain_of:
    - Response
    - FunctionInvocation
    range: string
    recommended: true
  error_message:
    name: error_message
    description: Error Message
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Error Message
    rank: 1000
    alias: error_message
    owner: Response
    domain_of:
    - Response
    - Scim
    - LoadBalancer
    range: string
    recommended: true
  flags:
    name: flags
    description: The communication flags that are associated with the api response.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Flags
    rank: 1000
    alias: flags
    owner: Response
    domain_of:
    - Request
    - Response
    - Trace
    - DceRpc
    - DnsAnswer
    range: string
    multivalued: true
  message:
    name: message
    description: The description of the event/finding, as defined by the source.
    from_schema: https://w3id.org/lmodel/ocsf
    aliases:
    - Message
    rank: 1000
    alias: message
    owner: Response
    domain_of:
    - Response
    - Span
    - HttpResponse
    - LoadBalancer
    - BaseEvent
    - ApplicationError
    range: string
    recommended: true