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

Class SubjectAreaResource

java.lang.Object

org.odpi.openmetadata.viewservices.subjectarea.server.spring.SubjectAreaResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/subject-area")
public class SubjectAreaResource
extends Object

The SubjectAreaResource provides part of the server-side implementation of the Subject Area OMVS. =

Constructor Summary

Constructors

Constructor	Description
SubjectAreaResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	detachSubjectAreas(String serverName, String parentSubjectAreaGUID, String nestedSubjectAreaGUID, DeleteRelationshipRequestBody requestBody)	Detach a subject area definition from a hierarchical relationship.
VoidResponse	linkSubjectAreas(String serverName, String subjectAreaGUID, String nestedSubjectAreaGUID, NewRelationshipRequestBody requestBody)	Attach a nested subject area to a broader subject area definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubjectAreaResource

public SubjectAreaResource()

Default constructor

Method Details

linkSubjectAreas

@PostMapping(path="/subject-areas/{subjectAreaGUID}/subject-area-hierarchies/{nestedSubjectAreaGUID}/attach")
public VoidResponse linkSubjectAreas(@PathVariable
 String serverName,
 @PathVariable
 String subjectAreaGUID,
 @PathVariable
 String nestedSubjectAreaGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a nested subject area to a broader subject area definition.

Parameters:

serverName - name of called server

subjectAreaGUID - unique identifier of the first subject area definition

nestedSubjectAreaGUID - unique identifier of the second subject area definition

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachSubjectAreas

@PostMapping(path="/subject-areas/{parentSubjectAreaGUID}/subject-area-hierarchies/{nestedSubjectAreaGUID}/detach")
public VoidResponse detachSubjectAreas(@PathVariable
 String serverName,
 @PathVariable
 String parentSubjectAreaGUID,
 @PathVariable
 String nestedSubjectAreaGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a subject area definition from a hierarchical relationship.

Parameters:

serverName - name of called server

parentSubjectAreaGUID - unique identifier of the first subject area definition

nestedSubjectAreaGUID - unique identifier of the second subject area definition

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.