@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/digital-architecture/users/{userId}")
public class LocationResource
extends Object
| Constructor and Description |
|---|
LocationResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
clearAdjacentLocation(String serverName,
String userId,
String locationOneGUID,
String locationTwoGUID,
NullRequestBody requestBody)
Remove a peer-to-peer relationship between two locations.
|
VoidResponse |
clearLocationAsDigital(String serverName,
String userId,
String locationGUID,
NullRequestBody requestBody)
Remove the digital/cyber location designation from the location.
|
VoidResponse |
clearLocationAsFixedPhysical(String serverName,
String userId,
String locationGUID,
NullRequestBody requestBody)
Remove the fixed physical location designation from the location.
|
VoidResponse |
clearLocationAsSecure(String serverName,
String userId,
String locationGUID,
NullRequestBody requestBody)
Remove the secure location designation from the location.
|
VoidResponse |
clearNestedLocation(String serverName,
String userId,
String parentLocationGUID,
String childLocationGUID,
NullRequestBody requestBody)
Remove a parent-child relationship between two locations.
|
GUIDResponse |
createLocation(String serverName,
String userId,
LocationProperties locationProperties)
Create a new metadata element to represent a location.
|
GUIDResponse |
createLocationFromTemplate(String serverName,
String userId,
String templateGUID,
TemplateProperties templateProperties)
Create a new metadata element to represent a location using an existing metadata element as a template.
|
LocationsResponse |
findLocations(String serverName,
String userId,
int startFrom,
int pageSize,
SearchStringRequestBody requestBody)
Retrieve the list of location metadata elements that contain the search string.
|
LocationResponse |
getLocationByGUID(String serverName,
String userId,
String locationGUID)
Retrieve the location metadata element with the supplied unique identifier.
|
LocationsResponse |
getLocationsByName(String serverName,
String userId,
int startFrom,
int pageSize,
NameRequestBody requestBody)
Retrieve the list of location metadata elements with a matching qualified or display name.
|
VoidResponse |
removeLocation(String serverName,
String userId,
String locationGUID,
NullRequestBody requestBody)
Remove the metadata element representing a location.
|
VoidResponse |
setLocationAsDigital(String serverName,
String userId,
String locationGUID,
DigitalLocationRequestBody requestBody)
Classify the location to indicate that it represents a digital/cyber location.
|
VoidResponse |
setLocationAsFixedPhysical(String serverName,
String userId,
String locationGUID,
FixedLocationRequestBody requestBody)
Classify the location to indicate that it represents a fixed physical location.
|
VoidResponse |
setLocationAsSecure(String serverName,
String userId,
String locationGUID,
SecureLocationRequestBody requestBody)
Classify the location to indicate that it represents a secure location.
|
VoidResponse |
setupAdjacentLocation(String serverName,
String userId,
String locationOneGUID,
String locationTwoGUID,
NullRequestBody requestBody)
Create a peer-to-peer relationship between two locations.
|
VoidResponse |
setupNestedLocation(String serverName,
String userId,
String parentLocationGUID,
String childLocationGUID,
NullRequestBody requestBody)
Create a parent-child relationship between two locations.
|
VoidResponse |
updateLocation(String serverName,
String userId,
String locationGUID,
LocationProperties locationProperties)
Update the metadata element representing a location.
|
@PostMapping(path="/locations") public GUIDResponse createLocation(@PathVariable String serverName, @PathVariable String userId, @RequestBody LocationProperties locationProperties)
serverName - name of calling serveruserId - calling userlocationProperties - properties to store@PostMapping(path="/locations/from-template/{templateGUID}")
public GUIDResponse createLocationFromTemplate(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String templateGUID,
@RequestBody
TemplateProperties templateProperties)
serverName - name of calling serveruserId - calling usertemplateGUID - unique identifier of the metadata element to copytemplateProperties - properties that override the template@PostMapping(path="/locations/{locationGUID}/update")
public VoidResponse updateLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody
LocationProperties locationProperties)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to updatelocationProperties - new properties for this element@PostMapping(path="/locations/{locationGUID}/classify-as-fixed-location")
public VoidResponse setLocationAsFixedPhysical(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody
FixedLocationRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to classifyrequestBody - properties of the location@PostMapping(path="/locations/{locationGUID}/classify-as-fixed-location/delete")
public VoidResponse clearLocationAsFixedPhysical(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to unclassifyrequestBody - null request body@PostMapping(path="/locations/{locationGUID}/classify-as-secure-location")
public VoidResponse setLocationAsSecure(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody
SecureLocationRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to classifyrequestBody - properties of the location@PostMapping(path="/locations/{locationGUID}/classify-as-secure-location/delete")
public VoidResponse clearLocationAsSecure(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to unclassifyrequestBody - null request body@PostMapping(path="/locations/{locationGUID}/classify-as-digital-location")
public VoidResponse setLocationAsDigital(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody
DigitalLocationRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to classifyrequestBody - position of the location@PostMapping(path="/locations/{locationGUID}/classify-as-digital-location/delete")
public VoidResponse clearLocationAsDigital(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to unclassifyrequestBody - null request body@PostMapping(path="/locations/{locationGUID}/delete")
public VoidResponse removeLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the metadata element to removerequestBody - null request body@PostMapping(path="/locations/{parentLocationGUID}/has-nested-location/{childLocationGUID}")
public VoidResponse setupNestedLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentLocationGUID,
@PathVariable
String childLocationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userparentLocationGUID - unique identifier of the location that is the broader locationchildLocationGUID - unique identifier of the location that is the smaller, nested locationrequestBody - null request body@PostMapping(path="/locations/{parentLocationGUID}/has-nested-location/{childLocationGUID}/delete")
public VoidResponse clearNestedLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String parentLocationGUID,
@PathVariable
String childLocationGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userparentLocationGUID - unique identifier of the location that is the broader locationchildLocationGUID - unique identifier of the location that is the smaller, nested locationrequestBody - null request body@PostMapping(path="/locations/{locationOneGUID}/linked-to-peer-location/{locationTwoGUID}")
public VoidResponse setupAdjacentLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationOneGUID,
@PathVariable
String locationTwoGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationOneGUID - unique identifier of the first locationlocationTwoGUID - unique identifier of the second locationrequestBody - null request body@PostMapping(path="/locations/{locationOneGUID}/linked-to-peer-location/{locationTwoGUID}/delete")
public VoidResponse clearAdjacentLocation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationOneGUID,
@PathVariable
String locationTwoGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling userlocationOneGUID - unique identifier of the first locationlocationTwoGUID - unique identifier of the second locationrequestBody - null request body@PostMapping(path="/locations/by-search-string") public LocationsResponse findLocations(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
serverName - name of calling serveruserId - calling userrequestBody - string to find in the propertiesstartFrom - paging start pointpageSize - maximum results that can be returned@PostMapping(path="/locations/by-name") public LocationsResponse getLocationsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
serverName - name of calling serveruserId - calling userrequestBody - name to search forstartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/locations/{locationGUID}")
public LocationResponse getLocationByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String locationGUID)
serverName - name of calling serveruserId - calling userlocationGUID - unique identifier of the requested metadata elementCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.