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

Class ExternalReferencesResource

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

  • Constructor Details

    • ExternalReferencesResource

      public ExternalReferencesResource()
      Default constructor

  • Method Details

    • createExternalReference

      @PostMapping(path="/external-references") public GUIDResponse createExternalReference(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create an external reference.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the external reference.
      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.

    • createExternalReferenceFromTemplate

      @PostMapping(path="/external-references/from-template") public GUIDResponse createExternalReferenceFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent an external reference 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)

    • updateExternalReference

      @PostMapping(path="/external-references/{externalReferenceGUID}/update") public VoidResponse updateExternalReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String externalReferenceGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of an external reference.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      externalReferenceGUID - unique identifier of the external reference (returned from create)
      requestBody - properties for the new element.
      Returns:
      void 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.

    • linkExternalReference

      @PostMapping(path="/elements/{elementGUID}/external-references/{externalReferenceGUID}/attach") public VoidResponse linkExternalReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an external reference to an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • detachExternalReference

      @PostMapping(path="/elements/{elementGUID}/external-references/{externalReferenceGUID}/detach") public VoidResponse detachExternalReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach an external reference from an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • linkMediaReference

      @PostMapping(path="/elements/{elementGUID}/media-references/{externalReferenceGUID}/attach") public VoidResponse linkMediaReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an external media reference to an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • detachMediaReference

      @PostMapping(path="/elements/{elementGUID}/media-references/{externalReferenceGUID}/detach") public VoidResponse detachMediaReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach an external media reference from an element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • linkCitedDocumentReference

      @PostMapping(path="/elements/{elementGUID}/cited-document-references/{externalReferenceGUID}/attach") public VoidResponse linkCitedDocumentReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an element to its external document reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • detachCitedDocumentReference

      @PostMapping(path="/elements/{elementGUID}/cited-document-references/{externalReferenceGUID}/detach") public VoidResponse detachCitedDocumentReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach an element from its external document reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element
      externalReferenceGUID - unique identifier of the IT profile
      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.

    • deleteExternalReference

      @PostMapping(path="/external-references/{externalReferenceGUID}/delete") public VoidResponse deleteExternalReference(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String externalReferenceGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Delete an external reference.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      externalReferenceGUID - 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.

    • getExternalReferencesByName

      @PostMapping(path="/external-references/by-name") public OpenMetadataRootElementsResponse getExternalReferencesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of external references 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)

    • findExternalReferences

      @PostMapping(path="/external-references/by-search-string") public OpenMetadataRootElementsResponse findExternalReferences(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of external reference 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)

    • getExternalReferenceByGUID

      @PostMapping(path="/external-references/{externalReferenceGUID}/retrieve") public OpenMetadataRootElementResponse getExternalReferenceByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String externalReferenceGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific external reference.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      externalReferenceGUID - 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)