Class ValidMetadataOMVSResource
java.lang.Object
org.odpi.openmetadata.viewservices.validmetadata.server.spring.ValidMetadataOMVSResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class ValidMetadataOMVSResource
extends Object
The ValidMetadataOMVSResource provides part of the server-side implementation of the Valid Metadata OMVS.
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclearValidMetadataMapName(String serverName, String urlMarker, String typeName, String propertyName, String mapName, DeleteElementRequestBody requestBody) Remove a valid map name value for a property.clearValidMetadataMapValue(String serverName, String urlMarker, String typeName, String propertyName, String mapName, String preferredValue, DeleteElementRequestBody requestBody) Remove a valid map name value for a property.clearValidMetadataValue(String serverName, String urlMarker, String typeName, String propertyName, String preferredValue, DeleteElementRequestBody requestBody) Remove a valid value for a property.deleteSpecificationProperty(String serverName, String urlMarker, String specificationPropertyGUID, DeleteElementRequestBody requestBody) Removes a specification property added to the element.findSpecificationProperties(String serverName, String urlMarker, SearchStringRequestBody requestBody) Return the list of specification properties containing the supplied string.getAllTypes(String serverName, String urlMarker) Returns the list of different types of metadata organized into two groups.getClassificationDefs(String serverName, String urlMarker) Returns all the classification type definitions.getConsistentMetadataValues(String serverName, String urlMarker, String typeName, String propertyName, String mapName, String preferredValue, int startFrom, int pageSize) Retrieve all the consistent valid values for the requested property.getEntityDefs(String serverName, String urlMarker) Returns all the entity type definitions.getRelationshipDefs(String serverName, String urlMarker) Returns all the relationship type definitions.getSpecificationPropertyByGUID(String serverName, String urlMarker, String specificationPropertyGUID, GetRequestBody requestBody) Return the requested specificationProperty.getSpecificationPropertyByName(String serverName, String urlMarker, FilterRequestBody requestBody) Return the list of specification properties containing the supplied name.getSpecificationPropertyByType(String serverName, SpecificationPropertyType specificationPropertyType, String urlMarker, ResultsRequestBody requestBody) Return the list of specification properties containing the supplied type.getSpecificationPropertyTypes(String serverName, String urlMarker) Return the list of specification property types.getSubTypes(String serverName, String urlMarker, String typeName) Returns all the TypeDefs for a specific subtype.getTypeDefByName(String serverName, String urlMarker, String name) Return the TypeDef identified by the unique name.getValidClassificationTypes(String serverName, String urlMarker, String typeName) Returns all the TypeDefs for classifications that can be attached to the requested entity type.getValidMetadataMapName(String serverName, String urlMarker, String typeName, String propertyName, String mapName) Retrieve details of a specific valid name for a map property.getValidMetadataMapValue(String serverName, String urlMarker, String typeName, String propertyName, String mapName, String preferredValue) Retrieve details of a specific valid value for a map name.getValidMetadataValue(String serverName, String urlMarker, String typeName, String propertyName, String preferredValue) Retrieve details of a specific valid value for a property.getValidMetadataValues(String serverName, String urlMarker, String typeName, String propertyName, int startFrom, int pageSize) Retrieve all the valid values for the requested property.getValidRelationshipTypes(String serverName, String urlMarker, String typeName) Returns all the TypeDefs for relationships that can be attached to the requested entity type.setConsistentMetadataValues(String serverName, String urlMarker, String typeName1, String propertyName1, String mapName1, String preferredValue1, String typeName2, String propertyName2, String mapName2, String preferredValue2, NullRequestBody requestBody) Set up consistent metadata values relationship between the two property values.setUpSpecificationProperty(String serverName, String urlMarker, String elementGUID, SpecificationProperty requestBody) Creates a specification property and attaches it to an element.setUpValidMetadataMapName(String serverName, String urlMarker, String typeName, String propertyName, ValidMetadataValue requestBody) Create or update the valid value for a name that can be stored in a particular open metadata property name.setUpValidMetadataMapValue(String serverName, String urlMarker, String typeName, String propertyName, String mapName, ValidMetadataValue validMetadataValue) Create or update the valid value for a name that can be stored in a particular open metadata property name.setUpValidMetadataValue(String serverName, String urlMarker, String typeName, String propertyName, ValidMetadataValue requestBody) Create or update the valid value for a particular open metadata property name.validateMetadataMapName(String serverName, String urlMarker, String typeName, String propertyName, String mapName) Validate whether the name found in an open metadata map property is valid.validateMetadataMapValue(String serverName, String urlMarker, String typeName, String propertyName, String mapName, String actualValue) Validate whether the name found in an open metadata map property is valid.validateMetadataValue(String serverName, String urlMarker, String typeName, String propertyName, String actualValue) Validate whether the value found in an open metadata property is valid.
-
Constructor Details
-
ValidMetadataOMVSResource
public ValidMetadataOMVSResource()Default constructor
-
-
Method Details
-
setUpValidMetadataValue
@PostMapping(path="/setup-value/{propertyName}") public VoidResponse setUpValidMetadataValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestBody ValidMetadataValue requestBody) Create or update the valid value for a particular open metadata property name. If the typeName is null, this valid value applies to properties of this name from all types. The valid value is stored in the preferredValue property. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesrequestBody- preferred value to use in the open metadata types plus additional descriptive values.- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
setUpValidMetadataMapName
@PostMapping(path="/setup-map-name/{propertyName}") public VoidResponse setUpValidMetadataMapName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestBody ValidMetadataValue requestBody) Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The mapName is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesrequestBody- preferred value to use in the open metadata types plus additional descriptive values.- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
setUpValidMetadataMapValue
@PostMapping(path="/setup-map-value/{propertyName}/{mapName}") public VoidResponse setUpValidMetadataMapValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestBody ValidMetadataValue validMetadataValue) Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The valid value is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- name in the map that this valid value applies. If null then the value can be used for any name in the map.validMetadataValue- preferred value to use in the open metadata types plus additional descriptive values.- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
clearValidMetadataValue
@PostMapping(path="/clear-value/{propertyName}") public VoidResponse clearValidMetadataValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String preferredValue, @RequestBody(required=false) DeleteElementRequestBody requestBody) Remove a valid value for a property.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliespreferredValue- specific valid value to removerequestBody- null request body- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
clearValidMetadataMapName
@PostMapping(path="/clear-map-name/{propertyName}") public VoidResponse clearValidMetadataMapName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String mapName, @RequestBody(required=false) DeleteElementRequestBody requestBody) Remove a valid map name value for a property. The match is done on mapName.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- specific valid value to removerequestBody- null request body- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
clearValidMetadataMapValue
@PostMapping(path="/clear-map-value/{propertyName}/{mapName}") public VoidResponse clearValidMetadataMapValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam(required=false) String preferredValue, @RequestBody(required=false) DeleteElementRequestBody requestBody) Remove a valid map name value for a property. The match is done on preferred name.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- name in the map that this valid value applies. If null then the value can be used for any name in the map.preferredValue- specific valid value to removerequestBody- null request body- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
validateMetadataValue
@GetMapping(path="/validate-value/{propertyName}") public BooleanResponse validateMetadataValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String actualValue) Validate whether the value found in an open metadata property is valid.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesactualValue- value stored in the property - if this is null, true is only returned if null is set up as a valid value.- Returns:
- boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
validateMetadataMapName
@GetMapping(path="/validate-map-name/{propertyName}") public BooleanResponse validateMetadataMapName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String mapName) Validate whether the name found in an open metadata map property is valid.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- value stored in the property - if this is null, true is only returned if null is set up as a valid value.- Returns:
- boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
validateMetadataMapValue
@GetMapping(path="/validate-map-value/{propertyName}/{mapName}") public BooleanResponse validateMetadataMapValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam String actualValue) Validate whether the name found in an open metadata map property is valid.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- name in the map that this valid value applies. If null then the value can be used for any name in the map.actualValue- value stored in the property - if this is null, true is only returned if null is set up as a valid value.- Returns:
- boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value) or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getValidMetadataValue
@GetMapping(path="/get-value/{propertyName}") public ValidMetadataValueResponse getValidMetadataValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String preferredValue) Retrieve details of a specific valid value for a property.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliespreferredValue- valid value to match- Returns:
- specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getValidMetadataMapName
@GetMapping(path="/get-map-name/{propertyName}") public ValidMetadataValueResponse getValidMetadataMapName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam String mapName) Retrieve details of a specific valid name for a map property.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- valid value to match- Returns:
- specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getValidMetadataMapValue
@GetMapping(path="/get-map-value/{propertyName}/{mapName}") public ValidMetadataValueResponse getValidMetadataMapValue(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @PathVariable String mapName, @RequestParam String preferredValue) Retrieve details of a specific valid value for a map name.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- name in the map that this valid value applies. If null then the value can be used for any name in the map.preferredValue- valid value to match- Returns:
- specific valid value definition or none if there is no definition stored or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getValidMetadataValues
@GetMapping(path="/get-valid-metadata-values/{propertyName}") public ValidMetadataValueListResponse getValidMetadataValues(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam int startFrom, @RequestParam int pageSize) Retrieve all the valid values for the requested property.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of valid values defined for the property or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getConsistentMetadataValues
@GetMapping(path="/{propertyName}/consistent-metadata-values") public ValidMetadataValueListResponse getConsistentMetadataValues(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName, @PathVariable String propertyName, @RequestParam(required=false) String mapName, @RequestParam String preferredValue, @RequestParam int startFrom, @RequestParam int pageSize) Retrieve all the consistent valid values for the requested property.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName- name of property that this valid value appliesmapName- optional name of map key that this valid value appliespreferredValue- the value to match againststartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of valid values defined for the property or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
setConsistentMetadataValues
@PostMapping(path="/{propertyName1}/consistent-metadata-values/{propertyName2}") public VoidResponse setConsistentMetadataValues(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String typeName1, @PathVariable String propertyName1, @RequestParam(required=false) String mapName1, @RequestParam String preferredValue1, @RequestParam(required=false) String typeName2, @PathVariable String propertyName2, @RequestParam(required=false) String mapName2, @RequestParam String preferredValue2, @RequestBody(required=false) NullRequestBody requestBody) Set up consistent metadata values relationship between the two property values.- Parameters:
serverName- name of server instance to route request tourlMarker- view service URL markertypeName1- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName1- name of property that this valid value appliesmapName1- optional name of map key that this valid value appliespreferredValue1- the value to match againsttypeName2- type name if this is valid value is specific for a type, or null if this valid value if for the property name for all typespropertyName2- name of property that this valid value appliesmapName2- optional name of map key that this valid value appliespreferredValue2- the value to match againstrequestBody- null request body- Returns:
- void or InvalidParameterException the property name is null or not known. UserNotAuthorizedException the service is not able to create/access the element PropertyServerException there is a problem accessing the metadata store
-
getAllTypes
@GetMapping(path="/open-metadata-types") public TypeDefGalleryResponse getAllTypes(@PathVariable String serverName, @PathVariable String urlMarker) Returns the list of different types of metadata organized into two groups. The first are the attribute type definitions (AttributeTypeDefs). These provide types for attributes in full type definitions. Full type definitions (TypeDefs) describe types for entities, relationships and classifications.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL marker- Returns:
- TypeDefGalleryResponse: List of different categories of type definitions or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getEntityDefs
@GetMapping(path="/open-metadata-types/entity-defs") public TypeDefListResponse getEntityDefs(@PathVariable String serverName, @PathVariable String urlMarker) Returns all the entity type definitions.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL marker- Returns:
- TypeDefListResponse: TypeDefs list or InvalidParameterException the TypeDefCategory is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getRelationshipDefs
@GetMapping(path="/open-metadata-types/relationship-defs") public TypeDefListResponse getRelationshipDefs(@PathVariable String serverName, @PathVariable String urlMarker) Returns all the relationship type definitions.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL marker- Returns:
- TypeDefListResponse: TypeDefs list or InvalidParameterException the TypeDefCategory is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getClassificationDefs
@GetMapping(path="/open-metadata-types/classification-defs") public TypeDefListResponse getClassificationDefs(@PathVariable String serverName, @PathVariable String urlMarker) Returns all the classification type definitions.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL marker- Returns:
- TypeDefListResponse: TypeDefs list or InvalidParameterException the TypeDefCategory is null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getSubTypes
@GetMapping(path="/open-metadata-types/sub-types/{typeName}") public TypeDefListResponse getSubTypes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String typeName) Returns all the TypeDefs for a specific subtype. If a null result is returned it means the type has no subtypes.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL markertypeName- name of type to retrieve against.- Returns:
- TypeDefsGalleryResponse: A list of types or InvalidParameterException all attributes of the external id are null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getValidRelationshipTypes
@GetMapping(path="/open-metadata-types/{typeName}/attached-relationships") public TypeDefListResponse getValidRelationshipTypes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String typeName) Returns all the TypeDefs for relationships that can be attached to the requested entity type.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL markertypeName- name of entity type to retrieve against.- Returns:
- TypeDefsGalleryResponse: A list of types or InvalidParameterException all attributes of the external id are null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getValidClassificationTypes
@GetMapping(path="/open-metadata-types/{typeName}/attached-classifications") public TypeDefListResponse getValidClassificationTypes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String typeName) Returns all the TypeDefs for classifications that can be attached to the requested entity type.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL markertypeName- name of type to retrieve against.- Returns:
- TypeDefsGalleryResponse: A list of types or InvalidParameterException all attributes of the external id are null or RepositoryErrorException there is a problem communicating with the metadata repository or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getTypeDefByName
@GetMapping(path="/open-metadata-types/name/{name}") public TypeDefResponse getTypeDefByName(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String name) Return the TypeDef identified by the unique name.- Parameters:
serverName- unique identifier for requested server.urlMarker- view service URL markername- String name of the TypeDef.- Returns:
- TypeDefResponse: TypeDef structure describing its category and properties or InvalidParameterException the name is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or TypeDefNotKnownException the requested TypeDef is not found in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.
-
getSpecificationPropertyTypes
@GetMapping(path="/specification-properties/type-names") public StringMapResponse getSpecificationPropertyTypes(@PathVariable String serverName, @PathVariable String urlMarker) Return the list of specification property types.- Parameters:
serverName- name of the server instance to connect to- Returns:
- list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.
-
setUpSpecificationProperty
@PostMapping(path="/elements/{elementGUID}/specification-properties") public GUIDResponse setUpSpecificationProperty(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) SpecificationProperty requestBody) Creates a specification property and attaches it to an element.- Parameters:
serverName- name of the server instances for this request.urlMarker- view service URL markerelementGUID- String - unique id for the element.requestBody- containing details of the specificationProperty.- Returns:
- elementGUID for new specification property object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteSpecificationProperty
@PostMapping(path="/specification-properties/{specificationPropertyGUID}/delete") public VoidResponse deleteSpecificationProperty(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String specificationPropertyGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody) Removes a specification property added to the element. This deletes the link to the specification property and the specification property itself.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markerspecificationPropertyGUID- String - unique id for the specification property objectrequestBody- containing type of specification property enum and the text of the specificationProperty.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the user does not have permission to perform this request.
-
findSpecificationProperties
@PostMapping(path="/specification-properties/by-search-string") public OpenMetadataRootElementsResponse findSpecificationProperties(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Return the list of specification properties containing the supplied string.- Parameters:
serverName- name of the server instances for this request.urlMarker- view service URL markerrequestBody- search string and effective time.- Returns:
- list of specification property objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getSpecificationPropertyByType
@PostMapping(path="/specification-properties/by-type") public OpenMetadataRootElementsResponse getSpecificationPropertyByType(@PathVariable String serverName, @RequestParam SpecificationPropertyType specificationPropertyType, @PathVariable String urlMarker, @RequestBody(required=false) ResultsRequestBody requestBody) Return the list of specification properties containing the supplied type.- Parameters:
serverName- name of the server instances for this request.urlMarker- view service URL markerspecificationPropertyType- type to search onrequestBody- search string and effective time.- Returns:
- list of specification property objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getSpecificationPropertyByName
@PostMapping(path="/specification-properties/by-name") public OpenMetadataRootElementsResponse getSpecificationPropertyByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Return the list of specification properties containing the supplied name.- Parameters:
serverName- name of the server instances for this request.urlMarker- view service URL markerrequestBody- search string and effective time.- Returns:
- list of specification property objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getSpecificationPropertyByGUID
@PostMapping(path="/specification-properties/{specificationPropertyGUID}/retrieve") public OpenMetadataRootElementResponse getSpecificationPropertyByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String specificationPropertyGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the requested specificationProperty.- Parameters:
serverName- name of the server instances for this requesturlMarker- view service URL markerspecificationPropertyGUID- unique identifier for the specification property object.requestBody- optional effective time- Returns:
- specification property properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-