@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/digital-architecture/users/{userId}")
public class ValidValuesResource
extends Object
| Constructor and Description |
|---|
ValidValuesResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
assignReferenceValueToItem(String serverName,
String userId,
String validValueGUID,
String referenceableGUID,
ReferenceValueAssignmentProperties requestBody)
Link a valid value as a reference value to a referencable to act as a tag/classification to help with locating and
grouping the referenceable.
|
VoidResponse |
assignValidValueToConsumer(String serverName,
String userId,
String validValueGUID,
String consumerGUID,
ValidValueAssignmentProperties requestBody)
Link a valid value typically to a schema element or glossary term to show that it uses
the valid values.
|
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.
|
VoidResponse |
classifyAssetAsReferenceData(String serverName,
String userId,
String assetGUID,
NullRequestBody requestBody)
Add the ReferenceData classification to an asset.
|
GUIDResponse |
createExternalValidValueDefinition(String serverName,
String userId,
String externalSourceGUID,
String externalSourceName,
String setGUID,
ValidValueProperties requestBody)
Create a new valid value definition that is owned/managed by an external tool.
|
GUIDResponse |
createExternalValidValueSet(String serverName,
String userId,
String externalSourceGUID,
String externalSourceName,
ValidValueProperties requestBody)
Create a new valid value set that is owned/managed by an external tool.
|
GUIDResponse |
createValidValueDefinition(String serverName,
String userId,
String setGUID,
ValidValueProperties requestBody)
Create a new valid value definition.
|
GUIDResponse |
createValidValueSet(String serverName,
String userId,
ValidValueProperties requestBody)
Create a new valid value set.
|
VoidResponse |
declassifyAssetAsReferenceData(String serverName,
String userId,
String assetGUID,
NullRequestBody requestBody)
Remove the ReferenceData classification form an Asset.
|
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.
|
ReferenceValueAssignmentItemsResponse |
getReferenceValueAssignedItems(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of referenceables that have this valid value as a reference value.
|
ReferenceValueAssignmentDefinitionsResponse |
getReferenceValueAssignments(String serverName,
String userId,
String referenceableGUID,
int startFrom,
int pageSize)
Page through the list of assigned reference values for a referenceable.
|
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,
String validValueName)
Retrieve a specific valid value from the repository.
|
ValidValueMappingsResponse |
getValidValueMappings(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of mappings for a valid value.
|
ValidValueAssignmentConsumersResponse |
getValidValuesAssignmentConsumers(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of consumers for a valid value.
|
ValidValueAssignmentDefinitionsResponse |
getValidValuesAssignmentDefinition(String serverName,
String userId,
String referenceableGUID,
int startFrom,
int pageSize)
Page through the list of valid values assigned to referenceable element.
|
ValidValuesResponse |
getValidValueSetMembers(String serverName,
String userId,
String validValueSetGUID,
int startFrom,
int pageSize)
Page through the members of a valid value set.
|
ValidValuesImplAssetsResponse |
getValidValuesImplementationAssets(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of implementations for a valid value.
|
ValidValuesImplDefinitionsResponse |
getValidValuesImplementationDefinitions(String serverName,
String userId,
String assetGUID,
int startFrom,
int pageSize)
Page through the list of valid values defining the content of a reference data asset.
|
ValidValuesMappingsResponse |
getValidValuesMappings(String serverName,
String userId,
String validValueGUID,
int startFrom,
int pageSize)
Page through the list of mapping relationships associated with a valid value.
|
VoidResponse |
linkValidValueToImplementation(String serverName,
String userId,
String validValueGUID,
String assetGUID,
ValidValuesImplProperties requestBody)
Link a valid value to an asset that provides the implementation.
|
VoidResponse |
mapValidValues(String serverName,
String userId,
String validValue1GUID,
String validValue2GUID,
ValidValuesMappingProperties requestBody)
Link together 2 valid values from different sets that have equivalent values/meanings.
|
VoidResponse |
unassignReferenceValueFromItem(String serverName,
String userId,
String validValueGUID,
String referenceableGUID,
NullRequestBody requestBody)
Remove the reference value link between a valid value and a referenceable (item).
|
VoidResponse |
unassignValidValueFromConsumer(String serverName,
String userId,
String validValueGUID,
String consumerGUID,
NullRequestBody requestBody)
Remove the link between a valid value and a consumer.
|
VoidResponse |
unlinkValidValueFromImplementation(String serverName,
String userId,
String validValueGUID,
String assetGUID,
NullRequestBody requestBody)
Remove the link between a valid value and an implementing asset.
|
VoidResponse |
unmapValidValues(String serverName,
String userId,
String validValue1GUID,
String validValue2GUID,
NullRequestBody requestBody)
Remove the reference value link between a valid value and a referenceable (item).
|
VoidResponse |
updateValidValue(String serverName,
String userId,
String validValueGUID,
ValidValueProperties requestBody)
Update the properties of the valid value.
|
@PostMapping(path="/valid-values/sets") public GUIDResponse createValidValueSet(@PathVariable String serverName, @PathVariable String userId, @RequestBody ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.requestBody - parameters for the new object.@PostMapping(path="/valid-values/sets/external-collection/{externalSourceGUID}/{externalSourceName}")
public GUIDResponse createExternalValidValueSet(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String externalSourceGUID,
@PathVariable
String externalSourceName,
@PathVariable
ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.externalSourceGUID - guid of the software server capability entity that represented the external sourceexternalSourceName - name of the software server capability entity that represented the external sourcerequestBody - parameters for the new object.@PostMapping(path="/valid-values/sets/{setGUID}")
public GUIDResponse createValidValueDefinition(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String setGUID,
@RequestBody
ValidValueProperties 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/sets/{setGUID}/external-collection/{externalSourceGUID}/{externalSourceName}")
public GUIDResponse createExternalValidValueDefinition(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String externalSourceGUID,
@PathVariable
String externalSourceName,
@PathVariable
String setGUID,
@RequestBody
ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.externalSourceGUID - guid of the software server capability entity that represented the external sourceexternalSourceName - name of the software server capability entity that represented the external sourcesetGUID - 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
ValidValueProperties 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@PostMapping(path="/valid-values/{validValueGUID}/implementations/{assetGUID}")
public VoidResponse linkValidValueToImplementation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String assetGUID,
@RequestBody
ValidValuesImplProperties requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.assetGUID - unique identifier of the asset that implements the valid value.requestBody - implementation relationship properties@PostMapping(path="/assets/{assetGUID}/classify-as-reference-data")
public VoidResponse classifyAssetAsReferenceData(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.assetGUID - unique identifier of the asset that contains reference data.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/valid-values/{validValueGUID}/implementations/{assetGUID}/delete")
public VoidResponse unlinkValidValueFromImplementation(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String assetGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.assetGUID - unique identifier of the asset that used to implement the valid value.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/assets/{assetGUID}/declassify-as-reference-data")
public VoidResponse declassifyAssetAsReferenceData(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.assetGUID - unique identifier of asset.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/valid-values/{validValueGUID}/consumers/{consumerGUID}")
public VoidResponse assignValidValueToConsumer(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String consumerGUID,
@RequestBody
ValidValueAssignmentProperties requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.consumerGUID - unique identifier of the element to link to.requestBody - request body supplied to pass the strictRequirement flag@PostMapping(path="/valid-values/{validValueGUID}/consumers/{consumerGUID}/delete")
public VoidResponse unassignValidValueFromConsumer(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String consumerGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.consumerGUID - unique identifier of the element to remove the link from.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/reference-values/{validValueGUID}/items/{referenceableGUID}")
public VoidResponse assignReferenceValueToItem(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String referenceableGUID,
@RequestBody
ReferenceValueAssignmentProperties requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.referenceableGUID - unique identifier of the element to link to.requestBody - properties for the relationship.@PostMapping(path="/reference-values/{validValueGUID}/items/{referenceableGUID}/delete")
public VoidResponse unassignReferenceValueFromItem(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@PathVariable
String referenceableGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.referenceableGUID - unique identifier of the element to remove the link from.requestBody - null request body supplied to satisfy REST protocol@PostMapping(path="/valid-values/{validValue1GUID}/map/{validValue2GUID}")
public VoidResponse mapValidValues(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValue1GUID,
@PathVariable
String validValue2GUID,
@RequestBody
ValidValuesMappingProperties requestBody)
serverName - name of calling serveruserId - calling user.validValue1GUID - unique identifier of the valid value.validValue2GUID - unique identifier of the other valid value to link to.requestBody - properties for the relationship.@PostMapping(path="/valid-values/{validValue1GUID}/map/{validValue2GUID}/delete")
public VoidResponse unmapValidValues(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValue1GUID,
@PathVariable
String validValue2GUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.validValue1GUID - unique identifier of the valid value.validValue2GUID - unique identifier of the other valid value element to remove the link from.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, @RequestBody String validValueName)
serverName - name of calling serveruserId - calling uservalidValueName - 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.@GetMapping(path="/valid-values/{validValueGUID}/consumers")
public ValidValueAssignmentConsumersResponse getValidValuesAssignmentConsumers(@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.@GetMapping(path="/referenceables/{referenceableGUID}/valid-value-assignments")
public ValidValueAssignmentDefinitionsResponse getValidValuesAssignmentDefinition(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String referenceableGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling user.referenceableGUID - unique identifier of anchoring referenceablestartFrom - paging starting pointpageSize - maximum number of return values.@GetMapping(path="/valid-values/{validValueGUID}/implementations")
public ValidValuesImplAssetsResponse getValidValuesImplementationAssets(@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.@GetMapping(path="/assets/{assetGUID}/valid-value-implementation-definitions")
public ValidValuesImplDefinitionsResponse getValidValuesImplementationDefinitions(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling userassetGUID - unique identifier of asset to querystartFrom - paging starting pointpageSize - maximum number of return values.@GetMapping(path="/valid-values/{validValueGUID}/mapped-values")
public ValidValueMappingsResponse getValidValueMappings(@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.@GetMapping(path="/valid-values/{validValueGUID}/map-relationships")
public ValidValuesMappingsResponse getValidValuesMappings(@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.@GetMapping(path="/valid-values/{validValueGUID}/reference-values/assigned-items")
public ReferenceValueAssignmentItemsResponse getReferenceValueAssignedItems(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String validValueGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of valid value to querystartFrom - paging starting pointpageSize - maximum number of return values.@GetMapping(path="/referenceables/{referenceableGUID}/reference-value-assignments")
public ReferenceValueAssignmentDefinitionsResponse getReferenceValueAssignments(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String referenceableGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of calling serveruserId - calling userreferenceableGUID - unique identifier of assigned itemstartFrom - paging starting pointpageSize - maximum number of return values.Copyright © 2018–2020 ODPi. All rights reserved.