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

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 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 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

      @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 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

      @PostMapping(path="/schema-types/{schemaTypeGUID}/update") public BooleanResponse 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 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

      @PostMapping(path="/schema-types/{schemaTypeGUID}/delete") public VoidResponse deleteSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @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 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)

    • 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 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

      @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 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)

    • createSchemaAttribute

      @PostMapping(path="/schema-attributes") 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 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

      @PostMapping(path="/schema-attributes/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 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/update") public BooleanResponse 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 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/delete") public VoidResponse deleteSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-attributes/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 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)

    • findSchemaAttributes

      @PostMapping(path="/schema-attributes/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 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

      @PostMapping(path="/schema-attributes/{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 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)

    • linkNestedSchemaAttribute

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/nested-schema-attributes/{nestedSchemaAttributeGUID}/attach") public VoidResponse linkNestedSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @PathVariable String nestedSchemaAttributeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/nested-schema-attributes/{nestedSchemaAttributeGUID}/detach") public VoidResponse detachNestedSchemaAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @PathVariable String nestedSchemaAttributeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-types/{schemaTypeGUID}/attribute-for-schema/{nestedSchemaAttributeGUID}/attach") public VoidResponse linkAttributeForSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @PathVariable String nestedSchemaAttributeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-types/{schemaTypeGUID}/attribute-for-schema/{nestedSchemaAttributeGUID}/detach") public VoidResponse detachAttributeForSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaTypeGUID, @PathVariable String nestedSchemaAttributeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-attributes/{primaryKeyColumnGUID}/foreign-keys/{foreignKeyColumnGUID}/attach") public VoidResponse linkForeignKey(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String primaryKeyColumnGUID, @PathVariable String foreignKeyColumnGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-attributes/{primaryKeyColumnGUID}/foreign-keys/{foreignKeyColumnGUID}/detach") public VoidResponse detachForeignKey(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String primaryKeyColumnGUID, @PathVariable String foreignKeyColumnGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/linked-external-schema-types/{schemaTypeGUID}/attach") public VoidResponse linkExternalSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/linked-external-schema-types/{schemaTypeGUID}/detach") public VoidResponse detachExternalSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/map-from-element-types/{schemaTypeGUID}/attach") public VoidResponse linkMapFromSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/map-from-element-types/{schemaTypeGUID}/detach") public VoidResponse detachMapFromSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/map-to-element-types/{schemaTypeGUID}/attach") public VoidResponse linkMapToSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/map-to-element-types/{schemaTypeGUID}/detach") public VoidResponse detachMapToSchemaType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/graph-edges/{graphEdgeGUID}/graph-vertices/{graphVertexGUID}/attach") public VoidResponse linkGraphEdge(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String graphEdgeGUID, @PathVariable String graphVertexGUID, @RequestBody(required=false) 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

      @PostMapping(path="/graph-edges/{graphEdgeGUID}/graph-vertices/{graphVertexGUID}/detach") public VoidResponse detachGraphEdge(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String graphEdgeGUID, @PathVariable String graphVertexGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/query-targets/{queryTargetSchemaElementGUID}/attach") public VoidResponse linkQueryTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String queryTargetSchemaElementGUID, @RequestBody(required=false) 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/query-targets/{queryTargetSchemaElementGUID}/detach") public VoidResponse detachQueryTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String queryTargetSchemaElementGUID, @RequestBody(required=false) 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

      @PostMapping(path="/elements/{elementGUID}/schema-types/{schemaTypeGUID}/attach") public VoidResponse linkSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/elements/{elementGUID}/schema-types/{schemaTypeGUID}/detach") public VoidResponse detachSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/relational-db-schema-type-lists/{databaseSchemaTypeListGUID}/relational-db-schemas/{relationalDBSchemaTypeGUID}/attach") public VoidResponse linkRelationalDBSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String databaseSchemaTypeListGUID, @PathVariable String relationalDBSchemaTypeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/relational-db-schema-type-lists/{databaseSchemaTypeListGUID}/relational-db-schemas/{relationalDBSchemaTypeGUID}/detach") public VoidResponse detachRelationalDBSchema(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String databaseSchemaTypeListGUID, @PathVariable String relationalDBSchemaTypeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/relational-columns/{relationalColumnGUID}/primary-key") public VoidResponse addPrimaryKeyClassification(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationalColumnGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/relational-columns/{relationalColumnGUID}/primary-key/remove") public VoidResponse removePrimaryKeyClassification(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationalColumnGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/type-embedded-attribute") public VoidResponse addTypeEmbeddedAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/type-embedded-attribute/remove") public VoidResponse removeTypeEmbeddedAttribute(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/calculated-value") public VoidResponse addCalculatedValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/calculated-value/remove") public VoidResponse removeCalculatedValue(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaAttributeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/api-schema-types/{apiSchemaTypeGUID}/api-operations/{apiOperationGUID}/attach") public VoidResponse linkAPIOperations(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiSchemaTypeGUID, @PathVariable String apiOperationGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/api-schema-types/{apiSchemaTypeGUID}/api-operations/{apiOperationGUID}/detach") public VoidResponse detachAPIOperations(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiSchemaTypeGUID, @PathVariable String apiOperationGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-headers/{schemaTypeGUID}/attach") public VoidResponse linkAPIHeader(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-headers/{schemaTypeGUID}/detach") public VoidResponse detachAPIHeader(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-requests/{schemaTypeGUID}/attach") public VoidResponse linkAPIRequest(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-requests/{schemaTypeGUID}/detach") public VoidResponse detachAPIRequest(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-responses/{schemaTypeGUID}/attach") public VoidResponse linkAPIResponse(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/api-operations/{apiOperationGUID}/api-responses/{schemaTypeGUID}/detach") public VoidResponse detachAPIResponse(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String apiOperationGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/schema-type-options/{schemaTypeGUID}/attach") public VoidResponse linkSchemaTypeOption(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 request
      Returns:
      response object 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

      @PostMapping(path="/schema-elements/{schemaElementGUID}/schema-type-options/{schemaTypeGUID}/detach") public VoidResponse detachSchemaTypeOption(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String schemaElementGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) 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 - properties for the request
      Returns:
      response object 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)