Class SubjectAreaRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.subjectarea.server.SubjectAreaRESTServices
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddElementToSubjectArea
(String serverName, String elementGUID, NewClassificationRequestBody requestBody) Classify the element to assert that the definitions it represents are part of a subject area definition.detachSubjectAreas
(String serverName, String subjectAreaGUID, String dataFieldGUID, DeleteRequestBody requestBody) Detach subject area definitions from their hierarchical relationship..linkSubjectAreas
(String serverName, String subjectAreaGUID, String nestedSubjectAreaGUID, NewRelationshipRequestBody requestBody) Link subject area definitions in a hierarchy.removeElementFromSubjectArea
(String serverName, String elementGUID, DeleteRequestBody requestBody) Remove the subject area designation from the identified element.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
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 serversubjectAreaGUID
- 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 dataFieldGUID, DeleteRequestBody requestBody) Detach subject area definitions from their hierarchical relationship..- Parameters:
serverName
- name of called serversubjectAreaGUID
- unique identifier of the parent data structure.dataFieldGUID
- unique identifier of the nested data field.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 toelementGUID
- unique identifier of the metadata element to updaterequestBody
- 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, DeleteRequestBody requestBody) Remove the subject area designation from the identified element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the metadata element to updaterequestBody
- 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
-