@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-owner/users/{userId}")
public class ValidValuesOnboardingResource
extends Object
| Constructor and Description |
|---|
ValidValuesOnboardingResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
attachValidValueToSet(String serverName,
String userId,
String setGUID,
String validValueGUID,
NullRequestBody requestBody)
Create a link between a valid value set or definition and a set.
|
GUIDResponse |
createValidValueDefinition(String serverName,
String userId,
String setGUID,
ValidValuesRequestBody requestBody)
Create a new valid value definition.
|
GUIDResponse |
createValidValueSet(String serverName,
String userId,
ValidValuesRequestBody requestBody)
Create a new valid value set.
|
VoidResponse |
deleteValidValue(String serverName,
String userId,
String validValueGUID,
String qualifiedName)
Remove the valid value form the repository.
|
VoidResponse |
detachValidValueFromSet(String serverName,
String userId,
String setGUID,
String validValueGUID,
NullRequestBody requestBody)
Remove the link between a valid value and a set it is a member of.
|
ValidValuesResponse |
findValidValues(String serverName,
String userId,
int startFrom,
int pageSize,
String searchString)
Locate valid values that match the search string.
|
ValidValuesResponse |
getSetsForValidValue(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of valid value sets that a valid value definition/set belongs to.
|
ValidValueResponse |
getValidValueByGUID(String serverName,
String userId,
String validValueGUID)
Retrieve a specific valid value from the repository.
|
ValidValuesResponse |
getValidValueByName(String serverName,
String userId,
int startFrom,
int pageSize,
String validValueName)
Retrieve a specific valid value from the repository.
|
ValidValuesResponse |
getValidValueSetMembers(String serverName,
String userId,
String validValueSetGUID,
int startFrom,
int pageSize)
Page through the members of a valid value set.
|
VoidResponse |
updateValidValue(String serverName,
String userId,
String validValueGUID,
ValidValuesRequestBody requestBody)
Update the properties of the valid value.
|
public ValidValuesOnboardingResource()
@PostMapping(path="/valid-values/new-set") public GUIDResponse createValidValueSet(@PathVariable String serverName, @PathVariable String userId, @RequestBody ValidValuesRequestBody requestBody)
serverName - name of calling serveruserId - calling user.requestBody - parameters for the new object.@PostMapping(path="/valid-values/new-definition/{setGUID}")
public GUIDResponse createValidValueDefinition(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String setGUID,
@RequestBody
ValidValuesRequestBody requestBody)
serverName - name of calling serveruserId - calling user.setGUID - unique identifier of the set to attach this to.requestBody - parameters for the new object.@PostMapping(path="/valid-values/{validValueGUID}/update")
public VoidResponse updateValidValue(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@RequestBody
ValidValuesRequestBody requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.requestBody - parameters to update.@PostMapping(path="/valid-values/{validValueGUID}/delete")
public VoidResponse deleteValidValue(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@RequestBody
String qualifiedName)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of the value to deletequalifiedName - unique name of the value to delete. This is used to verify that
the correct valid value is being deleted.@PostMapping(path="/valid-values/sets/{setGUID}/members/{validValueGUID}")
public VoidResponse attachValidValueToSet(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String setGUID,
@PathVariable
String validValueGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.setGUID - unique identifier of the set.validValueGUID - unique identifier of the valid value to add to the set.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/valid-values/sets/{setGUID}/members/{validValueGUID}/delete")
public VoidResponse detachValidValueFromSet(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String setGUID,
@PathVariable
String validValueGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling usersetGUID - owning setvalidValueGUID - unique identifier of the member to be removed.requestBody - null request body supplied to satisfy REST protocol@GetMapping(path="/valid-values/{validValueGUID}")
public ValidValueResponse getValidValueByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of the valid value.@PostMapping(path="/valid-values/by-name") public ValidValuesResponse getValidValueByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String validValueName)
serverName - name of calling serveruserId - calling userstartFrom - paging starting pointpageSize - maximum number of return values.validValueName - qualified name of the valid value.@PostMapping(path="/valid-values/by-search-string") public ValidValuesResponse findValidValues(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String searchString)
serverName - name of calling serveruserId - calling userstartFrom - paging starting pointpageSize - maximum number of return values.searchString - string value to look for - may contain RegEx characters.@GetMapping(path="/valid-values/sets/{validValueSetGUID}/members")
public ValidValuesResponse getValidValueSetMembers(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueSetGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling user.validValueSetGUID - unique identifier of the valid value set.startFrom - paging starting pointpageSize - maximum number of return values.@GetMapping(path="/valid-values/{validValueGUID}/set-membership")
public ValidValuesResponse getSetsForValidValue(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of valid value to querystartFrom - paging starting pointpageSize - maximum number of return values.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.