Class SchemaExchangeResource
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.assetmanager.server.spring.SchemaExchangeResource
-
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}") public class SchemaExchangeResource extends ObjectDataAssetExchangeResource is the server-side implementation of the Asset Manager OMAS's support for data asset such as data sets. It matches the DataAssetExchangeClient.
-
-
Constructor Summary
Constructors Constructor Description SchemaExchangeResource()Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VoidResponseclearColumnAsPrimaryKey(String serverName, String userId, String schemaAttributeGUID, MetadataCorrelationProperties requestBody)Remove the primary key designation from the schema attribute.VoidResponseclearForeignKeyRelationship(String serverName, String userId, String primaryKeyGUID, String foreignKeyGUID, AssetManagerIdentifiersRequestBody requestBody)Remove the foreign key relationship between two schema elements.VoidResponseclearSchemaElementAsCalculatedValue(String serverName, String userId, String schemaElementGUID, MetadataCorrelationProperties requestBody)Remove the calculated value designation from the schema element.VoidResponseclearSchemaTypeParent(String serverName, String userId, String parentElementGUID, String parentElementTypeName, String schemaTypeGUID, AssetManagerIdentifiersRequestBody requestBody)Remove the relationship between a schema type and its parent data asset, process or port.GUIDResponsecreateSchemaAttribute(String serverName, String userId, String schemaElementGUID, boolean assetManagerIsHome, SchemaAttributeRequestBody requestBody)Create a new metadata element to represent a schema attribute.GUIDResponsecreateSchemaAttributeFromTemplate(String serverName, String userId, String schemaElementGUID, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody)Create a new metadata element to represent a schema attribute using an existing metadata element as a template.GUIDResponsecreateSchemaType(String serverName, String userId, boolean assetManagerIsHome, SchemaTypeRequestBody requestBody)Create a new metadata element to represent a schema type.GUIDResponsecreateSchemaTypeFromTemplate(String serverName, String userId, String templateGUID, boolean assetManagerIsHome, TemplateRequestBody requestBody)Create a new metadata element to represent a schema type using an existing metadata element as a template.SchemaAttributeElementsResponsefindSchemaAttributes(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)Retrieve the list of schema attribute metadata elements that contain the search string.SchemaTypeElementsResponsefindSchemaType(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)Retrieve the list of schema type metadata elements that contain the search string.SchemaAttributeElementsResponsegetNestedAttributes(String serverName, String userId, String parentSchemaElementGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)Retrieve the list of schema attributes associated with a schema element.SchemaAttributeElementResponsegetSchemaAttributeByGUID(String serverName, String userId, String schemaAttributeGUID, AssetManagerIdentifiersRequestBody requestBody)Retrieve the schema attribute metadata element with the supplied unique identifier.SchemaAttributeElementsResponsegetSchemaAttributesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)Retrieve the list of schema attribute metadata elements with a matching qualified or display name.SchemaTypeElementResponsegetSchemaTypeByGUID(String serverName, String userId, String schemaTypeGUID, AssetManagerIdentifiersRequestBody requestBody)Retrieve the schema type metadata element with the supplied unique identifier.SchemaTypeElementsResponsegetSchemaTypeByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)Retrieve the list of schema type metadata elements with a matching qualified or display name.SchemaTypeElementResponsegetSchemaTypeForElement(String serverName, String userId, String parentElementGUID, String parentElementTypeName, AssetManagerIdentifiersRequestBody requestBody)Return the schema type associated with a specific open metadata element (data asset, process or port).ElementHeaderResponsegetSchemaTypeParent(String serverName, String userId, String schemaTypeGUID, AssetManagerIdentifiersRequestBody requestBody)Retrieve the header of the metadata element connected to a schema type.VoidResponseremoveSchemaAttribute(String serverName, String userId, String schemaAttributeGUID, MetadataCorrelationProperties requestBody)Remove the metadata element representing a schema attribute.VoidResponseremoveSchemaType(String serverName, String userId, String schemaTypeGUID, MetadataCorrelationProperties requestBody)Remove the metadata element representing a schema type.VoidResponsesetSchemaElementAsCalculatedValue(String serverName, String userId, String schemaElementGUID, boolean assetManagerIsHome, MetadataCorrelationProperties requestBody)Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.VoidResponsesetupColumnAsPrimaryKey(String serverName, String userId, String schemaAttributeGUID, boolean assetManagerIsHome, PrimaryKeyClassificationRequestBody requestBody)Classify the column schema attribute to indicate that it describes a primary key.VoidResponsesetupForeignKeyRelationship(String serverName, String userId, String primaryKeyGUID, String foreignKeyGUID, boolean assetManagerIsHome, ForeignKeyRequestBody requestBody)Link two schema attributes together to show a foreign key relationship.VoidResponsesetupSchemaTypeParent(String serverName, String userId, String parentElementGUID, String parentElementTypeName, String schemaTypeGUID, boolean assetManagerIsHome, AssetManagerIdentifiersRequestBody requestBody)Connect a schema type to a data asset, process or port.VoidResponseupdateForeignKeyRelationship(String serverName, String userId, String primaryKeyGUID, String foreignKeyGUID, ForeignKeyRequestBody requestBody)Update the relationship properties for the query target.VoidResponseupdateSchemaAttribute(String serverName, String userId, String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeRequestBody requestBody)Update the properties of the metadata element representing a schema attribute.VoidResponseupdateSchemaType(String serverName, String userId, String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeRequestBody requestBody)Update the metadata element representing a schema type.
-
-
-
Method Detail
-
createSchemaType
@PostMapping(path="/schema-types") public GUIDResponse createSchemaType(@PathVariable String serverName, @PathVariable String userId, @RequestParam boolean assetManagerIsHome, @RequestBody SchemaTypeRequestBody requestBody)
Create a new metadata element to represent a schema type.- Parameters:
serverName- name of the server to route the request touserId- calling userassetManagerIsHome- ensure that only the asset manager can update this schema elementrequestBody- properties about the schema type to store- Returns:
- unique identifier of the new schema type InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createSchemaTypeFromTemplate
@PostMapping(path="/schema-types/from-template/{templateGUID}") public GUIDResponse createSchemaTypeFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestParam boolean assetManagerIsHome, @RequestBody TemplateRequestBody requestBody)Create a new metadata element to represent a schema type using an existing metadata element as a template.- Parameters:
serverName- name of the server to route the request touserId- calling usertemplateGUID- unique identifier of the metadata element to copyassetManagerIsHome- ensure that only the asset manager can update this schema elementrequestBody- properties that override the template- Returns:
- unique identifier of the new schema type InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateSchemaType
@PostMapping(path="/schema-types/{schemaTypeGUID}") public VoidResponse updateSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestParam boolean isMergeUpdate, @RequestBody SchemaTypeRequestBody requestBody)Update the metadata element representing a schema type.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the metadata element to updateisMergeUpdate- should the new properties be merged with existing properties (true) or completely replace them (false)?requestBody- new properties for the metadata element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupSchemaTypeParent
@PostMapping(path="/parents/{parentElementGUID}/{parentElementTypeName}/schema-types/{schemaTypeGUID}") public VoidResponse setupSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @PathVariable String schemaTypeGUID, @RequestParam boolean assetManagerIsHome, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Connect a schema type to a data asset, process or port.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the schema type to connectparentElementGUID- unique identifier of the open metadata element that this schema type is to be connected toparentElementTypeName- unique type name of the open metadata element that this schema type is to be connected toassetManagerIsHome- ensure that only the asset manager can update this relationshiprequestBody- unique identifier/name of software server capability representing the caller- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearSchemaTypeParent
@PostMapping(path="/parents/{parentElementGUID}/{parentElementTypeName}/schema-types/{schemaTypeGUID}/remove") public VoidResponse clearSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @PathVariable String schemaTypeGUID, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Remove the relationship between a schema type and its parent data asset, process or port.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the schema type to connectparentElementGUID- unique identifier of the open metadata element that this schema type is to be connected toparentElementTypeName- unique type name of the open metadata element that this schema type is to be connected torequestBody- unique identifier/name of software server capability representing the caller- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeSchemaType
@PostMapping(path="/schema-types/{schemaTypeGUID}/remove") public VoidResponse removeSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody MetadataCorrelationProperties requestBody)Remove the metadata element representing a schema type.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the metadata element to removerequestBody- unique identifier/name of software server capability representing the caller and external identifier of element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findSchemaType
@PostMapping(path="/schema-types/by-search-string") public SchemaTypeElementsResponse findSchemaType(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName- name of the server to route the request touserId- calling userstartFrom- paging start pointpageSize- maximum results that can be returnedrequestBody- string to find in the properties plus external identifiers- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaTypeForElement
@PostMapping(path="/parents/{parentElementGUID}/schema-types/retrieve") public SchemaTypeElementResponse getSchemaTypeForElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Return the schema type associated with a specific open metadata element (data asset, process or port).- Parameters:
serverName- name of the server to route the request touserId- calling userparentElementGUID- unique identifier of the open metadata element that this schema type is to be connected toparentElementTypeName- unique type name of the open metadata element that this schema type is to be connected torequestBody- unique identifier/name of software server capability representing the caller- Returns:
- metadata element describing the schema type associated with the requested parent element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaTypeByName
@PostMapping(path="/schema-types/by-name") public SchemaTypeElementsResponse getSchemaTypeByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName- name of the server to route the request touserId- calling userstartFrom- paging start pointpageSize- maximum results that can be returnedrequestBody- name to search for plus identifiers- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaTypeByGUID
@PostMapping(path="/schema-types/{schemaTypeGUID}/retrieve") public SchemaTypeElementResponse getSchemaTypeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Retrieve the schema type metadata element with the supplied unique identifier.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the requested metadata elementrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaTypeParent
@PostMapping(path="/parents/schema-types/{schemaTypeGUID}/retrieve") public ElementHeaderResponse getSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Retrieve the header of the metadata element connected to a schema type.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaTypeGUID- unique identifier of the requested metadata elementrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- header for parent element (data asset, process, port) or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createSchemaAttribute
@PostMapping(path="/schema-elements/{schemaElementGUID}/schema-attribute") public GUIDResponse createSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @RequestParam boolean assetManagerIsHome, @RequestBody SchemaAttributeRequestBody requestBody)Create a new metadata element to represent a schema attribute.- Parameters:
serverName- name of the server to route the request touserId- calling userassetManagerIsHome- ensure that only the asset manager can update this schema attributeschemaElementGUID- unique identifier of the schemaType or Schema Attribute where the schema attribute is connected torequestBody- properties for the schema attribute- Returns:
- unique identifier of the new metadata element for the schema attribute or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createSchemaAttributeFromTemplate
@PostMapping(path="/schema-elements/{schemaElementGUID}/schema-attributes/from-template/{templateGUID}") public GUIDResponse createSchemaAttributeFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @PathVariable String templateGUID, @RequestParam boolean assetManagerIsHome, @RequestBody TemplateRequestBody requestBody)Create a new metadata element to represent a schema attribute using an existing metadata element as a template.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaElementGUID- unique identifier of the schemaType or Schema Attribute where the schema attribute is connected totemplateGUID- unique identifier of the metadata element to copyassetManagerIsHome- ensure that only the asset manager can update this schema elementrequestBody- properties that override the template- Returns:
- unique identifier of the new metadata element for the schema attribute or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateSchemaAttribute
@PostMapping(path="/schema-attributes/{schemaAttributeGUID}") public VoidResponse updateSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestParam boolean isMergeUpdate, @RequestBody SchemaAttributeRequestBody requestBody)Update the properties of the metadata element representing a schema attribute.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaAttributeGUID- unique identifier of the schema attribute to updateisMergeUpdate- should the new properties be merged with existing properties (true) or completely replace them (false)?requestBody- new properties for the schema attribute- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setSchemaElementAsCalculatedValue
@PostMapping(path="/schema-elements/{schemaElementGUID}/is-calculated-value") public VoidResponse setSchemaElementAsCalculatedValue(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @RequestParam boolean assetManagerIsHome, @RequestBody MetadataCorrelationProperties requestBody)Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaElementGUID- unique identifier of the metadata element to updateassetManagerIsHome- ensure that only the asset manager can update this classificationrequestBody- unique identifier/name of software server capability representing the caller and external identifier of element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearSchemaElementAsCalculatedValue
@PostMapping(path="/schema-elements/{schemaElementGUID}/is-calculated-value/remove") public VoidResponse clearSchemaElementAsCalculatedValue(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @RequestBody MetadataCorrelationProperties requestBody)Remove the calculated value designation from the schema element.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaElementGUID- unique identifier of the metadata element to updaterequestBody- unique identifier/name of software server capability representing the caller and external identifier of element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupColumnAsPrimaryKey
@PostMapping(path="/schema-attributes/{schemaAttributeGUID}/is-primary-key") public VoidResponse setupColumnAsPrimaryKey(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestParam boolean assetManagerIsHome, @RequestBody PrimaryKeyClassificationRequestBody requestBody)Classify the column schema attribute to indicate that it describes a primary key.- Parameters:
serverName- name of the server to route the request touserId- calling userassetManagerIsHome- ensure that only the asset manager can update this classificationschemaAttributeGUID- unique identifier of the metadata element to updaterequestBody- details of the primary key plus external identifiers- Returns:
- null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearColumnAsPrimaryKey
@PostMapping(path="/schema-attributes/{schemaAttributeGUID}/is-primary-key/remove") public VoidResponse clearColumnAsPrimaryKey(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestBody MetadataCorrelationProperties requestBody)Remove the primary key designation from the schema attribute.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaAttributeGUID- unique identifier of the metadata element to updaterequestBody- unique identifier/name of software server capability representing the caller and external identifier of element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupForeignKeyRelationship
@PostMapping(path="/schema-attributes/{primaryKeyGUID}/relationships/foreign-keys") public VoidResponse setupForeignKeyRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String primaryKeyGUID, @PathVariable String foreignKeyGUID, @RequestParam boolean assetManagerIsHome, @RequestBody ForeignKeyRequestBody requestBody)Link two schema attributes together to show a foreign key relationship.- Parameters:
serverName- name of the server to route the request touserId- calling userprimaryKeyGUID- unique identifier of the derived schema elementforeignKeyGUID- unique identifier of the query target schema elementassetManagerIsHome- ensure that only the asset manager can update this relationshiprequestBody- properties for the foreign key relationship- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateForeignKeyRelationship
@PostMapping(path="/schema-attributes/{primaryKeyGUID}/relationships/foreign-keys/update") public VoidResponse updateForeignKeyRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String primaryKeyGUID, @PathVariable String foreignKeyGUID, @RequestBody ForeignKeyRequestBody requestBody)Update the relationship properties for the query target.- Parameters:
serverName- name of the server to route the request touserId- calling userprimaryKeyGUID- unique identifier of the derived schema elementforeignKeyGUID- unique identifier of the query target schema elementrequestBody- properties for the foreign key relationship plus external identifiers- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearForeignKeyRelationship
@PostMapping(path="/schema-attributes/{primaryKeyGUID}/relationships/foreign-keys/remove") public VoidResponse clearForeignKeyRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String primaryKeyGUID, @PathVariable String foreignKeyGUID, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Remove the foreign key relationship between two schema elements.- Parameters:
serverName- name of the server to route the request touserId- calling userprimaryKeyGUID- unique identifier of the derived schema elementforeignKeyGUID- unique identifier of the query target schema elementrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeSchemaAttribute
@PostMapping(path="/schema-attributes/{schemaAttributeGUID}/remove") public VoidResponse removeSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestBody MetadataCorrelationProperties requestBody)Remove the metadata element representing a schema attribute.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaAttributeGUID- unique identifier of the metadata element to removerequestBody- unique identifier/name of software server capability representing the caller and external identifier of element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findSchemaAttributes
@PostMapping(path="/schema-attributes/by-search-string") public SchemaAttributeElementsResponse findSchemaAttributes(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName- name of the server to route the request touserId- calling userstartFrom- paging start pointpageSize- maximum results that can be returnedrequestBody- string to find in the properties plus external identifiers- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNestedAttributes
@PostMapping(path="/schema-elements/{parentSchemaElementGUID}/schema-attributes/retrieve") public SchemaAttributeElementsResponse getNestedAttributes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentSchemaElementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Retrieve the list of schema attributes associated with a schema element.- Parameters:
serverName- name of the server to route the request touserId- calling userparentSchemaElementGUID- unique identifier of the schema element of intereststartFrom- paging start pointpageSize- maximum results that can be returnedrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaAttributesByName
@PostMapping(path="/schema-attributes/by-name") public SchemaAttributeElementsResponse getSchemaAttributesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @PathVariable NameRequestBody requestBody)
Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName- name of the server to route the request touserId- calling userstartFrom- paging start pointpageSize- maximum results that can be returnedrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getSchemaAttributeByGUID
@PostMapping(path="/schema-attributes/{schemaAttributeGUID}/retrieve") public SchemaAttributeElementResponse getSchemaAttributeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestBody AssetManagerIdentifiersRequestBody requestBody)Retrieve the schema attribute metadata element with the supplied unique identifier.- Parameters:
serverName- name of the server to route the request touserId- calling userschemaAttributeGUID- unique identifier of the requested metadata elementrequestBody- unique identifier/name of software server capability representing the caller- Returns:
- matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
-