Class SchemaMakerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.schemamaker.server.SchemaMakerRESTServices
The SchemaMakerRESTServices provides the server-side implementation of the Schema Maker Open Metadata
View Service (OMVS). This interface provides access to a person's profile, roles and network.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateSchemaAttribute
(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody) Create a schemaAttribute.createSchemaAttributeFromTemplate
(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a schemaAttribute using an existing metadata element as a template.createSchemaType
(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody) Create a schema type.createSchemaTypeFromTemplate
(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a schema type using an existing metadata element as a template.deleteSchemaAttribute
(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, DeleteRequestBody requestBody) Delete a schemaAttribute.deleteSchemaType
(String serverName, String viewServiceURLMarker, String schemaTypeGUID, DeleteRequestBody requestBody) Delete a schema type.findSchemaAttributes
(String serverName, String viewServiceURLMarker, SearchStringRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.findSchemaTypes
(String serverName, String viewServiceURLMarker, SearchStringRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.getSchemaAttributeByGUID
(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, GetRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.getSchemaAttributesByName
(String serverName, String viewServiceURLMarker, FilterRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.getSchemaTypeByGUID
(String serverName, String viewServiceURLMarker, String schemaTypeGUID, GetRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.getSchemaTypesByName
(String serverName, String viewServiceURLMarker, FilterRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.updateSchemaAttribute
(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, UpdateElementRequestBody requestBody) Update the properties of a schemaAttribute.updateSchemaType
(String serverName, String viewServiceURLMarker, String schemaTypeGUID, UpdateElementRequestBody requestBody) Update the properties of a schema type.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
SchemaMakerRESTServices
public SchemaMakerRESTServices()Default constructor
-
-
Method Details
-
createSchemaType
public GUIDResponse createSchemaType(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody) Create a schema type.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- 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
public GUIDResponse createSchemaTypeFromTemplate(String serverName, String viewServiceURLMarker, 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 userviewServiceURLMarker
- 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
public VoidResponse updateSchemaType(String serverName, String viewServiceURLMarker, String schemaTypeGUID, UpdateElementRequestBody requestBody) Update the properties of a schema type.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- 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
public VoidResponse deleteSchemaType(String serverName, String viewServiceURLMarker, String schemaTypeGUID, DeleteRequestBody requestBody) Delete a schema type.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- 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
public OpenMetadataRootElementsResponse getSchemaTypesByName(String serverName, String viewServiceURLMarker, FilterRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- 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
public OpenMetadataRootElementResponse getSchemaTypeByGUID(String serverName, String viewServiceURLMarker, String schemaTypeGUID, GetRequestBody requestBody) Retrieve the list of schema type metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- 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)
-
findSchemaTypes
public OpenMetadataRootElementsResponse findSchemaTypes(String serverName, String viewServiceURLMarker, 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 toviewServiceURLMarker
- 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)
-
createSchemaAttribute
public GUIDResponse createSchemaAttribute(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody) Create a schemaAttribute.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- 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
public GUIDResponse createSchemaAttributeFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a schemaAttribute 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 userviewServiceURLMarker
- 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
public VoidResponse updateSchemaAttribute(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, UpdateElementRequestBody requestBody) Update the properties of a schemaAttribute.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- 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
public VoidResponse deleteSchemaAttribute(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, DeleteRequestBody requestBody) Delete a schemaAttribute.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- 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
public OpenMetadataRootElementsResponse getSchemaAttributesByName(String serverName, String viewServiceURLMarker, FilterRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- 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
public OpenMetadataRootElementResponse getSchemaAttributeByGUID(String serverName, String viewServiceURLMarker, String schemaAttributeGUID, GetRequestBody requestBody) Retrieve the list of schema attribute metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- 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)
-
findSchemaAttributes
public OpenMetadataRootElementsResponse findSchemaAttributes(String serverName, String viewServiceURLMarker, 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 toviewServiceURLMarker
- 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)
-