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

Class CommunityMattersResource

java.lang.Object
org.odpi.openmetadata.viewservices.communitymatters.server.spring.CommunityMattersResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/community-matters") public class CommunityMattersResource extends Object
The CommunityMattersResource provides part of the server-side implementation of the Community Matters OMVS. =

  • Constructor Details

    • CommunityMattersResource

      public CommunityMattersResource()
      Default constructor

  • Method Details

    • createCommunity

      @PostMapping(path="/communities") public GUIDResponse createCommunity(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a community.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the community.
      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.

    • createCommunityFromTemplate

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

    • updateCommunity

      @PostMapping(path="/communities/{communityGUID}/update") public VoidResponse updateCommunity(@PathVariable String serverName, @PathVariable String communityGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a community.
      Parameters:
      serverName - name of called server.
      communityGUID - unique identifier of the community (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.

    • deleteCommunity

      @PostMapping(path="/communities/{communityGUID}/delete") public VoidResponse deleteCommunity(@PathVariable String serverName, @PathVariable String communityGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a community.
      Parameters:
      serverName - name of called server
      communityGUID - 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.

    • getCommunitiesByName

      @PostMapping(path="/communities/by-name") public OpenMetadataRootElementsResponse getCommunitiesByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of communities with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      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)

    • findCommunities

      @PostMapping(path="/communities/by-search-string") public OpenMetadataRootElementsResponse findCommunities(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of community metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      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)

    • getCommunityByGUID

      @PostMapping(path="/communities/{communityGUID}/retrieve") public OpenMetadataRootElementResponse getCommunityByGUID(@PathVariable String serverName, @PathVariable String communityGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific community.
      Parameters:
      serverName - name of the service to route the request to
      communityGUID - 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)