org.odpi.openmetadata.accessservices.subjectarea.server.spring

Class SubjectAreaGraphRESTResource

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

org.odpi.openmetadata.accessservices.subjectarea.server.spring.SubjectAreaGraphRESTResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaGraphRESTResource
extends SubjectAreaRESTServicesInstance

The SubjectAreaRESTServicesInstance provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectArea Open Metadata Access Service (OMAS). This interface provides term authoring interfaces for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

instanceHandler, oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGraphRESTResource() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	getGraph(String serverName, String userId, String guid, Date asOfTime, String nodeFilterStr, String lineFilterStr, StatusFilter statusFilter, Integer level) Get the graph of nodes and lines radiating out from a node.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

createLine, deleteLine, getLine, getRelationshipsFromGuid, initializeAPI, initializeAPI, restoreLine, setOMRSAPIHelper, updateLine

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaGraphRESTResource

public SubjectAreaGraphRESTResource()

Default constructor

Method Detail

getGraph

@RequestMapping(method=GET,
                path="/users/{userId}/nodes/{guid}")
public SubjectAreaOMASAPIResponse getGraph(@PathVariable
                                                                                                                            String serverName,
                                                                                                                            @PathVariable
                                                                                                                            String userId,
                                                                                                                            @PathVariable
                                                                                                                            String guid,
                                                                                                                            @RequestParam(value="asOfTime",required=false)
                                                                                                                            Date asOfTime,
                                                                                                                            @RequestParam(value="nodeFilter",required=false)
                                                                                                                            String nodeFilterStr,
                                                                                                                            @RequestParam(value="lineFilter",required=false)
                                                                                                                            String lineFilterStr,
                                                                                                                            @RequestParam(value="statusFilter",required=false)
                                                                                                                            StatusFilter statusFilter,
                                                                                                                            @RequestParam(value="level",required=false)
                                                                                                                            Integer level)

Get the graph of nodes and lines radiating out from a node. Return the nodes and lines that radiate out from the supplied node (identified by a GUID). The results are scoped by types of Lines, types of nodes and classifications as well as level.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - the starting point of the query.

nodeFilterStr - Comma separated list of node names to include in the query results. Null means include all entities found, irrespective of their type.

lineFilterStr - comma separated list of line names to include in the query results. Null means include all lines found, irrespective of their type.

asOfTime - Requests a historical query of the relationships for the entity. Null means return the present values.

statusFilter - By default only active instances are returned. Specify ALL to see all instance in any status.

level - the number of the lines (relationships) out from the starting node that the query will traverse to gather results. If not specified then it defaults to 3.

Returns:

A graph of nodeTypes.

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• FunctionNotSupportedException Function not supported this indicates that a find was issued but the repository does not implement find functionality in some way.