Time Span

timespan

The Time Span object represents different time period durations. If a timespan is fractional, i.e. crosses one period, e.g. a week and 3 days, more than one may may be populated since each member is of integral type. In that case type_id if present should be set to Other.

Contents

Attributes

Caption Name Type Is Array Default Description
Duration Milliseconds duration Long The duration of the time span in milliseconds.
Duration Days duration_days Integer The duration of the time span in days.
Duration Hours duration_hours Integer The duration of the time span in hours.
Duration Minutes duration_mins Integer The duration of the time span in minutes.
Duration Months duration_months Integer The duration of the time span in months.
Duration Seconds duration_secs Integer The duration of the time span in seconds.
Duration Weeks duration_weeks Integer The duration of the time span in weeks.
Duration Years duration_years Integer The duration of the time span in years.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Time Span Type type String The type of time span duration the object represents.
Time Span Type ID type_id Integer The normalized identifier for the time span duration type.
0
Unknown
1
Milliseconds
2
Seconds
3
Minutes
4
Hours
5
Days
6
Weeks
7
Months
8
Years
99
Other
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

Time Span

JSON

            
{
  "caption": "Time Span",
  "name": "timespan",
  "description": "The Time Span object represents different time period durations. If a timespan is fractional, i.e. crosses one period, e.g. a week and 3 days, more than one may may be populated since each member is of integral type. In that case <code>type_id</code> if present should be set to <code>Other</code>.",
  "extends": "object",
  "attributes": {
    "duration": {
      "description": "The duration of the time span in milliseconds.",
      "requirement": "recommended",
      "caption": "Duration Milliseconds",
      "type": "long_t"
    },
    "duration_days": {
      "description": "The duration of the time span in days.",
      "requirement": "recommended",
      "caption": "Duration Days",
      "type": "integer_t"
    },
    "duration_hours": {
      "description": "The duration of the time span in hours.",
      "requirement": "recommended",
      "caption": "Duration Hours",
      "type": "integer_t"
    },
    "duration_mins": {
      "description": "The duration of the time span in minutes.",
      "requirement": "recommended",
      "caption": "Duration Minutes",
      "type": "integer_t"
    },
    "duration_months": {
      "description": "The duration of the time span in months.",
      "requirement": "recommended",
      "caption": "Duration Months",
      "type": "integer_t"
    },
    "duration_secs": {
      "description": "The duration of the time span in seconds.",
      "requirement": "recommended",
      "caption": "Duration Seconds",
      "type": "integer_t"
    },
    "duration_weeks": {
      "description": "The duration of the time span in weeks.",
      "requirement": "recommended",
      "caption": "Duration Weeks",
      "type": "integer_t"
    },
    "duration_years": {
      "description": "The duration of the time span in years.",
      "requirement": "recommended",
      "caption": "Duration Years",
      "type": "integer_t"
    },
    "type": {
      "caption": "Time Span Type",
      "description": "The type of time span duration the object represents.",
      "requirement": "optional",
      "type": "string_t"
    },
    "type_id": {
      "caption": "Time Span Type ID",
      "description": "The normalized identifier for the time span duration type.",
      "enum": {
        "0": {
          "caption": "Unknown",
          "description": "The type is unknown."
        },
        "1": {
          "caption": "Milliseconds"
        },
        "2": {
          "caption": "Seconds"
        },
        "3": {
          "caption": "Minutes"
        },
        "4": {
          "caption": "Hours"
        },
        "5": {
          "caption": "Days"
        },
        "6": {
          "caption": "Weeks"
        },
        "7": {
          "caption": "Months"
        },
        "8": {
          "caption": "Years"
        },
        "99": {
          "caption": "Other",
          "description": "The type is not mapped. See the <code>type</code> attribute, which contains a data source specific value."
        }
      },
      "requirement": "recommended",
      "sibling": "type",
      "type": "integer_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
    }
  },
  "constraints": {
    "at_least_one": [
      "duration",
      "duration_days",
      "duration_hours",
      "duration_mins",
      "duration_months",
      "duration_secs",
      "duration_weeks",
      "duration_years"
    ]
  }
}