@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/view-services/rex/users/{userId}")
public class RexViewRESTResource
extends Object
| Constructor and Description |
|---|
RexViewRESTResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
RexSearchResponse |
findEntities(String serverName,
String userId,
RexSearchBody body)
This method searches for entities based on property value.
|
RexSearchResponse |
findRelationships(String serverName,
String userId,
RexSearchBody body)
This method searches for relationships based on property value.
|
RexEntityDetailResponse |
getEntity(String serverName,
String userId,
RexEntityRequestBody body)
This method gets an entity detail.
|
RexRelationshipResponse |
getRelationship(String serverName,
String userId,
RexRelationshipRequestBody body)
This method gets a relationship.
|
TypeExplorerResponse |
getTypeExplorer(String serverName,
String userId,
RexTypesRequestBody body)
Load type information
|
RexPreTraversalResponse |
rexPreTraversal(String serverName,
String userId,
RexTraversalRequestBody body)
This method retrieves the neighborhood around a starting entity for pre-traversal
|
RexTraversalResponse |
rexTraversal(String serverName,
String userId,
RexTraversalRequestBody body)
This method retrieves the neighborhood around a starting entity.
|
@PostMapping(value="/types") public TypeExplorerResponse getTypeExplorer(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexTypesRequestBody body)
Load type information from the repository server. This is used to populate filters.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/entity") public RexEntityDetailResponse getEntity(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexEntityRequestBody body)
When retrieving a single entity we return the whole EntityDetail object. This is because the entity is being used as the user focus object and will be displayed in the details pane.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/relationship") public RexRelationshipResponse getRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexRelationshipRequestBody body)
When retrieving a single relationship we return the whole Relationship object. This is because the relationship is being used as the user focus object and will be displayed in the details pane.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/entities/by-property-value") public RexSearchResponse findEntities(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexSearchBody body)
When searching for entities, we return a list of EntityDigest objects. This is because the digests are used to display a list of search hits to the user from which they can select which entities they would like to add to the graph.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/relationships/by-property-value") public RexSearchResponse findRelationships(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexSearchBody body)
When searching for relationships, we return a list of RelationshipDigest objects. This is because the digests are used to display a list of search hits to the user from which they can select which relationships they would like to add to the graph.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/pre-traversal") public RexPreTraversalResponse rexPreTraversal(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexTraversalRequestBody body)
When exploring an entity neighborhood we return an InstanceGraph which contains the entities and relationships that were traversed.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository request@PostMapping(value="/instances/traversal") public RexTraversalResponse rexTraversal(@PathVariable String serverName, @PathVariable String userId, @RequestBody RexTraversalRequestBody body)
When exploring an entity neighborhood we return an InstanceGraph which contains the entities and relationships that were traversed.
The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.
serverName - name of the server running the view-service.userId - user account under which to conduct operation.body - request body containing parameters to formulate repository requestCopyright © 2018–2020 ODPi. All rights reserved.