Package org.odpi.openmetadata.viewservices.schemamaker.server

Class SchemaMakerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.schemamaker.server.SchemaMakerRESTServices
public class SchemaMakerRESTServices extends TokenController
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 Details

    • SchemaMakerRESTServices

      public SchemaMakerRESTServices()
      Default constructor

  • Method Details

    • createSchemaType

      public GUIDResponse createSchemaType(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a schema type.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the schema type.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException 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 urlMarker, 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 user
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • updateSchemaType

      public BooleanResponse updateSchemaType(String serverName, String urlMarker, String schemaTypeGUID, UpdateElementRequestBody requestBody)
      Update the properties of a schema type.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      schemaTypeGUID - unique identifier of the schema type (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException 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 urlMarker, String schemaTypeGUID, DeleteElementRequestBody requestBody)
      Delete a schema type.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      schemaTypeGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 urlMarker, 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 to
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • getSchemaTypeByGUID

      public OpenMetadataRootElementResponse getSchemaTypeByGUID(String serverName, String urlMarker, 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 to
      urlMarker - view service URL marker
      schemaTypeGUID - unique identifier of the required element
      requestBody - 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 a problem reported in the open metadata server(s)

    • findSchemaTypes

      public OpenMetadataRootElementsResponse findSchemaTypes(String serverName, String urlMarker, 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 to
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • createSchemaAttribute

      public GUIDResponse createSchemaAttribute(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a schemaAttribute.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the schema attribute.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException 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 urlMarker, 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 user
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • updateSchemaAttribute

      public BooleanResponse updateSchemaAttribute(String serverName, String urlMarker, String schemaAttributeGUID, UpdateElementRequestBody requestBody)
      Update the properties of a schema attribute.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      schemaAttributeGUID - 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 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 urlMarker, String schemaAttributeGUID, DeleteElementRequestBody requestBody)
      Delete a schema attribute.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 urlMarker, 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 to
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • getSchemaAttributeByGUID

      public OpenMetadataRootElementResponse getSchemaAttributeByGUID(String serverName, String urlMarker, 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 to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the required element
      requestBody - 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 a problem reported in the open metadata server(s)

    • findSchemaAttributes

      public OpenMetadataRootElementsResponse findSchemaAttributes(String serverName, String urlMarker, 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 to
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • linkNestedSchemaAttribute

      public VoidResponse linkNestedSchemaAttribute(String serverName, String urlMarker, String schemaAttributeGUID, String nestedSchemaAttributeGUID, NewRelationshipRequestBody requestBody)
      Attach a nested schema attribute to its parent schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the parent schema attribute
      nestedSchemaAttributeGUID - unique identifier of the nested schema attribute
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachNestedSchemaAttribute

      public VoidResponse detachNestedSchemaAttribute(String serverName, String urlMarker, String schemaAttributeGUID, String nestedSchemaAttributeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a nested schema attribute from its parent schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the parent schema attribute
      nestedSchemaAttributeGUID - unique identifier of the nested schema attribute
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAttributeForSchema

      public VoidResponse linkAttributeForSchema(String serverName, String urlMarker, String schemaTypeGUID, String nestedSchemaAttributeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema attribute to the schema type that it belongs to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaTypeGUID - unique identifier of the schema type
      nestedSchemaAttributeGUID - unique identifier of the schema attribute
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAttributeForSchema

      public VoidResponse detachAttributeForSchema(String serverName, String urlMarker, String schemaTypeGUID, String nestedSchemaAttributeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema attribute from the schema type that it belongs to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaTypeGUID - unique identifier of the schema type
      nestedSchemaAttributeGUID - unique identifier of the schema attribute
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkForeignKey

      public VoidResponse linkForeignKey(String serverName, String urlMarker, String primaryKeyColumnGUID, String foreignKeyColumnGUID, NewRelationshipRequestBody requestBody)
      Attach a foreign key column to the primary key column that it refers to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      primaryKeyColumnGUID - unique identifier of the primary key column
      foreignKeyColumnGUID - unique identifier of the foreign key column
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachForeignKey

      public VoidResponse detachForeignKey(String serverName, String urlMarker, String primaryKeyColumnGUID, String foreignKeyColumnGUID, DeleteRelationshipRequestBody requestBody)
      Detach a foreign key column from the primary key column that it refers to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      primaryKeyColumnGUID - unique identifier of the primary key column
      foreignKeyColumnGUID - unique identifier of the foreign key column
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkExternalSchemaType

      public VoidResponse linkExternalSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach an external schema type to the schema element that uses it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the schema element
      schemaTypeGUID - unique identifier of the external schema type
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachExternalSchemaType

      public VoidResponse detachExternalSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach an external schema type from the schema element that uses it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the schema element
      schemaTypeGUID - unique identifier of the external schema type
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkMapFromSchemaType

      public VoidResponse linkMapFromSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach the schema type that describes the domain (from) element of a map.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the map schema element
      schemaTypeGUID - unique identifier of the schema type describing the domain of the map
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachMapFromSchemaType

      public VoidResponse detachMapFromSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach the schema type that describes the domain (from) element of a map.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the map schema element
      schemaTypeGUID - unique identifier of the schema type describing the domain of the map
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkMapToSchemaType

      public VoidResponse linkMapToSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach the schema type that describes the range (to) element of a map.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the map schema element
      schemaTypeGUID - unique identifier of the schema type describing the range of the map
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachMapToSchemaType

      public VoidResponse detachMapToSchemaType(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach the schema type that describes the range (to) element of a map.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the map schema element
      schemaTypeGUID - unique identifier of the schema type describing the range of the map
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkGraphEdge

      public VoidResponse linkGraphEdge(String serverName, String urlMarker, String graphEdgeGUID, String graphVertexGUID, NewRelationshipRequestBody requestBody)
      Attach a graph edge to one of the graph vertices that it connects.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      graphEdgeGUID - unique identifier of the graph edge
      graphVertexGUID - unique identifier of the graph vertex
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachGraphEdge

      public VoidResponse detachGraphEdge(String serverName, String urlMarker, String graphEdgeGUID, String graphVertexGUID, DeleteRelationshipRequestBody requestBody)
      Detach a graph edge from one of the graph vertices that it connects.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      graphEdgeGUID - unique identifier of the graph edge
      graphVertexGUID - unique identifier of the graph vertex
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkQueryTarget

      public VoidResponse linkQueryTarget(String serverName, String urlMarker, String schemaElementGUID, String queryTargetSchemaElementGUID, NewRelationshipRequestBody requestBody)
      Attach a query target to the derived schema element that queries it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the derived schema element
      queryTargetSchemaElementGUID - unique identifier of the schema element supplying the query target
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachQueryTarget

      public VoidResponse detachQueryTarget(String serverName, String urlMarker, String schemaElementGUID, String queryTargetSchemaElementGUID, DeleteRelationshipRequestBody requestBody)
      Detach a query target from the derived schema element that queries it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the derived schema element
      queryTargetSchemaElementGUID - unique identifier of the schema element supplying the query target
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSchema

      public VoidResponse linkSchema(String serverName, String urlMarker, String elementGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema type to the element that it describes.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is described by the schema type
      schemaTypeGUID - unique identifier of the schema type
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSchema

      public VoidResponse detachSchema(String serverName, String urlMarker, String elementGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema type from the element that it describes.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is described by the schema type
      schemaTypeGUID - unique identifier of the schema type
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkRelationalDBSchema

      public VoidResponse linkRelationalDBSchema(String serverName, String urlMarker, String databaseSchemaTypeListGUID, String relationalDBSchemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a relational database schema type to the list that contains it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      databaseSchemaTypeListGUID - unique identifier of the relational database schema type list
      relationalDBSchemaTypeGUID - unique identifier of the relational database schema type
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachRelationalDBSchema

      public VoidResponse detachRelationalDBSchema(String serverName, String urlMarker, String databaseSchemaTypeListGUID, String relationalDBSchemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a relational database schema type from the list that contained it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      databaseSchemaTypeListGUID - unique identifier of the relational database schema type list
      relationalDBSchemaTypeGUID - unique identifier of the relational database schema type
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • addPrimaryKeyClassification

      public VoidResponse addPrimaryKeyClassification(String serverName, String urlMarker, String relationalColumnGUID, NewClassificationRequestBody requestBody)
      Add the PrimaryKey classification to a relational column.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      relationalColumnGUID - unique identifier of the relational column
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • removePrimaryKeyClassification

      public VoidResponse removePrimaryKeyClassification(String serverName, String urlMarker, String relationalColumnGUID, DeleteClassificationRequestBody requestBody)
      Remove the PrimaryKey classification from a relational column.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      relationalColumnGUID - unique identifier of the relational column
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • addTypeEmbeddedAttribute

      public VoidResponse addTypeEmbeddedAttribute(String serverName, String urlMarker, String schemaAttributeGUID, NewClassificationRequestBody requestBody)
      Add the TypeEmbeddedAttribute classification to a schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the schema attribute
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • removeTypeEmbeddedAttribute

      public VoidResponse removeTypeEmbeddedAttribute(String serverName, String urlMarker, String schemaAttributeGUID, DeleteClassificationRequestBody requestBody)
      Remove the TypeEmbeddedAttribute classification from a schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the schema attribute
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • addCalculatedValue

      public VoidResponse addCalculatedValue(String serverName, String urlMarker, String schemaAttributeGUID, NewClassificationRequestBody requestBody)
      Add the CalculatedValue classification to a schema element to show that its value is derived by a formula.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the schema attribute
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • removeCalculatedValue

      public VoidResponse removeCalculatedValue(String serverName, String urlMarker, String schemaAttributeGUID, DeleteClassificationRequestBody requestBody)
      Remove the CalculatedValue classification from a schema element.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaAttributeGUID - unique identifier of the schema attribute
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAPIOperations

      public VoidResponse linkAPIOperations(String serverName, String urlMarker, String apiSchemaTypeGUID, String apiOperationGUID, NewRelationshipRequestBody requestBody)
      Attach an API operation to the API schema type that contains it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiSchemaTypeGUID - unique identifier of the API schema type
      apiOperationGUID - unique identifier of the API operation
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAPIOperations

      public VoidResponse detachAPIOperations(String serverName, String urlMarker, String apiSchemaTypeGUID, String apiOperationGUID, DeleteRelationshipRequestBody requestBody)
      Detach an API operation from the API schema type that contained it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiSchemaTypeGUID - unique identifier of the API schema type
      apiOperationGUID - unique identifier of the API operation
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAPIHeader

      public VoidResponse linkAPIHeader(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema type to the API operation that uses it as its header.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the header
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAPIHeader

      public VoidResponse detachAPIHeader(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema type from the API operation that used it as its header.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the header
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAPIRequest

      public VoidResponse linkAPIRequest(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema type to the API operation that uses it as its request.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the request
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAPIRequest

      public VoidResponse detachAPIRequest(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema type from the API operation that used it as its request.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the request
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAPIResponse

      public VoidResponse linkAPIResponse(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema type to the API operation that uses it as its response.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the response
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAPIResponse

      public VoidResponse detachAPIResponse(String serverName, String urlMarker, String apiOperationGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema type from the API operation that used it as its response.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      apiOperationGUID - unique identifier of the API operation
      schemaTypeGUID - unique identifier of the schema type describing the response
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSchemaTypeOption

      public VoidResponse linkSchemaTypeOption(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, NewRelationshipRequestBody requestBody)
      Attach a schema type to a schema element that may optionally use it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the schema element
      schemaTypeGUID - unique identifier of the schema type that is one of its options
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSchemaTypeOption

      public VoidResponse detachSchemaTypeOption(String serverName, String urlMarker, String schemaElementGUID, String schemaTypeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a schema type from a schema element that may optionally have used it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      schemaElementGUID - unique identifier of the schema element
      schemaTypeGUID - unique identifier of the schema type that is one of its options
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)