Package org.odpi.openmetadata.viewservices.subjectarea.server

Class SubjectAreaRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.subjectarea.server.SubjectAreaRESTServices
public class SubjectAreaRESTServices extends TokenController
The SubjectAreaRESTServices provides the server-side implementation of the Subject Area Open Metadata View Service (OMVS). This interface provides access to data fields, data structures and data classes.

  • Constructor Details

    • SubjectAreaRESTServices

      public SubjectAreaRESTServices()
      Default constructor

  • Method Details

    • linkSubjectAreas

      public VoidResponse linkSubjectAreas(String serverName, String subjectAreaGUID, String nestedSubjectAreaGUID, NewRelationshipRequestBody requestBody)
      Link subject area definitions in a hierarchy.
      Parameters:
      serverName - name of called server
      subjectAreaGUID - unique identifier of the parent subject area.
      nestedSubjectAreaGUID - unique identifier of the nested subject area.
      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.

    • detachSubjectAreas

      public VoidResponse detachSubjectAreas(String serverName, String subjectAreaGUID, String nestedSubjectAreaGUID, DeleteRelationshipRequestBody requestBody)
      Detach subject area definitions from their hierarchical relationship.
      Parameters:
      serverName - name of called server
      subjectAreaGUID - unique identifier of the parent subject area.
      nestedSubjectAreaGUID - unique identifier of the nested subject area.
      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.

    • addElementToSubjectArea

      public VoidResponse addElementToSubjectArea(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify the element to assert that the definitions it represents are part of a subject area definition.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeElementFromSubjectArea

      public VoidResponse removeElementFromSubjectArea(String serverName, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the subject area designation from the identified element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem