API

JSON

            
{
  "caption": "API",
  "description": "The API, or Application Programming Interface, object represents  information pertaining to an API request and response.",
  "extends": "object",
  "name": "api",
  "attributes": {
    "group": {
      "description": "The information pertaining to the API group.",
      "requirement": "optional",
      "caption": "Group",
      "type": "group"
    },
    "operation": {
      "requirement": "required",
      "caption": "Operation",
      "description": "Verb/Operation associated with the request",
      "type": "string_t"
    },
    "request": {
      "description": "Details pertaining to the API request.",
      "requirement": "recommended",
      "caption": "API Request Details",
      "type": "request"
    },
    "response": {
      "description": "Details pertaining to the API response.",
      "requirement": "recommended",
      "caption": "API Response Details",
      "type": "response"
    },
    "service": {
      "description": "The information pertaining to the API service.",
      "requirement": "optional",
      "caption": "Service",
      "type": "service"
    },
    "version": {
      "description": "The version of the API service.",
      "requirement": "optional",
      "caption": "Version",
      "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
    }
  }
}