Package org.odpi.openmetadata.viewservices.timekeeper.server.spring

Class TimeKeeperResource

java.lang.Object
org.odpi.openmetadata.viewservices.timekeeper.server.spring.TimeKeeperResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class TimeKeeperResource extends Object
The TimeKeeperResource provides part of the server-side implementation of the Time Keeper OMVS. =

  • Constructor Details

    • TimeKeeperResource

      public TimeKeeperResource()
      Default constructor

  • Method Details

    • createContextEvent

      @PostMapping(path="/context-events") public GUIDResponse createContextEvent(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a context event.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the context event.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createContextEventFromTemplate

      @PostMapping(path="/context-events/from-template") public GUIDResponse createContextEventFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a context event using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateContextEvent

      @PostMapping(path="/context-events/{contextEventGUID}/update") public BooleanResponse updateContextEvent(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a context event.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the contextEvent (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDependentContextEvents

      @PostMapping(path="/context-events/{parentContextEventGUID}/dependent-context-events/{childContextEventGUID}/attach") public VoidResponse linkDependentContextEvents(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentContextEventGUID, @PathVariable String childContextEventGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect two context events to show that one is dependent on another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      parentContextEventGUID - unique identifier of the parent context event
      childContextEventGUID - unique identifier of the chile context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDependentContextEvents

      @PostMapping(path="/context-events/{parentContextEventGUID}/dependent-context-events/{childContextEventGUID}/detach") public VoidResponse detachDependentContextEvents(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentContextEventGUID, @PathVariable String childContextEventGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach two dependent context events from one another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      parentContextEventGUID - unique identifier of the parent context event
      childContextEventGUID - unique identifier of the child context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkRelatedContextEvents

      @PostMapping(path="/context-events/{contextEventOneGUID}/related-context-events/{contextEventTwoGUID}/attach") public VoidResponse linkRelatedContextEvents(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventOneGUID, @PathVariable String contextEventTwoGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect two context events to show that one is related to the other.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventOneGUID - unique identifier of the context event at end 1
      contextEventTwoGUID - unique identifier of the context event at end 2
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachRelatedContextEvents

      @PostMapping(path="/context-events/{contextEventOneGUID}/related-context-events/{contextEventTwoGUID}/detach") public VoidResponse detachRelatedContextEvents(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventOneGUID, @PathVariable String contextEventTwoGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach two context events that are related to one another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventOneGUID - unique identifier of the context event at end 1
      contextEventTwoGUID - unique identifier of the context event at end 2
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventEvidence

      @PostMapping(path="/context-events/{contextEventGUID}/evidence/{evidenceGUID}/attach") public VoidResponse linkContextEventEvidence(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @PathVariable String evidenceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect a context event to an element that provides evidence that this context event is real.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      evidenceGUID - unique identifier of the element representing the evidence
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventEvidence

      @PostMapping(path="/context-events/{contextEventGUID}/evidence/{evidenceGUID}/detach") public VoidResponse detachContextEventEvidence(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @PathVariable String evidenceGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element that provides evidence that this context event is real.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      evidenceGUID - unique identifier of the element representing the evidence
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventImpact

      @PostMapping(path="/context-events/{contextEventGUID}/impacts/{impactedElementGUID}/attach") public VoidResponse linkContextEventImpact(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @PathVariable String impactedElementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect a context event to an element that is impacted by this event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      impactedElementGUID - unique identifier of the element that is impacted by the event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventImpact

      @PostMapping(path="/context-events/{contextEventGUID}/impacts/{impactedElementGUID}/detach") public VoidResponse detachContextEventImpact(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @PathVariable String impactedElementGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element that is impacted by the event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      impactedElementGUID - unique identifier of the element that is impacted by the event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventTimelineEffect

      @PostMapping(path="/elements/{timelineAffectedElementGUID}/context-events-describing-timeline-effects/{contextEventGUID}/attach") public VoidResponse linkContextEventTimelineEffect(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String timelineAffectedElementGUID, @PathVariable String contextEventGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect a context event to an element whose data is impacted by this event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      timelineAffectedElementGUID - unique identifier of the element whose data is impacted by the context event
      contextEventGUID - unique identifier of the context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventTimelineEffect

      @PostMapping(path="/elements/{timelineAffectedElementGUID}/context-events-describing-timeline-effect/{contextEventGUID}/detach") public VoidResponse detachContextEventTimelineEffect(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String timelineAffectedElementGUID, @PathVariable String contextEventGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element whose data is impacted by the event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      timelineAffectedElementGUID - unique identifier of the element whose data is impacted by the context event
      contextEventGUID - unique identifier of the context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteContextEvent

      @PostMapping(path="/context-events/{contextEventGUID}/delete") public VoidResponse deleteContextEvent(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a context event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getContextEventsByName

      @PostMapping(path="/context-events/by-name") public OpenMetadataRootElementsResponse getContextEventsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of contextEvents with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findContextEvents

      @PostMapping(path="/context-events/by-search-string") public OpenMetadataRootElementsResponse findContextEvents(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of contextEvent metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getContextEventByGUID

      @PostMapping(path="/context-events/{contextEventGUID}/retrieve") public OpenMetadataRootElementResponse getContextEventByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String contextEventGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific context event.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)