Class SchemaMakerResource
java.lang.Object
org.odpi.openmetadata.viewservices.schemamaker.server.spring.SchemaMakerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class SchemaMakerResource
extends Object
The SchemaMakerResource provides part of the server-side implementation of the Schema Maker OMVS.
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateSchemaAttribute
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a schema attribute.createSchemaAttributeFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a schema attribute using an existing metadata element as a template.createSchemaType
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a schema type.createSchemaTypeFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a schema type using an existing metadata element as a template.deleteSchemaAttribute
(String serverName, String urlMarker, String schemaAttributeGUID, DeleteRequestBody requestBody) Delete a schema attribute.deleteSchemaType
(String serverName, String urlMarker, String schemaTypeGUID, DeleteRequestBody requestBody) Delete a schema type.findSchemaAttributes
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.findSchemaTypes
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.getSchemaAttributeByGUID
(String serverName, String urlMarker, String schemaAttributeGUID, GetRequestBody requestBody) Return the properties of a specific schema attribute.getSchemaAttributesByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Returns the list of schema attributes with a particular name.getSchemaTypeByGUID
(String serverName, String urlMarker, String schemaTypeGUID, GetRequestBody requestBody) Return the properties of a specific schema type.getSchemaTypesByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Returns the list of schema types with a particular name.updateSchemaAttribute
(String serverName, String urlMarker, String schemaAttributeGUID, UpdateElementRequestBody requestBody) Update the properties of a schema attribute.updateSchemaType
(String serverName, String urlMarker, String schemaTypeGUID, UpdateElementRequestBody requestBody) Update the properties of a schema type.
-
Constructor Details
-
SchemaMakerResource
public SchemaMakerResource()Default constructor
-
-
Method Details
-
createSchemaType
@PostMapping(path="/schema-types") public GUIDResponse createSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a schema type.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- properties for the schema type.- Returns:
- unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createSchemaTypeFromTemplate
@PostMapping(path="/schema-types/from-template") public GUIDResponse createSchemaTypeFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody) Create a new metadata element to represent a schema type using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.- Parameters:
serverName
- calling userurlMarker
- view service URL markerrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element 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}/update") public VoidResponse updateSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a schema type.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerschemaTypeGUID
- unique identifier of the schema type (returned from create)requestBody
- properties for the new element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteSchemaType
@PostMapping(path="/schema-types/{schemaTypeGUID}/delete") public VoidResponse deleteSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Delete a schema type.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerschemaTypeGUID
- unique identifier of the element to deleterequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getSchemaTypesByName
@PostMapping(path="/schema-types/by-name") public OpenMetadataRootElementsResponse getSchemaTypesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of schema types with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- string to find in the properties- 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)
-
findSchemaTypes
@PostMapping(path="/schema-types/by-search-string") public OpenMetadataRootElementsResponse findSchemaTypes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- string to find in the properties- 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 OpenMetadataRootElementResponse getSchemaTypeByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the properties of a specific schema type.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerschemaTypeGUID
- unique identifier of the required elementrequestBody
- string to find in the properties- 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)
-
createSchemaAttribute
@PostMapping(path={"/schema-attributes","/solution-roles"}) public GUIDResponse createSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a schema attribute.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- properties for the schema attribute.- Returns:
- unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createSchemaAttributeFromTemplate
@PostMapping(path={"/schema-attributes/from-template","/solution-roles/from-template"}) public GUIDResponse createSchemaAttributeFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody) Create a new metadata element to represent a schema attribute using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.- Parameters:
serverName
- calling userurlMarker
- view service URL markerrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element 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}/update","/solution-roles/{schemaAttributeGUID}/update"}) public VoidResponse updateSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a schema attribute.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerschemaAttributeGUID
- unique identifier of the schema attribute (returned from create)requestBody
- properties for the new element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteSchemaAttribute
@PostMapping(path={"/schema-attributes/{schemaAttributeGUID}/delete","/solution-roles/{schemaAttributeGUID}/delete"}) public VoidResponse deleteSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Delete a schema attribute.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerschemaAttributeGUID
- unique identifier of the element to deleterequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getSchemaAttributesByName
@PostMapping(path={"/schema-attributes/by-name","/solution-roles/by-name"}) public OpenMetadataRootElementsResponse getSchemaAttributesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of schema attributes with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- string to find in the properties- 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)
-
findSchemaAttributes
@PostMapping(path={"/schema-attributes/by-search-string","/solution-roles/by-search-string"}) public OpenMetadataRootElementsResponse findSchemaAttributes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- string to find in the properties- 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","/solution-roles/{schemaAttributeGUID}/retrieve"}) public OpenMetadataRootElementResponse getSchemaAttributeByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the properties of a specific schema attribute.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerschemaAttributeGUID
- unique identifier of the required elementrequestBody
- string to find in the properties- 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)
-