public class ValidValuesRESTServices extends Object
| Constructor and Description |
|---|
ValidValuesRESTServices()
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 |
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,
SearchStringRequestBody requestBody,
int startFrom,
int pageSize)
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,
NameRequestBody requestBody,
int startFrom,
int pageSize)
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.
|
public GUIDResponse createValidValueSet(String serverName, String userId, ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.requestBody - parameters for the new object.public GUIDResponse createValidValueDefinition(String serverName, String userId, String setGUID, ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.setGUID - unique identifier of the set to attach this to.requestBody - parameters to update.public VoidResponse updateValidValue(String serverName, String userId, String validValueGUID, ValidValueProperties requestBody)
serverName - name of calling serveruserId - calling user.validValueGUID - unique identifier of the valid value.requestBody - parameters to update.public VoidResponse deleteValidValue(String serverName, String userId, String validValueGUID, 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.public VoidResponse attachValidValueToSet(String serverName, String userId, String setGUID, String validValueGUID, 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 protocolpublic VoidResponse detachValidValueFromSet(String serverName, String userId, String setGUID, String validValueGUID, 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 protocolpublic VoidResponse linkValidValueToImplementation(String serverName, String userId, String validValueGUID, String assetGUID, 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 propertiespublic VoidResponse classifyAssetAsReferenceData(String serverName, String userId, String assetGUID, 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 protocolpublic VoidResponse unlinkValidValueFromImplementation(String serverName, String userId, String validValueGUID, String assetGUID, 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 protocolpublic VoidResponse declassifyAssetAsReferenceData(String serverName, String userId, String assetGUID, NullRequestBody requestBody)
serverName - name of calling serveruserId - calling user.assetGUID - unique identifier of asset.requestBody - null request body supplied to satisfy REST protocolpublic VoidResponse assignValidValueToConsumer(String serverName, String userId, String validValueGUID, String consumerGUID, 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 flagpublic VoidResponse unassignValidValueFromConsumer(String serverName, String userId, String validValueGUID, String consumerGUID, 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 protocolpublic VoidResponse assignReferenceValueToItem(String serverName, String userId, String validValueGUID, String referenceableGUID, 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.public VoidResponse unassignReferenceValueFromItem(String serverName, String userId, String validValueGUID, String referenceableGUID, 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 protocolpublic VoidResponse mapValidValues(String serverName, String userId, String validValue1GUID, String validValue2GUID, 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.public VoidResponse unmapValidValues(String serverName, String userId, String validValue1GUID, String validValue2GUID, 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 protocolpublic ValidValueResponse getValidValueByGUID(String serverName, String userId, String validValueGUID)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of the valid value.public ValidValuesResponse getValidValueByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling userrequestBody - qualified name of the valid value.startFrom - paging starting pointpageSize - maximum number of return values.public ValidValuesResponse findValidValues(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling userrequestBody - string value to look for - may contain RegEx characters.startFrom - paging starting pointpageSize - maximum number of return values.public ValidValuesResponse getValidValueSetMembers(String serverName, String userId, String validValueSetGUID, int startFrom, 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.public ValidValuesResponse getSetsForValidValue(String serverName, String userId, String validValueGUID, int startFrom, 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.public ValidValueAssignmentConsumersResponse getValidValuesAssignmentConsumers(String serverName, String userId, String validValueGUID, int startFrom, 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.public ValidValueAssignmentDefinitionsResponse getValidValuesAssignmentDefinition(String serverName, String userId, String referenceableGUID, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling user.referenceableGUID - unique identifier of anchoring referenceablestartFrom - paging starting pointpageSize - maximum number of return values.public ValidValuesImplAssetsResponse getValidValuesImplementationAssets(String serverName, String userId, String validValueGUID, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of valid value to querystartFrom - paging starting pointpageSize - maximum number of return values.public ValidValuesImplDefinitionsResponse getValidValuesImplementationDefinitions(String serverName, String userId, String assetGUID, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling userassetGUID - unique identifier of asset to querystartFrom - paging starting pointpageSize - maximum number of return values.public ValidValueMappingsResponse getValidValueMappings(String serverName, String userId, String validValueGUID, int startFrom, 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.public ValidValuesMappingsResponse getValidValuesMappings(String serverName, String userId, String validValueGUID, int startFrom, 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.public ReferenceValueAssignmentItemsResponse getReferenceValueAssignedItems(String serverName, String userId, String validValueGUID, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling uservalidValueGUID - unique identifier of valid value to querystartFrom - paging starting pointpageSize - maximum number of return values.public ReferenceValueAssignmentDefinitionsResponse getReferenceValueAssignments(String serverName, String userId, String referenceableGUID, int startFrom, int pageSize)
serverName - name of calling serveruserId - calling userreferenceableGUID - unique identifier of assigned itemstartFrom - paging starting pointpageSize - maximum number of return values.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.