Skip to content
Stable

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Time Keeper API

The Time Keeper API enables the caller to define and manage context events. Context events are used to record significant events that affect the performance of systems, people and organizations - and hence impact data values.

Key Features

The Time Keeper API provides the following capabilities:

  • Context Event Management: Support for creating, updating, and deleting context events, including creation from templates to ensure consistency across the ecosystem.
  • Hierarchical and Related Events: Capabilities for linking context events together to represent dependent or related event structures.
  • Evidence Tracking: Linking context events to the evidence (e.g., reports, logs) that confirms the event occurred.
  • Impact Analysis: Associating context events with the metadata elements they impact, helping users understand the scope of an event's influence.
  • Timeline Effects: Linking context events to elements whose timeline or performance is affected by the event.
  • Search and Discovery: Finding context events by name, search strings, or GUIDs.

Further information

Sample REST API requests can be found in Egeria-api-time-keeper.http.


Raise an issue or comment below